thepaperlessproject/paperless

Paperless 镜像文档

重要通知

自2015年项目启动以来，Paperless已发展成为广受欢迎的文档管理工具。但由于维护压力，作者决定将本项目归档为只读，并推荐用户关注由Jonas Winkler开发的活跃分支https://github.com/jonaswinkler/paperless-ng。原项目基于GPL协议，用户可自由fork并继续使用，尊重协议条款即可。

镜像概述和主要用途

Paperless旨在解决纸质文档管理的痛点：无搜索功能、占用物理空间、备份繁琐。它通过OCR技术将扫描的文档转换为可搜索的数字化文件，实现高效索引和归档，帮助用户轻松管理各类纸质文档（如账单、发票、证件等）。

工作原理

Paperless不控制扫描仪，仅处理扫描生成的文件，流程如下：

1. 配置扫描仪：选择支持网络输出的扫描仪，设置为"扫描至FTP"等方式，自动将扫描图像推送至指定服务器目录（或手动上传）。
2. 文档处理：服务器运行Paperless消费脚本，对文件进行OCR识别、去噪、校正等处理。
3. 索引存储：处理后的文档及OCR文本被索引至本地数据库。
4. Web管理：通过Web界面浏览、搜索数据库中的文档。
5. 文档获取：通过Web界面下载所需PDF文件，可打印或作为原始文档使用。

核心功能和特性

• OCR识别：基于Tesseract实现文本提取，支持搜索文档内容。
• 文档优化：集成Unpaper进行去噪、校正，ImageMagick处理图像转换。
• 加密存储：通过GnuPG加密原始文件，保障数据安全。
• Web界面：提供直观的Web管理界面，支持文档浏览、搜索和下载。
• 自动化处理：支持自动消费指定目录中的扫描文件，减少手动操作。

依赖要求

Paperless依赖以下工具和库：

• 基础工具：
  • ImageMagick：图像格式转换
  • Tesseract：OCR文本识别
  • Unpaper：图像去噪与校正
  • GNU Privacy Guard (GnuPG)：加密后端
• Python环境：
  • Python 3
  • Pillow：图像处理
  • PyOCR：Tesseract的Python封装
  • Django：Web框架
  • Python-GNUPG：GnuPG的Python接口

项目状态

• 项目始于2015年，拥有大量用户，尤其在德国地区 popularity较高。
• 作者不再进行新功能开发，但接受社区的Pull Request和问题反馈。
• 如需新功能，建议通过Issue讨论或提交PR，或使用活跃分支Paperless-ng。

关联项目

社区基于Paperless开发了多个衍生工具：

• https://github.com/bauerj/paperless_app：Android/iOS移动应用
• https://github.com/thomasbrueggemann/paperless-desktop：跨平台桌面UI（支持Mac、Linux、Windows）
• https://github.com/ovv/ansible-role-paperless：Ansible角色，简化部署
• https://github.com/stgarf/paperless-cli：Golang命令行工具，用于与Paperless实例交互

类似项目

• Mayan EDMS：功能更丰富的文档管理系统，同样基于Django，使用Tesseract和Unpaper，但基于Python 2。Paperless资源消耗可能较低，名称更简洁。

重要注意事项

• 敏感数据处理：扫描文档通常包含敏感信息（如社保号、税务记录），Paperless虽加密原始文件，但OCR文本为明文存储（需支持搜索）。
• 部署建议：切勿在不可信主机上运行，推荐在本地家庭服务器部署，确保数据安全。

文档与资源

完整文档请访问https://paperless.readthedocs.io/。