GitHub OAuthをエールに追加するガイドです。
GitHub OAuthを追加すると、GitHubログインが有効になり、ダッシュボードユーザーは連携したGitHubアカウントのリポジトリを選択してサービスをデプロイできるようになります。
GitHubにログインした後、Settings > Developer Settings > GitHub AppsページでNew GitHub Appをクリックすると、GitHub App作成プロセスが開始されます。
GitHub Appを作成するための情報を以下のように入力してください。
https://app.[ドメイン]
Add Callbak URL
で項目追加)
https://app.[ドメイン]/api/oauth/github/callback
https://app.[ドメイン]/api/oauth/github/connect/callback
https://app.[ドメイン]/api/
はエールのAPIエンドポイントアドレスです。Webhook項目のActiveチェックを解除して無効化してください。
Permission項目で以下の権限を付与し、Create GitHub App
でAPPを作成します。
Repository permissions (9)
Organization permissions (2)
Account permissions (1)
エールにGitHub OAuthを追加するにはGitHub App Nameと4つのID・Keyが必要です。
権限付与後にAppが作成されると、App IDとClient IDを確認できます。
同じ画面でGenerate a new client secret
をクリックしてClient Secretを確認します。
画面下部のGenerate a private key
をクリックしてpemファイルをダウンロードします。
作成されたGitHub Appの公開設定のデフォルト値は非公開であり、Appを作成したアカウントが所属する組織のユーザーのみがGitHub Appを使用できるようになります。GitHub組織に関係なくGitHub Appを使用できるようにするには、以下をご参照ください。
GitHub Appを公開状態に設定する
AdvancedメニューからDanger ZoneセクションのMake public
をクリックします。
運用システムにアクセスし、設定 > 認証手段 > GitHubドロップダウンをクリックした後、前段階で確認した値を各フィールドに入力して適用
をクリックしてください。
ユーザーの最初のGitHubログイン時、Authorize [GitHub App名]
をクリックすると登録申請が進められ、管理者承認に関するメッセージが表示されます。
管理者承認後にGitHubログインを試みると、登録完了ページが表示されます。
スペースと名前を適切に作成し、完了
をクリックしてください。