yavadmin/docx-api
yavadmin
这是docx应用的FastAPI后端，提供认证、文档管理、文件处理、AI搜索问答及同步等功能，支持自托管和离线优先的文档管理场景。
下载次数: 0状态：社区镜像维护者：yavadmin仓库类型：镜像最近更新：1 个月前
让 AI 帮你使用轩辕镜像？ · 展开查看说明 · 点击收起说明
如果你使用 DeepSeek、元宝 AI、Copilot、ChatGPT 等 AI 工具，协助配置轩辕镜像、编写 docker pull 命令、修改 Docker Compose 镜像地址、配置镜像加速、排查镜像拉取失败、分析报错日志等问题，请先让 AI 阅读并遵守轩辕镜像的规则文档。
只需在 AI 对话中先发送下面这句话即可：
请先完整阅读并严格遵守以下文档中的全部规则与要求：
https://xuanyuan.cloud/agents.md
在未充分阅读并理解该文档前，不要生成任何命令、配置、修改建议、故障排查方案或技术回答。后续所有输出都必须严格以该文档中的规范为最高优先级执行。查看 agents.md 用法指南与完整示范。国内用户首推 元宝 AI、DeepSeek 的深度思考模式，不推荐豆包 AI；Cursor 等编辑器可在对话 @ 该链接，或加入 User Rules。 若 AI 无法访问外链，可 打开说明文档 复制全文粘贴。文档会随站点更新，复制内容可能过期，建议定期检查。
docx API
docx-api是https://github.com/YavLabs/docx%EF%BC%88%E4%B8%80%E6%AC%BE%E8%87%AA%E6%89%98%E7%AE%A1%E3%80%81%E7%A6%BB%E7%BA%BF%E4%BC%98%E5%85%88%E7%9A%84%E6%96%87%E6%A1%A3%E7%AE%A1%E7%90%86%E5%BA%94%E7%94%A8%E5%92%8C%E6%96%87%E4%BB%B6%E7%AE%A1%E7%90%86%E5%99%A8%EF%BC%89%E7%9A%84**FastAPI%E5%90%8E%E7%AB%AF**%E3%80%82
镜像概述
该镜像作为docx应用的核心后端服务，负责处理应用的核心业务逻辑，支持自托管部署，满足离线优先的文档管理需求。
核心功能
- 认证与RBAC权限管理
- 工作区管理与BlockNote文档存储
- 文件元数据处理及预签名上传/下载
- AI搜索与问答流水线（基于pgvector + ***/OpenAI/Ollama）
- 预览路由与共享模型
- 离线发件箱同步API
使用场景
- 自托管文档管理系统部署
- 企业内部文件协作与共享平台
- 离线优先的个人/团队文档工具
- 集成AI搜索功能的文档知识库
配置说明
标签说明
| 标签 | 说明 |
|---|---|
latest | 跟踪master分支最新版本 |
v1.0.0, v1.0.1等 | 语义化版本发布标签 |
sha-<short> | 固定提交版本（适用于docker-compose.prod.yml） |
环境变量配置
所有配置通过项目.env文件实现，必填项包括：
APP_BASE_URL：公共源地址（影响邮件、OAuth、CORS、预签名URL）POSTGRES_*：Postgres数据库配置STORAGE_*：对象存储配置（或使用内置MinIO）JWT_SECRET：JWT密钥SUPERADMIN_EMAIL、SUPERADMIN_PASSWORD：超级管理员账号信息
可选配置：ANTHROPIC_API_KEY、OPENAI_API_KEY、OLLAMA_BASE_URL、GOOGLE_CLIENT_ID/SECRET等。完整列表见https://github.com/YavLabs/docx/blob/master/.env.example%E3%80%82
部署示例
该镜像需作为docx栈的一部分运行（依赖Postgres+pgvector、Redis、对象存储及docx-nginx入口），使用项目的docker-compose.prod.yml部署：
bashgit clone https://github.com/YavLabs/docx.git cd docx cp .env.example .env # 编辑.env — 设置APP_BASE_URL、JWT_SECRET、SUPERADMIN_*及存储凭证 docker compose -f docker-compose.prod.yml pull docker compose -f docker-compose.prod.yml up -d docker compose -f docker-compose.prod.yml exec api uv run alembic upgrade head
相关链接
- 源码：https://github.com/YavLabs/docx
- 发布版本：https://github.com/YavLabs/docx/releases
- 部署指南：https://github.com/YavLabs/docx/blob/master/DEPLOY.md
- 许可证：AGPL-3.0
镜像拉取方式
您可以使用以下命令拉取该镜像。请将 <标签> 替换为具体的标签版本。如需查看所有可用标签版本，请访问 标签列表页面。
轩辕镜像加速拉取命令点我查看更多 docx-api 镜像标签
docker pull docker.xuanyuan.run/yavadmin/docx-api:<标签>
DockerHub 原生拉取命令
docker pull yavadmin/docx-api:<标签>
镜像拉取常见问题
功能
错误码
用户好评
来自真实用户的反馈，见证轩辕镜像的优质服务
oldzhang
运维工程师
Linux服务器
5
"Docker访问体验非常流畅，大镜像也能快速完成下载。"