docat
A lightweight, versioned documentation hosting tool that makes it easy to serve multiple projects and versions.
Smart Download
Visit Project Homepage
No installer available yet — head to the source repository
Self-host your docs in minutes with versioning support and a clean UI.
Core Features
- Multi-project, multi-version documentation hosting
- One-command Docker deployment
- CLI client (docatl) for easy uploads
- Project claiming with token-based authentication
- Customizable header/footer via config file
What It Can't Do
- •By default, no authentication is enabled – anyone can upload docs. For public deployment, configure Nginx HTTP Basic Auth. DOCAT only hosts pre-built static docs; you need a separate tool (mkdocs, Sphinx) to generate them.
Use Cases
- Host different versions of software manuals (e.g., v1, v2)
- Internal enterprise docs without relying on third-party services
- Open-source projects that need to keep older doc versions accessible
Detailed Introduction
DOCAT is a lightweight, self-hosted documentation server designed for teams and open-source projects that need to maintain multiple versions of their documentation. It works seamlessly with static site generators like mkdocs, Sphinx, and mdBook. With a single Docker command, you can have a fully functional docs hosting platform. It supports claiming projects with authentication tokens, provides a CLI client (docatl) for easy uploads, and allows customization of headers and footers via config. Unlike hosted services (e.g., Read the Docs), DOCAT gives you full control over your data and is perfect for internal corporate docs or projects that require absolute privacy.
Troubleshooting & FAQ (1)
TroubleshootingDoes docat support uploading .tar or .tar.gz files instead of .zip?
No, docat only accepts .zip files for upload. If your build environment lacks the zip command, use the docatl CLI tool (from the docat project) to package your documentation into a zip. docatl can be added as a binary to your container. See https://github.com/docat-org/docatl.
Tags
Getting Started
Download installer
Click the button above to download the installer for your system
Install the software
Double-click the downloaded installer and follow the prompts
Step 1: Create a local persistence directory (e.g., mkdir -p docat-run/doc)
Step 2: Run the Docker container with port 8000 and volume mount
Step 3: Open http://localhost:8000 in browser to see the default page
- Step 1: Create a local persistence directory (e.g., mkdir -p docat-run/doc)
- Step 2: Run the Docker container with port 8000 and volume mount
- Step 3: Open http://localhost:8000 in browser to see the default page
Checksum not available
This project has not published a SHA-256 checksum on its GitHub Release page
SHA256 Checksum
No checksum available
Download directly from GitHub Releases and verify file integrity yourself
All SHA-256 checksums on this platform are extracted from the project's official GitHub Release page, without any modification. You can independently verify them on the GitHub Releases page.
Open Source Transparency
View GitHub SourceUninstall Info
Stop and remove the Docker container: docker stop docat && docker rm docat; then delete the local persistence directory (e.g., docat-run/) to fully uninstall.
No Extra Dependencies
Ready to use after download. No additional runtime required.
Having issues? Check the FAQ below
1 FAQ
Similar Projects
traefik
Traefik is a modern HTTP reverse proxy and load balancer that makes deploying microservices easy.
Visual Studio Code (Code - OSS)
A free, open-source code editor by Microsoft with rich extensions, debugging, and Git integration. The most popular developer tool worldwide.
scrcpy
Display and control your Android device from your computer via USB or TCP/IP. No root required, high performance, low latency, supports audio and video mirroring.