项目预览
项目数据
项目介绍
Star 增长趋势
本站每日记录该项目 GitHub 星标变化,观测越久曲线越完整
数据来源:GitHub API 逐日快照 · 收录于 2026-10-29 · 当前星标 ★ 5979
技术标签
使用教程
⚠ 本教程由 AI 依据该项目 README 整理;原始文档不完整,部分步骤为通用流程推断,实际安装请以项目官方文档为准。
⚠ 该项目 README 未提供完整安装说明,以下步骤为通用流程,请以官方文档为准。
环境要求
- 已部署并运行可访问的 Paperless-ngx 实例(提供文档库与 API)
- 可用的模型服务:OpenAI 兼容接口(OpenAI、DeepSeek-r1、Azure 等)或本地 Ollama
- Docker 运行环境(README 仅说明提供 Docker 支持与持久化卷)
- Node.js 与 npm(README 给出 npm install 安装依赖)
安装与启动步骤
-
1准备前置服务
先确认 Paperless-ngx 可正常访问,并准备好 OpenAI 兼容接口或 Ollama 模型服务的地址与密钥。
-
2获取项目代码
克隆仓库到本地,后续依赖安装与容器配置都在该目录内进行。
git clone https://github.com/clusterzx/paperless-ai.git cd paperless-ai -
3安装依赖
在项目目录执行 README 给出的依赖安装命令,等待 npm 完成依赖拉取。
npm install -
4以容器方式运行
README 说明项目提供 Docker 支持:配置持久化卷保存数据、设置自动重启与健康监控;具体镜像与端口以官方 Installation Wiki 为准。
-
5完成首次配置
打开 Web 界面,填写 API 密钥与偏好设置,选择要使用的模型后端并连接 Paperless-ngx。
-
6重启容器建索引
README 明确:首次安装完成设置后必须重启容器以构建 RAG 索引;后续升级更新不需要重启。
-
7确认处理结果
在 Web 界面查看文档处理进度,检查标题、标签、文档类型与对应人是否已回写。
关键配置
| 配置项 | 必填 | 说明 | 示例 |
|---|---|---|---|
API 密钥 | 是 | 调用所选模型服务所需的密钥,在 Web 界面偏好设置中填写 | sk-xxxxxxxx |
模型服务地址 | 是 | OpenAI 兼容接口或本地 Ollama 的访问地址 | http://192.168.1.10:11434 |
Paperless-ngx 连接信息 | 是 | 用于拉取文档并回写元数据的实例地址与访问凭据 | http://192.168.1.10:8000 |
偏好设置 | 否 | 在 Web 界面调整自动处理、标签与分类等行为 | 按实际需求填写 |
如何确认成功
容器处于运行状态,浏览器打开 Web 界面可正常加载,并能看到文档处理进度与结果列表。
常见问题
Q:首次安装后为什么要重启容器?
A:README 说明首次安装完成 API 密钥和偏好设置后需重启容器以构建 RAG 索引,之后的版本更新不需要重复此操作。
Q:支持哪些模型服务?
A:支持 OpenAI API、Ollama、DeepSeek-r1、Azure 以及所有兼容 OpenAI 接口的模型服务,也可本地部署模型。
Q:项目目前还在维护吗?
A:README 声明仓库当前不再维护,作者正在用更稳定的架构重写代码库,也提到 Paperless-ngx 将内置 AI 能力。
Q:完整的安装参数在哪里查?
A:README 只给出 Installation Wiki 链接,镜像、端口、卷挂载等具体参数请以该 Wiki 页面为准。
注意事项
- README 未给出完整的安装命令,仅指向官方 Installation Wiki,实际部署参数请以 Wiki 为准
- 项目当前处于不再维护状态,使用前请评估长期维护风险
- 务必为容器配置持久化卷,避免重建容器时配置与索引丢失
- 敏感密钥建议通过环境变量或界面配置保存,不要写入公开的配置文件
核心亮点
- 与 Paperless-ngx 深度集成,分析结果直接回写标签和元数据,无需手工搬运
- 支持 Ollama 本地模型与多种兼容 OpenAI 接口的服务,模型选择灵活
- 提供 Web 管理界面和定时任务,可批量处理存量文档并持续跟进新文档
不足之处
- 效果高度依赖所选模型和提示词质量,小模型易出现标签不准或幻觉
- 配置项较多,非技术用户上手需要一定调试成本
适用场景
- 个人无纸化归档:扫描发票、合同后自动分类打标签
- 小团队文档库:批量整理历史扫描件,补齐标题、日期等元数据
- 本地隐私场景:用 Ollama 本地模型处理敏感文档,数据不出内网
替代项目
paperless-ngx、paperless-gpt、docling
下一篇:doclytics
同类项目推荐
quickshot
开源
悬停即截窗口,标注美化拼图一步到位
Screenshots, beautifully simple. A fast, local-first screenshot tool for macOS and W···
humla
开源
Mac 上不开会机器人,自动录音转写并生成可提问的会议笔记
Open-source AI meeting notes for Mac. Records mic + system audio with no bot, transc···
MarkFlowy
开源
边写边看,AI 帮你写,跨平台 Markdown 编辑器
A high-performance, local-first Markdown editor and general-purpose text editor for ···
gridcraft
开源
纯 Rust 写的 Excel,安全又轻快
GridCraft: an open-source, clean-room spreadsheet (Microsoft Excel-style) in pure Ru···
convoviz
开源
把 ChatGPT 聊天记录一键变成干净的 Markdown 和图表
Convert your ChatGPT export (ZIP) into clean Markdown text files with inline media, ···
officecli
开源
一句话生成可编辑的 Office 文档,告别手动排版。
OfficeCLI is AI document generation CLI for PPTX, DOCX, XLSX, Reports, and Images. G···
obsidian-md2wechat
开源
一键将 Obsidian 笔记排版成公众号文章,告别手动调格式
Obsidian → WeChat | Obsidian 插件一键排版发布到微信公众号,键排版发布到微信公众号:···
PPT-Design-Skill
开源
一句话生成4万种风格、可编辑的专业PPT
Precision PPT design skill for OpenCode/Claude Code/Codex, with 40,000+ styles, pixe···
preswald
开源
把 Python 数据应用打包成单个 HTML,浏览器里离线跑,分享像发文档。
Preswald is a WASM packager for Python-based interactive data apps: bundle full comp···
