OpenSource-Hub
D

docat

898 stars·開発ツール·SHA-256 チェックサム確認済み

シンプルで複数バージョンに対応したドキュメントホスティングツール。コードと同じようにドキュメントのバージョンを管理できます。

スマートダウンロード

プロジェクトのホームページへ

インストーラはまだありません — ソースリポジトリをご覧ください

ワンクリックの Docker デプロイで、複数バージョンのドキュメントを簡単にホスティングできます。

主な機能

  • 複数のプロジェクトおよび各プロジェクトの複数バージョンをサポート
  • Docker によるワンクリックデプロイで、2分で本番稼働可能
  • CLI クライアント docatl を提供し、ワンクリックでドキュメントをアップロード
  • プロジェクトのクレームとトークン認証をサポートし、アップロードのセキュリティを保証
  • ページのヘッダーとフッターのカスタマイズをサポートし、ブランドスタイルに対応

できないこと

  • •デフォルトでは認証が有効になっていないため、サービスのアドレスを知っている人は誰でもドキュメントをアップロードできます。パブリックネットワークにデプロイする場合は、必ず Nginx の HTTP Basic Auth を設定してください（詳細は README を参照）。また、DOCAT はドキュメントのホスティングのみを担当しており、ドキュメントの作成機能は提供していないため、事前に mkdocs などのツールで静的ファイルを生成する必要があります。

使用例

  • ソフトウェアの異なるバージョン（v1.0、v2.0 など）ごとに対応するユーザーマニュアルをホストする
  • 企業内部のチームで使用し、サードパーティのドキュメントホスティングプラットフォームに依存する必要がない
  • オープンソースプロジェクトでドキュメントを公開し、旧バージョンのドキュメントも保持してユーザーが参照できるようにする

詳細説明

DOCAT は軽量なセルフホスト型のドキュメントホスティングサーバーで、複数のドキュメントバージョンを管理する必要があるプロジェクトやチーム向けに設計されています。mkdocs、Sphinx、mdBook などの静的サイトジェネレーターとシームレスに互換性があります。Docker コマンドを1つ実行するだけで、完全な機能を備えたドキュメントホスティングプラットフォームを手に入れることができます。トークンによるプロジェクトのクレームをサポートし、CLI ツール（docatl）でドキュメントを簡単にアップロードでき、設定ファイルでヘッダーとフッターをカスタマイズできます。Read the Docs などのホスティングサービスとは異なり、DOCAT ではデータを完全に管理できるため、社内の企業ドキュメントやプライバシー要件の厳しいプロジェクトに最適です。

トラブルシューティング & FAQ (1)

トラブル対応
docatは.zipの代わりに.tarや.tar.gzファイルのアップロードをサポートしていますか？

いいえ、docatはアップロードに.zipファイルのみを受け付けます。ビルド環境にzipコマンドがない場合は、docatプロジェクトのdocatl CLIツールを使用して、ドキュメントをzipにパッケージ化してください。docatlはバイナリとしてコンテナに追加できます。詳細は https://github.com/docat-org/docatl をご覧ください。

参照 Issue #916

タグ

documentationhostingversioningdockermkdocssphinx

はじめ方

1

インストーラをダウンロード

上のボタンをクリックして、お使いのシステム用のインストーラをダウンロード

プロジェクトのホームページへ
2

ソフトウェアをインストール

ダウンロードしたインストーラをダブルクリックし、指示に従ってください

3

ステップ1：ローカルに永続化ディレクトリを作成します（例：mkdir -p docat-run/doc）

4

ステップ2：Docker コマンドを実行してコンテナを起動します（ポート8000、ディレクトリをマウント）

5

ステップ3：ブラウザで http://localhost:8000 にアクセスすると、デフォルトの画面が表示されます

インストールガイド
  1. ステップ1：ローカルに永続化ディレクトリを作成します（例：mkdir -p docat-run/doc）
  2. ステップ2：Docker コマンドを実行してコンテナを起動します（ポート8000、ディレクトリをマウント）
  3. ステップ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/）を削除すれば、完全にアンインストールできます。

追加の依存関係なし

ダウンロード後すぐに使用可能。追加のランタイムは不要です。

プロジェクト情報
ライセンスMIT
最終更新2026-06-27 13:40:07
GitHub リポジトリ公式サイト

問題が発生？以下のFAQを確認

1 FAQ

類似プロジェクト

V

Visual Studio Code (Code - OSS)

Microsoft製の無料オープンソースコードエディタ。インテリジェントなコード補完、デバッグ、Git、拡張機能をサポートし、世界で最も人気があります。

O

opencode

オープンソースのAIコーディングエージェント、コードの作成、リファクタリング、分析をサポートし、「ビルド」と「計画」のデュアルエージェントモードを内蔵。

S

scrcpy

USBまたは無線TCP/IP経由でパソコンにAndroidデバイスを画面投影し、操作することができます。root不要で、高性能かつ低遅延、音声転送にも対応しています。