
项目预览
项目数据
项目介绍
Star 增长趋势
本站每日记录该项目 GitHub 星标变化,观测越久曲线越完整
数据来源:GitHub API 逐日快照 · 收录于 2026-09-29 · 当前星标 ★ 1120
使用教程
环境要求
- Docker 与 docker compose(推荐方式,镜像支持 linux/amd64 和 linux/arm64)
- 手动部署需 Python 3.12
- 手动部署需自行在 PATH 中准备所需转换工具:LibreOffice、Pandoc、Ghostscript、Tesseract、FFmpeg 等(完整列表见
- 使用 GPU 转写需 NVIDIA 显卡并选用 cuda 镜像(仅 amd64)
安装与启动步骤
-
1获取项目文件
从 GitHub 克隆仓库,后续要用到仓库里的 docker-compose.yml 模板
git clone https://github.com/LoredCast/filewizard.git cd filewizard -
2调整 compose 配置
按需修改 docker-compose.yml,将 PUID/PGID 设为挂载目录的所有者(Unraid 常用 99/100)
-
3启动 Docker 容器
在 docker-compose.yml 所在目录执行,镜像会从 Docker Hub 拉取并后台运行
docker compose up -d -
4(可选)手动部署准备
不使用 Docker 时,需先克隆仓库并进入目录,同时确认转换工具已在 PATH 中
git clone https://github.com/LoredCast/filewizard.git cd filewizard -
5创建虚拟环境
在项目目录下创建 Python 3.12 虚拟环境,避免污染系统环境
python3 -m venv venv -
6激活虚拟环境
Linux/macOS 用 source;Windows 改用 venv\\Scripts\\activate
source venv/bin/activate -
7安装 Python 依赖
安装全部依赖;若不需要 TeX、Inkscape、Docling 可改用 requirements_small.txt
pip install -r requirements.txt -
8手动启动服务
执行项目自带启动脚本,默认监听 127.0.0.1:8000
./run.sh
关键配置
| 配置项 | 必填 | 说明 | 示例 |
|---|---|---|---|
PUID | 否 | 容器运行用户的 UID,应与挂载目录所有者一致 | 99 |
PGID | 否 | 容器运行用户的 GID,应与挂载目录所有者一致 | 100 |
LOCAL_ONLY | 否 | 本地模式开关;为 true 时无需登录,为 false 时启用 OIDC 认证 | true |
settings.yml | 否 | 配置文件,用于增删改转换工具及扩展支持的格式 | ./settings.yml |
如何确认成功
浏览器打开 http://localhost:6969(Docker)或 http://127.0.0.1:8000(手动),能看到拖拽上传界面即成功。
常见问题
Q:我该选哪个镜像?
A:loredcast/filewizard:latest 含全部工具;small 版去掉 TeX、Inkscape 和 Docling;cuda 版用于 NVIDIA GPU 转写,仅支持 amd64。
Q:从 0.4 版本如何升级?
A:执行 docker compose pull && docker compose up -d 即可,任务历史可保留。但升级前请先阅读 docs/docker.md 的升级说明,应用不再以 root 运行。
Q:手动部署提示找不到转换工具?
A:需自行安装 LibreOffice、Pandoc、Ghostscript、Tesseract、FFmpeg 等并确保在 PATH 中,完整工具列表可参考项目 Dockerfile。
Q:为什么同一网络的人都能访问和改设置?
A:LOCAL_ONLY 模式没有登录。请只在可信网络中使用,或设置 LOCAL_ONLY=False 启用 OIDC 认证。
注意事项
- LOCAL_ONLY 模式下任何人只要能访问端口就能使用应用并修改设置,务必限制网络访问。
- 转换器会处理不受信任的文件,运行容器时只挂载必要的卷。
- 手动部署更新时执行 git pull,再重跑 pip install 并重启,设置与任务历史会保留。
- Docker 与手动部署的端口不同:Docker 默认 6969,手动启动为 8000。
核心亮点
- 四类办公能力集成在同一 WebUI,免去在多个工具间切换
- 支持本地部署,文档和音频不必上传到第三方服务
- Python 实现,便于二次开发和接入自有模型
不足之处
- 功能依赖多个底层模型与转换库,首次部署和环境配置可能较繁琐
- 项目处于成长阶段,文档和社区生态相对有限
适用场景
- 把扫描版 PDF 或图片批量 OCR 成可编辑文本
- 将会议录音或视频转写成文字稿并导出字幕
- 把整理好的文稿用 TTS 合成为语音文件用于播报
替代项目
Stirling PDF、OCRmyPDF
上一篇:StudyLion
下一篇:Windrecorder
同类项目推荐
android-lumo
开源
用 Proton 生态的加密技术,管好你的密码。
Android application for Proton Lumo
md2wechat-lite
开源
用 Markdown 写公众号,命令行一键排版,告别手动调样式
md2wechat Lite | 轻量版微信公众号 Markdown 排版 CLI,免费开源
websum
开源
一条命令把网页和视频变成要点摘要
Summarize web pages and YouTube videos with pluggable LLM backends (Ollama, OpenAI).···
doclytics
开源
给 paperless-ngx 接上本地大模型,文档自动读懂并打标
A document analyzer for paperless-ngx using ollama
doctor
开源
把 PDF、扫描件批量转成可提取文本的微服务
A microservice for document conversion at scale
mkdocs-llmstxt
开源
给 MkDocs 文档站自动生成面向大模型的 llms.txt 索引
MkDocs plugin to generate an /llms.txt file (https://llmstxt.org/).
archive-pdf-tools
开源
批量生成压缩 PDF,日处理百万页
Fast PDF generation and compression. Deals with millions of pages daily.
textfold
开源
长文一键折叠成五层,先看概览再钻原文
Fold papers, web pages, files, and AI replies into five levels of detail. Zoom from ···
surf
开源
把文件和网页丢进去,AI 自动帮你生成笔记
Personal AI Notebooks. Organize files & webpages and generate notes from them. Open ···