必要な環境
-
GitHub Insightsを含むGitHub Enterpriseのライセンスファイルを持っていなければなりません。 GitHub Insightsの購入後、更新されたライセンスファイルをGitHub Enterprise Webポータルでダウンロードできます。
-
GitHub Insightsは、アプリケーションサーバーと呼ばれるマシンを必要とします。これは、クラウドでもローカルでもホストできます。 詳しい情報については「GitHub Insightsのシステム概要」を参照してください。
-
アプリケーションサーバーに依存関係をインストールしなければなりません。
- Docker 1.13.0+
- Docker Compose v1.17.0+
- netcat、Debian および Ubuntu 用の apt 経由で入手可能
ノート: アプリケーションサーバーでは、Dockerデーモンをsudoとして実行させる必要があるかもしれません。 Kubernetesはサポートされていません。
GitHub Appの作成
GitHub InsightsをGitHub Enterpriseに接続するには、GitHub Enterprise上のOrganization内にGitHub Appを作成しなければなりません。 インテグレーションが動作すると、GitHub Enterprise上にアプリケーションのスラッグバージョンの名前が表示されます。
-
http(s)://HOSTNAME/login
でGitHub Enterprise Serverのインスタンスにサインインしてください。 -
GitHub Insightsに接続したいOrganizationにアクセスしてください。
-
Organization名の下で、Settings(設定)をクリックしてください。
-
左サイドバーで [GitHub Apps] をクリックします。
-
New GitHub App(新規GitHub App)をクリックしてください。
-
"GitHub App name(GitHub App名)"の下で、アプリケーションの名前を入力してください。 アプリケーションの名前は、その名前があなた自身のユーザ名やOrganization名でないかぎり、既存のユーザやOrganizationと同じ名前になってはいけません。
-
"Homepage URL(ホームページのURL)"の下に、GitHub InsightsのアプリケーションサーバーのURLを入力してください。 詳しい情報については「GitHub Insightsのシステム概要」を参照してください。
-
""User authorization callback URL(ユーザ認証のコールバックURL)"の下で、以下の
<application-server-url>
をアプリケーションサーバーのURLで置き換えて入力してください。<application-server-url>/public/applogin
-
"Setup URL(セットアップURL)"の下で、
<application-server-url>/public/setup
と入力してください。 -
"Webhook URL"の下で、
<application-server-url>/webhooks
と入力してください。 -
"Webhook secret(Webhookのシークレット)"の下で、シークレットを入力し、後に参照するためにそのシークレットを記録しておいてください。
-
"Permissions(権限)"の下で、ドロップダウンメニューを使ってアプリケーションに以下の権限を設定してください。
- リポジトリ:
- Contents: Read-only
- Metadata: Read-only
- Pull requests: Read-only
- Pull requests: Read-only
- Organization:
- Members: Read-only
- Projects: Read-only
- リポジトリ:
-
"Subscribe to events(イベントのサブスクライブ)"の下で、以下を選択してください。
- Member
- プルリクエスト
- Push
- Repository
- Team
-
GitHub Enterprise Serverのインスタンス内の任意のユーザあるいはOrganizationからのデータにGitHub Appがアクセスできるようにするために、"Where can this GitHub App be installed?(このGitHub Appはどこにインストールできますか?)"の下で、Any account(任意のアカウント)を選択してください。
-
Create GitHub App(GitHub Appの作成)をクリックしてください。
-
アプリケーションの設定をレビューしてください。
-
"Private keys(秘密鍵)"の下で、Generate a private key(秘密鍵の生成)をクリックしてください。
-
生成されたPEMファイルを、後で使うために保存してください。
-
アプリケーションに関する以下の情報を、後で参照できるよう記録しておいてください。
- App ID(アプリケーションID)
- Client ID(クライアントID)
- Client secret(クライアントシークレット)
- Private key(秘密鍵)
- Webhook secret(Webhookシークレット)
GitHub Insightsのインストール
- アプリケーションサーバーから、
github/insights-releases
のリリースページ上の最新のGitHub Insightsリリースにアクセスしてください。 - 最新のリリースをダウンロードするために、"Assets(アセット)"の下の
insights-VERSION.tar.gz
をクリックしてください。 - ディレクトリをUnzipしてください。
- シェルスクリプトの
install.sh
を実行してください。 - SSLを有効化するためにSSL証明書(
.crt/.cer/.pem
)を入力してください。 SSLを有効化したくない場合は、空白のままにしてください。 - SSLを有効化する場合は、SSL鍵(
.key
)を入力してください。 そうでない場合は、空白のままにしてください。 - GitHub Appを作成する際にアプリケーションサーバーに対して使用したURLと同じホスト名を入力してください。
- インストールの実行には数分かかります。 完了すると、メッセージがターミナルに出力されます。
Installation complete Run /opt/insights/scripts/start.sh to start GitHub Insights
- GitHub Insightsを開始するには、シェルスクリプトの
/opt/insights/scripts/start.sh
を実行してください。 - GitHub Insightsを起動するのが初めてなら、このスクリプトの実行には数分かかります。 完了すると、メッセージがターミナルに出力されます。
GitHub Insights is running!
GitHub Insights を設定する
GitHub Enterprise Serverに接続するようGitHub Insightsを設定するには、以前のステップで記録した情報が必要になります。
- ブラウザで
<application-server-url>/setup
にアクセスしてください。 - "GitHub API URL"の下で、 GitHub EnterpriseにアクセスするためのURLを入力してください。
- "GitHub Insights License(GitHub Insightsライセンス)"の下で、"Choose Files(ファイルの選択)"をクリックし、続いてGitHub Enterpriseのライセンスファイルをアップロードしてください。
- "App ID"の下で、アプリケーションを作成したときに記録したGitHub AppのApp IDを入力してください。
- "Client ID"の下で、アプリケーションを作成したときに記録したGitHub AppのClient IDを入力してください。
- "Client Secret(クライアントシークレット)"の下で、アプリケーションを作成したときに記録したGitHub Appのクライアントシークレットを入力してください。
- "Private Key(秘密鍵)"の下で、GitHub Appの秘密鍵を入力してください。この秘密鍵は、アプリケーションの作成時にダウンロードしたPEMファイルに含まれています。
- "Webhook Secret(webhookのシークレット)"の下で、アプリケーションを作成したときに記録したGitHub Appのwebhookシークレットを入力してください。
- インストール時にSSL証明書を手今日しなかった場合は、Skip SSL Certificate Check(SSL証明書のチェックのスキップ)を選択してください。
- Submit(サブミット)をクリックしてください。
- Log in with GitHub(GitHubでログイン)をクリックしてください。
- GitHub Appを認可してGitHub Insightsにアクセスするには、 Authorize GitHub App(GitHub Appを認可)をクリックしてください。