docat
一个简单、支持多版本的文档托管工具，让你像管理代码一样管理文档版本。
智能下载
前往项目主页
该项目暂未提供安装包，请直接访问源代码仓库
一键 Docker 部署，轻松托管多版本文档。
核心功能
- 支持多个项目及每个项目的多个版本
- 通过 Docker 一键部署，两分钟即可上线
- 提供 CLI 客户端 docatl，一键上传文档
- 支持项目认领和令牌认证，保证上传安全
- 支持自定义页面页眉页脚，适配品牌风格
避坑指南
- •默认不开启身份认证，任何知道服务地址的人都可以上传文档。若要在公网部署，务必配置 Nginx 的 HTTP Basic Auth（详见 README）。另外，DOCAT 只负责托管文档，并不提供文档编写功能，你需要先用 mkdocs 等工具生成静态文件。
适用场景
- 为软件的不同版本（如 v1.0、v2.0）分别托管对应的用户手册
- 企业内部团队使用，无需依赖第三方文档托管平台
- 开源项目展示文档，同时保留旧版本文档供用户查阅
详细介绍
DOCAT 是一款轻量级、自托管的文档托管服务器，专为需要维护多个文档版本的项目或团队设计。它无缝兼容 mkdocs、Sphinx、mdBook 等静态站点生成器。只需一条 Docker 命令，即可获得一个功能完善的文档托管平台。支持通过令牌认领项目、提供 CLI 工具（docatl）轻松上传文档，并允许通过配置文件自定义页眉页脚。与 Read the Docs 等托管服务不同，DOCAT 让您完全掌控数据，非常适合内部企业文档或对隐私有严格要求的项目。
常见问题与排障 (1)
故障排除docat是否支持上传.tar或.tar.gz文件而不是.zip文件？
不，docat只接受.zip文件上传。如果您的构建环境缺少zip命令，请使用docatl CLI工具（来自docat项目）将文档打包成zip。docatl可以作为二进制文件添加到您的容器中。请参阅 https://github.com/docat-org/docatl。
标签
快速上手
安装软件
双击下载的安装程序，按提示完成安装
步骤1：在本地创建持久化目录（如 mkdir -p docat-run/doc）
步骤2：运行 Docker 命令启动容器（端口8000，挂载目录）
步骤3：打开浏览器访问 http://localhost:8000，即可看到默认界面
- 步骤1：在本地创建持久化目录（如 mkdir -p docat-run/doc）
- 步骤2：运行 Docker 命令启动容器（端口8000，挂载目录）
- 步骤3：打开浏览器访问 http://localhost:8000，即可看到默认界面
暂未获取到校验码
该项目暂未在 GitHub Release 页面提供 SHA-256 校验码
SHA256 校验码
暂无校验码
建议从 GitHub Releases 页面直接下载，并自行核对文件完整性
本平台所有 SHA-256 校验码均提取自项目在 GitHub 官方 Release 页面发布的文件，未做任何修改。你可以通过 GitHub Releases 页面自行验证。
开源透明
查看 GitHub 源码卸载说明
停止并删除 Docker 容器：docker stop docat && docker rm docat；然后删除本地持久化数据目录（默认为 docat-run/）即可完全卸载。
无额外依赖
下载后即可直接使用，无需安装其他运行环境
遇到问题？查看下方 FAQ
1 FAQ