paperless-gpt

环境要求

• 已部署并可访问的 paperless-ngx 实例（含 API Token）
• 已安装 Docker；用 Compose 方式还需 docker compose
• 一个 LLM 服务的密钥（如 OpenAI）或在本地运行 Ollama
• 可选：支持视觉的 OCR 模型（如 ollama 的 minicpm-v、openai 的 gpt-4o）

安装与启动步骤

1. 1准备 Paperless 信息

   确认 paperless-ngx 的访问地址，并在 paperless-ngx 中生成 API Token，供后面两个环境变量使用。

2. 2创建 prompts 目录

   在部署目录下创建 prompts 目录，稍后挂载到容器 /app/prompts，用于放自定义提示词。

   mkdir prompts

   复制

3. 3编写 compose 文件

   新建 docker-compose.yml，镜像用 icereed/paperless-gpt:latest，按需删除注释选择一种 LLM/OCR 提供方。

4. 4启动容器

   在 docker-compose.yml 所在目录执行，会拉取镜像并映射 8080 端口，未填的配置项使用默认值。

   docker compose up -d

   复制

5. 5或本地构建镜像

   手动部署方式：克隆仓库、创建 prompts 目录后自行构建镜像。

   git clone https://github.com/icereed/paperless-gpt.git
   cd paperless-gpt
   mkdir prompts
   docker build -t paperless-gpt .

   复制

6. 6手动运行容器

   不用 Compose 时用 docker run 启动，务必把地址、Token 和密钥替换为真实值后再执行。

   docker run -d \
     -e PAPERLESS_BASE_URL='http://your_paperless_ngx_url' \
     -e PAPERLESS_API_TOKEN='your_paperless_api_token' \
     -e LLM_PROVIDER='openai' \
     -e LLM_MODEL='gpt-4o' \
     -e OPENAI_API_KEY='sk-xxxxxxxx' \
     -e LLM_LANGUAGE='English' \
     -e VISION_LLM_PROVIDER='ollama' \
     -e VISION_LLM_MODEL='minicpm-v' \
     -e LOG_LEVEL='info' \
     -v $(pwd)/prompts:/app/prompts \
     -p 8080:8080 \
     paperless-gpt

   复制

7. 7打开 Web 界面

   浏览器访问本机 8080 端口查看服务界面，若异常先看容器日志（README 提示 read the logs）。

关键配置

如何确认成功

浏览器打开 http://localhost:8080 有界面响应，且容器日志无报错，即表示启动成功。

常见问题

注意事项

• compose 文件里的占位符必须替换为真实值，出问题先看容器日志。
• PDF_REPLACE 设为 true 会在上传后删除原文档，属危险操作，建议先保持 false。
• README 建议先做小范围测试并定期备份 data 数据，避免误处理。
• 默认监听 8080 端口，如与已有服务冲突需调整端口映射。