DOCAT

DOCAT

Self-hosted, versioned documentation hosting server

879stars
51forks
Last commit: 6mo ago
Repo age: 7y old

DOCAT is a lightweight server for hosting static documentation projects (MkDocs, Sphinx, mdBook, etc.) and multiple versions of those projects. It provides a simple HTTP API and a companion CLI to push, tag and serve documented sites from a single instance.

Key Features

  • Host multiple documentation projects with multiple versions and per-version tagging (e.g., latest).
  • Push documentation archives via an HTTP API or the provided CLI tool (docatl) for CI/CD integration.
  • Built-in static file serving with a web frontend and full-text search for hosted docs.
  • Docker-first distribution (container image) and Dockerfile for easy deployment and updates.
  • Frontend is configurable via a simple JSON config (header/footer HTML) and supports serving static files from a mounted volume.
  • Simple project claiming and token-based control for modification actions; README recommends protecting write endpoints (e.g., HTTP basic auth).
  • Designed to be minimal and easy to operate: focuses on hosting and versioning only, not authoring.

Use Cases

  • Host internal or public product documentation with versioned releases for software teams.
  • Integrate documentation publishing into CI pipelines to automatically deploy new versions of docs.
  • Provide a single, self-hosted docs portal for multiple projects where users can switch between released versions.

Limitations and Considerations

  • By default the server allows unauthenticated uploads and modifications until a project is claimed; administrators should secure the API (README recommends HTTP basic auth for POST/PUT/DELETE).
  • DOCAT is a host for static documentation only — it does not provide authoring, rendering pipelines, or dynamic content generation.
  • There is limited built-in access control and no advanced role-based permissions; for public deployments additional reverse-proxy authentication or network controls are recommended.

DOCAT is a focused, pragmatic tool for teams that need a simple, versioned documentation host with easy CI integration. It emphasizes ease of deployment and minimal configuration while leaving authoring and build workflows to established static documentation tools.

Categories:

Tags:

Tech Stack:

Share:

Similar Services

reveal.js

reveal.js

HTML presentation framework for creating interactive slide decks

70.4k
16.8k
Last commit: 25d ago

reveal.js is an open source HTML presentation framework for building interactive slide decks with HTML, Markdown, and JavaScript, including speaker notes and PDF export.

Alternative to:
Adobe XD
Adobe XD
Docusaurus

Docusaurus

Static site generator for documentation websites

63.4k
9.7k
Last commit: 23h ago

An open source static site generator for building and maintaining documentation and project websites with Markdown/MDX, React, versioning, and i18n.

Alternative to:
Read the Docs
Read the Docs
+13
SiYuan

SiYuan

Privacy-first block-based personal knowledge management app

40.6k
2.5k
Last commit: 4d ago

Open-source, block-oriented personal knowledge manager with Markdown WYSIWYG, block-level two-way links, encrypted sync, Docker deployment and AI integrations.

Alternative to:
SiYuan
SiYuan
+18
Outline

Outline

Team knowledge base & wiki with real-time collaboration and AI search.

36.7k
3k
Last commit: 1d ago

Outline is a fast, collaborative knowledge base for teams, featuring markdown docs, real-time editing, AI-powered search, and Slack integrations.

Alternative to:
Atlassian Confluence
Atlassian Confluence
+16
Reactive Resume

Reactive Resume

Privacy-focused, open-source resume builder

34.5k
3.8k
Last commit: 9d ago

Open-source resume builder for creating, customizing, exporting and publishing resumes with templates, PDF export, public sharing and optional OpenAI assistance.

Alternative to:
Resume.io
Resume.io
+5
MkDocs

MkDocs

Static site generator for project documentation written in Markdown

21.6k
2.6k
Last commit: 2mo ago

MkDocs is a Python-based static documentation site generator that builds searchable HTML docs from Markdown using a simple YAML configuration and themes/plugins.

Alternative to:
Read the Docs
Read the Docs
+7