GitHub Insightsのインストール

必要な環境

• GitHub Insightsを含むGitHub Enterpriseのライセンスファイルを持っていなければなりません。 GitHub Insightsの購入後、更新されたライセンスファイルをGitHub Enterprise Webポータルでダウンロードできます。

• GitHub Insightsは、アプリケーションサーバーと呼ばれるマシンを必要とします。これは、クラウドでもローカルでもホストできます。 詳しい情報については「GitHub Insightsのシステム概要」を参照してください。

• アプリケーションサーバーに依存関係をインストールしなければなりません。

  • Docker 1.13.0+
  • Docker Compose v1.17.0+

  ノート： アプリケーションサーバーでは、Dockerデーモンをsudoとして実行させる必要があるかもしれません。 Kubernetesはサポートされていません。

GitHub Appの作成

GitHub InsightsをGitHub Enterpriseに接続するには、GitHub Enterprise上のOrganization内にGitHub Appを作成しなければなりません。 インテグレーションが動作すると、GitHub Enterprise上にアプリケーションのスラッグバージョンの名前が表示されます。

1. http(s)://HOSTNAME/loginでGitHub Enterprise Server インスタンスにサインインしてください。

2. GitHub Insightsに接続したいOrganizationにアクセスしてください。

3. Organization名の下で、Settings（設定）をクリックしてください。

   

4. 左サイドバーで [GitHub Apps] をクリックします。

   

5. New GitHub App（新規GitHub App）をクリックしてください。 

6. "GitHub App name（GitHub App名）"の下で、アプリケーションの名前を入力してください。アプリケーションの名前は、その名前があなた自身のユーザ名やOrganization名でないかぎり、既存のユーザやOrganizationと同じ名前になってはいけません。

   

7. "Homepage URL（ホームページのURL）"の下に、GitHub InsightsのアプリケーションサーバーのURLを入力してください。 詳しい情報については「GitHub Insightsのシステム概要」を参照してください。

   

8. ""User authorization callback URL（ユーザ認証のコールバックURL）"の下で、以下の<application-server-url>をアプリケーションサーバーのURLで置き換えて入力してください。

   <application-server-url>/public/applogin
   

   

9. "Setup URL（セットアップURL）"の下で、<application-server-url>/public/setupと入力してください。

   

10. "Webhook URL"の下で、 <application-server-url>/webhooksと入力してください。

    

11. "Webhook secret（Webhookのシークレット）"の下で、シークレットを入力し、後に参照するためにそのシークレットを記録しておいてください。

    

12. "Permissions（権限）"の下で、ドロップダウンメニューを使ってアプリケーションに以下の権限を設定してください。

    • リポジトリ:
      • Contents: Read-only
      • Metadata: Read-only
      • Pull requests: Read-only
      • Pull requests: Read-only
    • Organization:
      • Members: Read-only
      • Projects: Read-only
    

13. "Subscribe to events（イベントのサブスクライブ）"の下で、以下を選択してください。

    • Member
    • Pull request
    • Push
    • Repository
    • Team
      

14. GitHub Enterprise Server インスタンス内の任意のユーザあるいはOrganizationからのデータにGitHub Appがアクセスできるようにするために、"Where can this GitHub App be installed?（このGitHub Appはどこにインストールできますか？）"の下で、Any account（任意のアカウント）を選択してください。

    

15. Create GitHub App（GitHub Appの作成）をクリックしてください。

    

16. アプリケーションの設定をレビューしてください。

17. "Private keys（秘密鍵）"の下で、Generate a private key（秘密鍵の生成）をクリックしてください。

    

18. 生成されたPEMファイルを、後で使うために保存してください。

19. アプリケーションに関する以下の情報を、後で参照できるよう記録しておいてください。

    • App ID（アプリケーションID）
    • Client ID（クライアントID）
    • Client secret（クライアントシークレット）
    • Private key（秘密鍵）
    • Webhook secret（Webhookシークレット）

GitHub Insightsのインストール

1. アプリケーションサーバーから、github/insights-releasesのリリースページ上の最新のGitHub Insightsリリースにアクセスしてください。
2. 最新のリリースをダウンロードするために、"Assets（アセット）"の下のinsights-VERSION.tar.gzをクリックしてください。
   
3. ディレクトリをUnzipしてください。
4. シェルスクリプトのinstall.shを実行してください。
5. SSLを有効化するためにSSL証明書（.crt/.cer/.pem）を入力してください。 SSLを有効化したくない場合は、空白のままにしてください。
6. SSLを有効化する場合は、SSL鍵（.key）を入力してください。 そうでない場合は、空白のままにしてください。
7. GitHub Appを作成する際にアプリケーションサーバーに対して使用したURLと同じホスト名を入力してください。
8. インストールの実行には数分かかります。 完了すると、メッセージがターミナルに出力されます。

   Installation complete
   Run /opt/insights/scripts/start.sh to start GitHub Insights
   

9. GitHub Insightsを開始するには、シェルスクリプトの/opt/insights/scripts/start.shを実行してください。
10. GitHub Insightsを起動するのが初めてなら、このスクリプトの実行には数分かかります。 完了すると、メッセージがターミナルに出力されます。

    GitHub Insights is running!
    

GitHub Insights を設定する

GitHub Enterprise Serverに接続するようGitHub Insightsを設定するには、以前のステップで記録した情報が必要になります。

1. ブラウザで<application-server-url>/setupにアクセスしてください。
2. "GitHub API URL"の下で、GitHub Enterpriseにアクセスするのに使うURLを入力してください。
   
3. "GitHub Insights License（GitHub Insightsライセンス）"の下で、"Choose Files（ファイルの選択）"をクリックし、続いてGitHub Enterpriseのライセンスファイルをアップロードしてください。
   
4. "App ID"の下で、アプリケーションを作成したときに記録したGitHub AppのApp IDを入力してください。
   
5. "Client ID"の下で、アプリケーションを作成したときに記録したGitHub AppのClient IDを入力してください。
   
6. "Client Secret（クライアントシークレット）"の下で、アプリケーションを作成したときに記録したGitHub Appのクライアントシークレットを入力してください。
   
7. "Private Key（秘密鍵）"の下で、GitHub Appの秘密鍵を入力してください。この秘密鍵は、アプリケーションの作成時にダウンロードしたPEMファイルに含まれています。
   
8. "Webhook Secret（webhookのシークレット）"の下で、アプリケーションを作成したときに記録したGitHub Appのwebhookシークレットを入力してください。
   
9. インストール時にSSL証明書を手今日しなかった場合は、Skip SSL Certificate Check（SSL証明書のチェックのスキップ）を選択してください。
   
10. [Submit] をクリックします。
11. Log in with GitHub（GitHubでログイン）をクリックしてください。
12. GitHub Appを認可してGitHub Insightsにアクセスするには、 Authorize GitHub App（GitHub Appを認可）をクリックしてください。

参考リンク

• リポジトリの管理
• GitHub InsightsとOrganizationのデータ保護