メインコンテンツへスキップ
KodyをGitHub Appで実行する場合は、アプリを作成する必要があります。このアプリにより、Kodyはリポジトリとやり取りし、プルリクエストを管理し、Webhookを受信できるようになります。
プラットフォームユーザーが「GitHubでサインイン」できるようにしたい場合は、それは別のOAuthアプリのプロセスであり、GitHub Appの権限とは干渉しません。このガイドは機能的なインテグレーションに焦点を当てています。GitHub OAuthアプリを参照してください。

​
前提条件

アプリケーションのドメインを準備してください：
  • WEB_DOMAIN: フロントエンドのURL（例：https://app.yourdomain.comまたはhttp://localhost:3000）
  • API_DOMAIN: バックエンド/APIのURL（例：https://api.yourdomain.com、またはモノレポ/プロキシセットアップの場合はhttp://localhost:3000）
  • WEBHOOK_DOMAIN（オプション）: Webhook用のパブリックドメイン（例：https://kodus-webhooks.yourdomain.com）。APIドメインで/.../webhookをルーティングする場合はAPI_DOMAINを使用できます。

​
ステップ1：GitHub Appの作成

  1. GitHubでSettings > Developer Settings > GitHub Appsに移動
  2. New GitHub Appをクリック
  3. 基本情報（名前、ホームページURL）をお好みに合わせて入力
New GitHub AppボタンをハイライトしたGitHub Appsの設定ページ

​
ステップ2：コールバックURLとセットアップURLの設定

GitHub App Webhook このステップはインストールとリダイレクトが正しく機能するために重要です。以下のフィールドに、WEB_DOMAINを実際のURLに置き換えて入力してください：
  • Callback URL: 
    WEB_DOMAIN/api/auth/callback/github
    このURLは認可フローを完了するために使用されます。
  • Setup URL: 
    WEB_DOMAIN/setup/github
  • オプションRedirect on updateを有効にする これにより、アプリのインストール後にユーザーがKodusにリダイレクトされてセットアップを完了できるようになります。

​
ステップ3：Webhookの設定

WebhookはKodusにプルリクエストのイベントを通知します。
WebhooksはWebhooksサービス（ポート3332）が処理します。ここでAPIドメインを使用する場合は、リバースプロキシが/github/webhookをWebhooksサービスにルーティングすることを確認してください。そうでない場合は専用のWebhooksドメインを使用してください。
  • Webhook URL: 
    WEBHOOK_DOMAIN/github/webhook
  • Activeオプションがチェックされていることを確認

​
ステップ4：認証情報の収集と.envへの追加

GitHub App Webhook GitHubが生成した認証情報を取得し、Kodusの環境変数に追加する必要があります。

​
App ID

アプリの「About」ページの上部でApp IDをコピーします。 .envに追加： 
API_GITHUB_APP_ID=your_app_id_here

​
クライアントシークレット

Client secretsセクションに移動し、Generate a new client secretをクリックします。 生成された値をコピーします。 .envに追加： 
API_GITHUB_CLIENT_SECRET=your_client_secret_here

​
秘密鍵

ページ下部までスクロールして、Generate a private keyをクリックします。 これにより.pemファイルがダウンロードされます。テキストエディタでこのファイルを開き、内容全体をコピーします。 .envに追加： 
API_GITHUB_PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY----- ..."

​
インストールURL

GitHub Appを開いてInstall Appをクリックします。ブラウザのアドレスバーからURL（https://github.com/apps/<app-slug>/installations/newのような形式）をコピーします。 .envに追加： 
WEB_GITHUB_INSTALL_URL="https://github.com/apps/your-app/installations/new"

​
環境変数の概要

最終的に、設定ファイルには以下が含まれている必要があります： 
API_GITHUB_APP_ID=123456
API_GITHUB_CLIENT_SECRET=example_secret_123
API_GITHUB_PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY----- ..."
WEB_GITHUB_INSTALL_URL="https://github.com/apps/your-app/installations/new"
GitHubでSave Changesをクリックし、Kodusアプリケーションを再起動して変更を適用してください。