paperless-ngx

环境要求

• 一台可运行 Docker 与 Docker Compose 的主机（Linux/macOS/Windows 均可）
• 能够访问 GitHub Container Registry（ghcr.io）以下载镜像
• 能够访问 GitHub raw 内容以下载安装脚本（使用一键脚本时）
• 建议预留足够磁盘空间用于存放文档与 OCR 处理结果

安装与启动步骤

1. 1确认 Docker 环境

   README 明确推荐用 docker compose 部署，先确认本机已安装 Docker 与 Compose 插件，否则后续命令无法执行。

   docker --version
   docker compose version

   复制

2. 2一键脚本部署

   README 提供的官方安装脚本，会交互式引导你配置一个 docker compose 环境并拉取镜像。

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

   复制

3. 3或手动克隆仓库

   不想跑脚本时，可克隆仓库，README 指出 docker/compose 目录下的文件已配置好从 GitHub 容器仓库拉取镜像。

   git clone https://github.com/paperless-ngx/paperless-ngx.git
   cd paperless-ngx/docker/compose

   复制

4. 4启动容器

   在 docker/compose 目录中使用 docker compose 启动服务，首次启动会拉取镜像并初始化，耗时较久请耐心等待。

   docker compose up -d

   复制

5. 5查看运行状态

   用 compose 查看容器是否全部处于运行状态，若有容器反复重启，可查看日志定位配置问题。

   docker compose ps
   docker compose logs -f

   复制

6. 6先行体验演示站

   不便部署时可先访问官方演示站体验功能，README 说明演示内容会经常重置，不要上传机密信息。

如何确认成功

容器全部处于 running 状态后，用浏览器打开本机部署的 Web 界面即可看到登录页；也可先访问 demo.paperless-ngx.com（登录 demo / demo）确认功能形态。

常见问题

注意事项

• 本项目完全没有在 README 中给出端口号、环境变量名等具体配置项，实际参数请以安装脚本提示或官方文档为准。
• 用一键脚本安装时会从网络下载脚本并执行，建议先自行核对脚本来源再运行。
• 演示站仅供功能体验，README 明确提醒不要上传机密信息。
• 镜像默认从 GitHub 容器仓库拉取，网络受限时需自行准备加速方案。