paperless-ngx / paperless-ngx

Paperless-ngx is a document management system that transforms your physical documents into a searchable online archive so you can keep, well, less paper. Paperless-ngx is the official successor to the original Paperless & Paperless-ng projects and is designed to distribute the responsibility of advancing and supporting the project among a team of people. Consider joining us! Paperless-ngx 是一个文档管理系统，它能将你的纸质文档转换为可搜索的在线存档，从而让你真正实现“无纸化”。Paperless-ngx 是原 Paperless 和 Paperless-ng 项目的官方继任者，旨在通过团队协作来共同推进和维护该项目。欢迎加入我们！

Thanks to the generous folks at DigitalOcean, a demo is available at demo.paperless-ngx.com using login demo / demo. Note: demo content is reset frequently and confidential information should not be uploaded. 感谢 DigitalOcean 的慷慨支持，你可以通过 demo.paperless-ngx.com 访问演示环境，登录账号为 demo / demo。注意：演示内容会频繁重置，请勿上传任何机密信息。

Features

功能特性

A full list of features and screenshots are available in the documentation. 功能的完整列表和截图可在文档中查看。

Getting started

入门指南

The easiest way to deploy paperless is docker compose. The files in the /docker/compose directory are configured to pull the image from the GitHub container registry. If you’d like to jump right in, you can configure a docker compose environment with our install script: 部署 Paperless 最简单的方法是使用 docker compose。/docker/compose 目录下的文件已配置为从 GitHub 容器注册表拉取镜像。如果你想快速上手，可以使用我们的安装脚本来配置 docker compose 环境：

bash -c "$(curl -L https://raw.githubusercontent.com/paperless-ngx/paperless-ngx/main/install-paperless-ngx.sh)"

More details and step-by-step guides for alternative installation methods can be found in the documentation. Migrating from Paperless-ng is easy, just drop in the new docker image! See the documentation on migrating for more details. 更多详细信息及其他安装方法的逐步指南，请参阅文档。从 Paperless-ng 迁移非常简单，只需替换为新的 docker 镜像即可！有关详细信息，请参阅迁移文档。

Documentation

文档

The documentation for Paperless-ngx is available at https://docs.paperless-ngx.com. Paperless-ngx 的文档地址为 https://docs.paperless-ngx.com。

Contributing

参与贡献

If you feel like contributing to the project, please do! Bug fixes, enhancements, visual fixes etc. are always welcome. If you want to implement something big: Please start a discussion about that! The documentation has some basic information on how to get started. 如果你有兴趣为本项目做出贡献，欢迎加入！我们随时欢迎错误修复、功能增强、视觉优化等贡献。如果你想实现重大的功能变更，请先发起讨论！文档中包含了一些入门的基本信息。

Community Support

社区支持

People interested in continuing the work on paperless-ngx are encouraged to reach out here on github and in the Matrix Room. If you would like to contribute to the project on an ongoing basis there are multiple teams (frontend, ci/cd, etc) that could use your help so please reach out! 欢迎有兴趣参与 Paperless-ngx 开发的朋友通过 GitHub 或 Matrix 聊天室与我们联系。如果你希望长期为项目做出贡献，我们有多个团队（如前端、CI/CD 等）需要你的帮助，请随时联系我们！

Translation

翻译

Paperless-ngx is available in many languages that are coordinated on Crowdin. If you want to help out by translating paperless-ngx into your language, please head over to https://crowdin.com/project/paperless-ngx, and thank you! More details can be found in CONTRIBUTING.md. Paperless-ngx 支持多种语言，翻译工作在 Crowdin 上进行协调。如果你想帮助将 Paperless-ngx 翻译成你的母语，请前往 https://crowdin.com/project/paperless-ngx，感谢你的支持！更多详情请参阅 CONTRIBUTING.md。

Feature Requests

功能请求

Feature requests can be submitted via GitHub Discussions, you can search for existing ideas, add your own and vote for the ones you care about. 功能请求可以通过 GitHub Discussions 提交。你可以搜索现有的想法，添加自己的建议，并为你关心的功能投票。

Bugs

错误反馈

For bugs please open an issue or start a discussion if you have questions. 如果遇到 Bug，请提交 Issue；如果有疑问，请发起讨论。

Important Note

重要提示

Document scanners are typically used to scan sensitive documents like your social insurance number, tax records, invoices, etc. Paperless-ngx should never be run on an untrusted host because information is stored in clear text without encryption. No guarantees are made regarding security (but we do try!) and you use the app at your own risk. The safest way to run Paperless-ngx is on a local server in your own home with backups in place. 文档扫描仪通常用于扫描社会保险号、税务记录、发票等敏感文档。由于 Paperless-ngx 以明文存储信息且未加密，因此切勿在不受信任的主机上运行它。我们不对安全性做任何保证（尽管我们一直在努力！），请自行承担使用风险。运行 Paperless-ngx 最安全的方法是在你自己的家庭本地服务器上运行，并做好备份。