Skip to main content

システム要件

デフォルトの local サンドボックスモード(kodus-graph + cross-file コンテキストが worker コンテナ内で実行される)を想定したサイジング。
  • CPU: 2 コア以上(~100k LOC を超えるリポジトリでは 4 コア以上を推奨)
  • RAM: 8GB 以上(大規模リポジトリで local サンドボックスを使う場合は 16GB を推奨)
  • ストレージ: 60GB 以上の空き容量(Postgres が AST グラフのキャッシュを保持。 リポジトリ数と PR 量に応じて増加)
  • Docker(最新の安定版)と Compose プラグイン
  • ドメイン名または固定 IP — クラウド Git プロバイダー (GitHub.com、GitLab.com など)から webhook を受信したい場合
デフォルトのホストポートマッピング — 競合する場合は .env で調整。
  • 3000 — Kodus Web App
  • 3001 — API
  • 3332 — Webhooks
  • 5432 — PostgreSQL
  • 27017 — MongoDB
  • 5672, 15672, 15692 — RabbitMQ(AMQP、管理 UI、メトリクス)
  • 3101 — MCP Manager API_MCP_SERVER_ENABLED=true の場合のみ)
./scripts/install.sh.env に基づいて起動するサービス。コア(常時起動):
  • api — メインバックエンド
  • worker — code review ジョブ
  • webhooks — Git プロバイダー webhook レシーバー
  • kodus-web — Next.js フロントエンド
  • db_kodus_postgresdb_kodus_mongodbrabbitmq — ローカルインフラ。マネージドインスタンスを指す場合は USE_LOCAL_DB=false / USE_LOCAL_RABBITMQ=false でスキップ。
オプション:
  • kodus-mcp-manager — Model Context Protocol ブローカー。 API_MCP_SERVER_ENABLED=true で有効化。 MCP Manager を参照。
  • worker-analytics — Cockpit 取り込み(DORA メトリクス、PR classifier)。セルフホスト Enterprise 専用、デフォルトでは 組み込まれません。 Analytics Worker を参照。
Code review はサンドボックス内で実行される AST グラフ + cross-file コンテキストを使用します — local(デフォルト、worker 内で実行)または e2b(有料リモートサンドボックス)。モード、キャッシュの動作、各モードの 選択基準については Sandbox & AST Graph を参照してください。
クラウドベースのGitサービス(GitHub、GitLab、Bitbucket)やクラウドLLMプロバイダー(OpenAI、Anthropicなど)に接続する場合は、インターネットアクセスが必要です。 ネットワーク内の自己ホスト型GitツールやオンプレミスLLMを使用する場合、外部インターネットアクセスはオプションです。

ドメイン名の設定(オプション)

クラウドベースのGitプロバイダー(GitHub、GitLab、Bitbucket)とKodusを統合する予定がある場合は、Kodus WebアプリとそのAPI両方に公開URLが必要です。これにより、サーバーがコードレビュー機能に必要なwebhookを受信できるようになり、アプリケーションが正しく動作します。 2つのサブドメインを設定することをお勧めします:
  • Webアプリケーション用(例:kodus-web.yourdomain.com
  • API用(例:kodus-api.yourdomain.com
Webhookは別サービス(ポート3332)で処理されます。以下のいずれかを選択できます:
  • 専用のwebhookサブドメインを使用する(例:kodus-webhooks.yourdomain.com
  • APIドメインを引き続き使用し、リバースプロキシで/github/webhook/gitlab/webhookなどをwebhookサービスにルーティングする
両方のサブドメインのDNS Aレコードをサーバーのipアドレスに向ける必要があります。このガイドの後半で、これらのサブドメインへのリクエストを正しい内部サービスにルーティングするリバースプロキシ(Nginx)を設定します。この設定はwebhookや認証を含む完全な機能に不可欠です。
注意: ネットワーク内の自己ホスト型Gitツールのみに接続し、公開アクセスやwebhookが不要な場合は、よりシンプルな設定が可能ですが、このガイドは公開デプロイに焦点を当てています。

セットアップ

1

インストーラーリポジトリをクローン

2

環境変数ファイルのサンプルをコピー

3

必要な環境変数のセキュアキーを生成

4

環境変数ファイルを編集

お好みのテキストエディタで.envに値を設定します。
詳細な手順については、環境変数の設定を参照してください。
5

インストーラーを実行

6

完了 🎉

完了すると、Kodusサービスがマシン上で実行されます。 以下のスクリプトでインストールを確認できます:
7

Webインターフェースにアクセス

Webインターフェースに初めてアクセスする際は、以下の設定が必要です:
  1. 管理者アカウントの作成 - システムへのフルアクセス権を持つ最初のユーザーになります
  2. Gitプロバイダーの設定 - 画面の指示に従ってGitHub、GitLab、またはBitbucketを接続します
  3. リポジトリの選択 - Kodyがレビューするコードリポジトリを選択します
初期設定プロセスの詳細な手順については、クイックスタートガイドを参照してください。

環境変数の設定

このセクションを使用して.envを入力してください。まずパブリックURLから始め、次にデータベースとRabbitMQを設定し、最後にプロバイダー固有の設定を追加します。

ネームスペースの設定

これらの設定は、WebアプリとAPIが使用するパブリックURLとホストバインディングを定義します。 MCP Managerを使用しない場合は、ここのMCPエントリと下の完全なブロックをスキップできます。

LLMプロバイダーの設定

Novita、OpenAI、Anthropicなどの人気プロバイダーの詳細なセットアップ手順については、モデル固有のガイドをご確認ください。

データベースの設定

デフォルトではPostgresとMongoDBにローカルコンテナを使用します。セキュリティ要件に合わせて認証情報を更新してください。
バンドルされたデータベースの場合は、API_PG_DB_PASSWORDAPI_MG_DB_PASSWORD を空のままにして ./scripts/generate-secrets.sh を実行すると生成されます。あるいは自分で設定することもできます。外部データベースの場合は、既存のデータベースのパスワードを使用してください。

RabbitMQの設定

RabbitMQは2.0で必須です。URIを以下の値と同期させてください。

ワーカーの設定

ワーカーコンテナは処理するワークロードを知るためにロールが必要です。 セルフホストはコードレビューのロールのみを実行します。analytics ロールは クラウド専用です。
WORKER_ROLE を未設定のままにすると、ワーカーは起動時にクラッシュします。workflow.jobs.* キューはワーカーの初回接続時に作成されるため、ワーカーが落ちると api と webhooks はすべての webhook イベントで QueueBind 404 エラーになります。

Gitプロバイダーの設定

お好みのGitプロバイダーを選択して設定してください。1つ以上のプロバイダーを設定できます。基本的なトークンベース認証には、Webhook URLのみが必要です。
WebhooksはWebhooks(ポート3332)というサービスが処理します。Webhook URLはそのサービスに到達できる必要があります。専用のWebhooksドメインを使用するか、APIドメインを保持してリバースプロキシで/.../webhookパスをWebhooksサービスにルーティングすることができます。 GitHub または GitLab OAuthをお使いの場合は、GitHub OAuthアプリまたはGitLab OAuthアプリをご覧ください。GitHub Appのセットアップについては、GitHub Appをご覧ください。

MCP Managerの設定

MCP Managerを使用したい場合のみ必要です。
MCP Managerは、KodyExternalを外部ツールに接続し、Pluginsスクリーンに公開するサービスです。詳細についてはMCP Managerのドキュメントを参照してください。

外部サービスの設定(オプション)

これらのサービスはオプションですが、KodusのコードレビューBIG品質を大幅に向上させます。それぞれのサービスでアカウントを作成してAPIキーを生成する必要があります。
E2BはKodusがレビュー中にコードを実行・検証するために使用するセキュアなサンドボックスを提供します。
  1. e2b.devでアカウントを作成
  2. ダッシュボードでAPIキーを生成
  3. .envに追加:
MorphLLMは高速かつ正確なコード編集のための特化モデルです。KodusはこれをRevvisionBの提案をより正確に適用するために使用します。
  1. morphllm.comでアカウントを作成
  2. ダッシュボードでAPIキーを生成
  3. .envに追加:

サポートが必要ですか?

ファウンダーとの通話をスケジュールして、デプロイのサポートを受けましょう。

コミュニティでサポートを受ける

コミュニティに参加して、デプロイのサポートを受けましょう。