jonaswinkler/paperless-ng

Paperless-ng 镜像文档

镜像概述和主要用途

Paperless-ng 是 Paperless 项目的分支，旨在提供更强大的文档管理功能。它能够索引扫描文档，支持搜索和元数据存储，并通过新的前端界面和底层改进提升用户体验。适用于需要高效管理、搜索和组织扫描文档的个人或小型组织。

核心功能和特性

• 新前端界面：基于 Angular 框架开发，未来将支持移动设备友好体验
• 全文搜索：增强的搜索功能，提升文档查找效率
• 邮件处理：新增邮件处理能力，支持通过邮件接收文档
• 机器学习文档匹配：利用机器学习技术实现文档智能匹配
• 并行任务处理：多任务并行处理文档，提供错误提示功能
• 代码优化：大量代码清理和优化，简化复杂逻辑
• 稳定性提升：增加测试覆盖率，提高系统稳定性

工作原理

1. 配置扫描仪将扫描文档发送到网络位置（如通过 FTP 自动上传）
2. Paperless-ng 监控指定目录，对文档进行 OCR 处理并索引到本地数据库
3. 通过 Web 前端界面浏览、搜索和管理文档
4. 通过 Web 界面下载所需 PDF 文档，可直接使用或打印

使用场景和适用范围

• 家庭用户管理个人文档（如账单、发票、证件等）
• 小型办公室处理业务文档，实现数字化存档
• 需要高效检索历史文档的场景，减少物理文件存储需求

部署和使用方法

推荐部署方式：Docker Compose

1. 获取最新发布的 Docker 配置文件（无需克隆仓库）：

   • Dockerfiles 存档：仅包含 Docker 配置文件，从 Docker Hub 拉取镜像
   • 源代码存档：包含构建 Docker 镜像所需的全部文件（适用于树莓派等设备）

2. 参考官方文档进行安装配置：Paperless-ng 安装文档

手动部署（不推荐）

需自行安装依赖、配置 Apache 和数据库服务器，详细组件信息参考官方文档。

迁移指南

从原始 Paperless 迁移到 Paperless-ng 的方法请参考：迁移文档。支持通过回滚数据库迁移恢复到原始 Paperless。

路线图

1.0 版本目标

• 测试覆盖率达到 90%
• 存储带 OCR 文本层的归档文档，同时保留原始文件（feature-ocrmypdf 分支开发中）
• 修复已发现的 bugs

1.0 之后版本规划

• 增强搜索功能：按发件人分组搜索结果、相似文档搜索、拼写纠错等
• 交互式处理界面：通过 WebSocket 实时显示文档处理进度，支持新文档通知
• 自定义标签颜色：通过颜色选择器设置任意标签颜色

计划移除功能

• GnuPG 加密：现有实现无法提供有效安全保障，易给用户造成虚假安全感

关联项目

以下项目基于 Paperless 构建，与 Paperless-ng 的兼容性未知：

• https://github.com/bauerj/paperless_app%EF%BC%9AAndroid/iOS 移动应用
• https://github.com/thomasbrueggemann/paperless-desktop%EF%BC%9A%E8%B7%A8%E5%B9%B3%E5%8F%B0%E6%A1%8C%E9%9D%A2%E5%AE%A2%E6%88%B7%E7%AB%AF%EF%BC%88%E6%94%AF%E6%8C%81 Mac、Linux、Windows）
• https://github.com/ovv/ansible-role-paperless%EF%BC%9AAnsible 角色部署方案
• https://github.com/stgarf/paperless-cli%EF%BC%9AGolang 命令行工具

重要注意事项

扫描文档通常包含敏感信息（如社保号、税务记录、发票等）。Paperless-ng 默认以明文存储文档（需支持搜索），因此不应在不可信主机上运行。建议在本地可信服务器（如家庭服务器）部署使用。

文档和支持

• 完整文档：ReadTheDocs
• 问题反馈：通过 GitHub Issues 提交
• 贡献指南：参考 GitHub 项目 issue 列表，大型功能建议先通过 Issues 讨论