Paperless-ngx

Paperless-ngx 是一个文档管理系统，可将您的纸质文档转换为可搜索的在线档案，从而帮助您减少纸张使用。

Paperless-ngx 是原 Paperless 和 Paperless-ng 项目的官方继任者，旨在将推动和维护该项目的责任分散到一个团队中。欢迎加入我们！

感谢 DigitalOcean 的慷慨支持，现提供演示环境：demo.paperless-ngx.com，登录名与密码均为 demo。请注意：演示内容会定期重置，切勿上传机密信息。

• 功能
• 快速入门
• 贡献
  • 社区支持
  • 翻译
  • 功能请求
  • Bug 报告
• 相关项目
• 重要提示

本项目由以下机构支持：

功能

完整的功能列表和截图可在文档中找到。

快速入门

部署 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)"

更多详细信息以及替代安装方法的分步指南，请参阅文档。

从 Paperless-ng 迁移非常容易，只需替换为新的 Docker 镜像即可！有关迁移的更多信息，请参阅迁移至 Paperless-ngx 的文档。

文档

Paperless-ngx 的文档可在 https://docs.paperless-ngx.com 查阅。

贡献

如果您愿意为本项目贡献力量，请随时参与！修复 Bug、功能增强、界面优化等都备受欢迎。如果您计划实现较大规模的功能，请先发起讨论！开发文档 提供了一些入门信息。

社区支持

希望继续参与 Paperless-ngx 工作的人员，欢迎在 GitHub 上以及 Matrix 论坛 中联系我们。如果您希望长期参与本项目，我们有多个团队（前端、CI/CD 等）正在寻找志愿者，请随时与我们联系！

翻译

Paperless-ngx 支持多种语言，翻译工作由 Crowdin 协调管理。如果您希望将 Paperless-ngx 翻译成您的语言，请访问 https://crowdin.com/project/paperless-ngx，非常感谢！更多详情请参阅 CONTRIBUTING.md。

功能请求

功能请求可通过 GitHub Discussions 提交。您可以搜索现有想法、添加自己的建议，并为感兴趣的功能投票。

Bug 报告

如发现 Bug，请提交 Issue；如有疑问，也可发起讨论。

相关项目

请参阅 维基页面，其中列出了用户维护的相关项目及与 Paperless-ngx 兼容的软件。

重要提示

文档扫描仪通常用于扫描敏感文件，例如您的社会保险号码、税务记录、发票等。请勿在不可信的主机上运行 Paperless-ngx，因为信息以明文形式存储，未进行加密。我们不对安全性提供任何保证（尽管我们一直在努力！），使用该应用的风险由您自行承担。 运行 Paperless-ngx 的最安全方式是在您自己家中的本地服务器上，并做好备份。

Paperless-ngx 快速上手指南

Paperless-ngx 是一个文档管理系统，能将您的纸质文件转换为可搜索的在线档案，助您实现无纸化办公。它是原 Paperless 和 Paperless-ng 项目的官方继任者。

环境准备

在开始之前，请确保您的服务器满足以下基本要求：

• 操作系统：支持 Docker 的 Linux 发行版（如 Ubuntu, Debian, CentOS 等）。
• 核心依赖：
  • Docker
  • Docker Compose (建议 v2.0+)
• 硬件建议：至少 2GB 内存（运行 OCR 识别时可能需要更多），充足的磁盘空间用于存储文档。
• 网络：服务器需能访问外网以拉取镜像（若国内拉取缓慢，建议配置 Docker 国内镜像加速器）。

安全提示：Paperless-ngx 默认以明文存储数据且不含加密。切勿在不受信任的主机上运行。最安全的部署方式是在您本地的家庭服务器或受控的内网环境中，并务必做好数据备份。

安装步骤

推荐使用官方提供的自动化安装脚本，它会自动配置 docker compose 环境并从 GitHub Container Registry 拉取最新镜像。

在终端中执行以下命令：

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

安装过程中请注意：

1. 脚本会引导您设置管理员账号、密码以及数据存储路径。
2. 如果您在中国大陆地区且下载镜像超时，请在执行脚本前配置好 Docker 守护进程的 registry-mirrors，或手动修改生成的 docker-compose.yml 文件中的镜像地址为国内源。

安装完成后，服务将自动启动。如需查看详细的手动安装步骤或迁移旧版数据，请参阅官方文档。

基本使用

安装成功后，您可以通过浏览器访问系统。

1. 访问界面： 打开浏览器，输入服务器地址及端口（默认为 http://<您的服务器 IP>:8000）。

2. 登录系统： 使用安装脚本中设置的管理员账号和密码登录。

   • 如果是体验官方演示环境，可使用账号：demo / 密码：demo（注意：演示环境数据会频繁重置，请勿上传敏感信息）。

3. 上传文档：

   • 点击界面上的 "Upload" (上传) 按钮，直接拖拽或选择本地 PDF、图片等文件。
   • 系统将自动进行 OCR 文字识别、索引建立和元数据提取。

4. 搜索与管理：

   • 在顶部搜索框输入文档中的任意文字，即可快速定位文件。
   • 您可以为文档添加标签 (Tags)、对应项 (Correspondents) 和文档类型 (Document types) 以便分类管理。

更多高级功能（如邮件自动抓取、权限管理等）请参考 完整功能列表。