Paperless-ngx 安装及使用教程

Paperless-ngx 安装及使用教程

paperless-ngxA community-supported supercharged version of paperless: scan, index and archive all your physical documents项目地址:https://gitcode.com/gh_mirrors/pa/paperless-ngx

1. 项目目录结构及介绍

在 paperless-ngx 的源代码仓库中，我们可以看到以下主要目录和文件：

• Dockerfile: 这是用于构建 Docker 镜像的脚本，它定义了环境依赖和运行时设置。

• LICENSE: 项目遵循的许可证，这里是 GPL-3.0 许可证。

• Pipfile 和 Pipfile.lock: 这两个文件管理 Python 依赖包及其版本，确保不同环境中的一致性。

• README.md: 项目简介和简要指南。

• SECURITY.md: 项目的安全政策和处理安全漏洞的信息。

• crowdin.yml: 用于多语言翻译管理的配置文件。

• gunicorn.conf.py: Gunicorn Web 服务器的配置文件。

• install-paperless-ngx.sh: 简化的安装脚本，帮助快速部署项目。

• mkdocs.yml: 文档站点的配置文件。

• paperless-ngx.code-workspace: VS Code 工作区配置文件。

• paperless.conf.example: 示例配置文件，提供设置参考。

2. 项目启动文件介绍

gunicorn.conf.py 是项目的启动文件，它配置了 Gunicorn —— 一个 WSGI HTTP 服务器，通常用于承载 Django Web 应用程序。Gunicorn 可以通过以下命令来启动：

gunicorn paperless.wsgi --config gunicorn.conf.py

在这个配置文件中，你可以调整端口、worker 数量和其他性能相关的参数。

3. 项目的配置文件介绍

paperless.conf.example 文件是一个示例配置文件，提供了各种配置选项的注释说明，以便自定义 Paperless-ngx 的行为。实际运行前，你需要创建一个名为 paperless.conf 的文件（不带 .example 扩展名），并根据需求修改其中的值。

一些重要的配置选项包括：

• MEDIA_ROOT: 存储扫描文档和元数据的本地路径。
• DB_NAME: 数据库名称。
• DB_USER: 数据库用户的用户名。
• DB_PASSWORD: 数据库用户的密码。
• OCR_LANGUAGES: 识别文档文本时使用的 OCR 语言。

在开始服务之前，将此配置文件复制到适当位置，并根据你的环境进行适配。

安装与启动

推荐使用 Docker 部署，你可以通过执行 install-paperless-ngx.sh 脚本来快速安装和启动容器：

curl -fsSL https://raw.githubusercontent.com/paperless-ngx/paperless-ngx/main/install-paperless-ngx.sh | bash

更多详细的安装和配置步骤可以在项目的 官方文档 中找到。

---

以上是 paperless-ngx 项目的基本概况、启动文件以及配置文件的介绍。希望这个指南能帮助你顺利地开始使用 Paperless-ngx 来管理和归档你的物理文档。如有其他问题或需要更详细的信息，请查阅项目文档或参与社区讨论。

paperless-ngxA community-supported supercharged version of paperless: scan, index and archive all your physical documents项目地址:https://gitcode.com/gh_mirrors/pa/paperless-ngx