Paperless-ngx 安装与调试教程

1。安装 Paperless-ngx

1.1 安装 Docker 和 Docker Compose

在 Mac 上安装 Docker Desktop:

  • 访问 Docker 官方网站:Docker Desktop for Mac
  • 下载并安装 Docker Desktop。
  • 启动 Docker Desktop 应用。

安装 Docker Compose (通常与 Docker Desktop 一起安装):

1
2
# 检查 Docker Compose 是否已安装
docker-compose --version

1.2 下载并配置 docker-compose.yml 文件

下载 docker-compose.yml

1
curl -L https://raw.githubusercontent.com/paperless-ngx/paperless-ngx/main/docker-compose.yml -o docker-compose.yml

使用文本编辑器打开并根据需要进行配置。

1.3 启动 Paperless NGX

启动服务:

1
docker-compose up -d

1.4 访问 Paperless NGX 网页界面

在浏览器中输入:

1
http://localhost:8000

2。处理安装脚本中的错误

2.1 timedatectl 命令错误

  • macOS 不支持 timedatectl,此错误可以忽略。
  • 继续执行安装脚本。

2.2 sed 命令语法错误

  • macOS 使用 BSD 版本的 sed,可能需要不同的语法。
  • 手动修正 docker-compose.yml 中的相关命令或使用 macOS 兼容的 sed 语法。

3。Paperless-ngx 容器状态检查

3.1 使用 docker ps 检查容器状态

1
docker ps

检查容器是否正常运行。

3.2 识别并解决容器重启问题

  • 如果某个容器不断重启,使用 docker logs [container-id] 查看日志。
  • 根据日志输出解决相应问题。

4。调试 Paperless-ngx 运行错误

4.1 处理 OCR 语言错误

  • 确保所需的 OCR 语言包已在容器中安装。

4.2 修改环境变量以禁用或更改 OCR 设置

.envdocker-compose.yml 中修改:

1
PAPERLESS_OCR_LANGUAGE=eng

或禁用 OCR:

1
PAPERLESS_OCR_MODE=none

4.3 使用 docker logs 检查日志

1
docker logs [container-id]

查找错误或异常信息。

4.4 诊断 unhealthy 容器状态

  • 检查 docker-compose.yml 中的 healthcheck 配置。
  • 手动运行健康检查命令。

4.5 通过 curl 测试并识别 HTTP 500 错误

1
curl -f http://localhost:8000

分析 HTTP 500 错误原因。

4.6 调试 Django 应用

  • 在开发模式下运行 Django,设置 DEBUG=True (仅用于调试)。

4.7 检查数据库连接和迁移

  • 确保数据库服务正常运行。
  • 检查数据库连接配置。

5。附加建议和支持

5.1 调整健康检查配置

根据需要调整 docker-compose.yml 中的 healthcheck

5.2 联系 Paperless-ngx 社区寻求帮助

5.3 保障敏感数据安全性的建议

  • 保持系统更新。
  • 使用强密码。
  • 遵循网络安全最佳实践。