Installing GitHub Insights

Vorrausetzungen

• You must have a GitHub Enterprise license file that includes GitHub Insights. After you purchase GitHub Insights, you can download the updated license file in the GitHub Enterprise web portal.

• GitHub Insights erfordert eine Maschine, die als Anwendungsserver bezeichnet wird und entweder in der Cloud oder lokal gehostet wird. For more information, see "System overview for GitHub Insights."

• You must install dependencies on the application server.

  • Docker 1.13.0+
  • Docker Compose v1.17.0+
  • netcat, available via apt for Debian and Ubuntu

  Hinweis: Der Anwendungsserver erfordert möglicherweise, dass der Docker-Daemon als sudo ausgeführt wird. Kubernetes wird nicht unterstützt.

Eine GitHub App erstellen

To connect GitHub Insights to GitHub Enterprise, you must create a GitHub App in an organization on GitHub Enterprise. A slugged version of your app's name will be shown on GitHub Enterprise when your integration takes an action.

1. Melde Dich unter http(s)://HOSTNAME/login bei your GitHub Enterprise Server instance an.

2. Navigate to the organization you'd like to connect to GitHub Insights.

3. Klicke unter Deinem Organisationsnamen auf Settings (Einstellungen).

   

4. Klicke auf der linken Seitenleiste auf GitHub App.

   

5. Click New GitHub App.

   

6. Under "GitHub App name", type a name for the app. Your app cannot have the same name as an existing user or organization, unless the name is your own user or organization name.

   

7. Under "Homepage URL", type the URL of the application server for GitHub Insights. For more information, see "System overview for GitHub Insights."

   

8. Under "User authorization callback URL", type the following, replacing <application-server-url> with the URL of the application server.

   <application-server-url>/public/applogin
   

   

9. Under "Setup URL", type <application-server-url>/public/setup.

   

10. Under "Webhook URL", type <application-server-url>/webhooks.

    

11. Under "Webhook secret", type a secret, then record the secret for later reference.

    

12. Under "Permissions", use the drop-down menus and configure the following permissions for the app.

    • Repository:
      • Contents: Read-only
      • Metadata: Read-only
      • Pull requests: Read-only
      • Commit statuses: Read-only
    • Organisation:
      • Members: Read-only
      • Projects: Read-only
    

13. Under "Subscribe to events", select:

    • Member
    • Pull Request
    • Push
    • Repository
    • Team
      

14. To enable the GitHub App to access data from any user or organization in your GitHub Enterprise Server instance, under "Where can this GitHub App be installed?", select Any account.

    

15. Click Create GitHub App.

    

16. Review your app's configuration.

17. Under "Private keys", click Generate a private key.

    

18. Save the resulting PEM file for later reference.

19. Make note of the following information about your app for later reference.

    • App ID
    • Client ID
    • Client secret
    • Private key
    • Webhook secret

GitHub Insights installieren

1. From the application server, navigate to the latest release of GitHub Insights on the Releases page for github/insights-releases.
2. Um den neuesten Release herunterzuladen, klicke unter „Assets" (Objekte) auf insights-VERSION.tar.gz.
   
3. Entpacke das Verzeichnis.
4. Führe das Shellskript install.sh aus.
5. Um SSL zu aktivieren, gib das SSL-Zertifikat (.crt/.cer/.pem) ein. Wenn Du SSL nicht aktivieren willst, lässt Du es leer.
6. Wenn Du SSL aktivieren möchtest, gibst Du den SSL-Schlüssel (.key) ein. Andernfalls lässt Du es leer.
7. Gib den Hostnamen ein, der dieselbe URL ist, die Du beim Erstellen der GitHub App für den Anwendungsserver verwendet hast.
8. Die Ausführung der Installation dauert einige Minuten. Nach Beendigung wirst Du eine Nachricht auf dem Terminal sehen.

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

9. Um GitHub Insights zu starten, führe das Shellskript /opt/insights/scripts/start.sh aus.
10. Wenn Du GitHub Insights zum ersten Mal startest, dauert die Ausführung des Script einige Minuten. Nach Beendigung wirst Du eine Nachricht auf dem Terminal sehen.

    GitHub Insights is running!
    

GitHub Insights konfigurieren

To configure GitHub Insights to connect to GitHub Enterprise Server, you must provide the information you recorded in previous steps.

1. In your browser, navigate to <application-server-url>/setup.
2. Under "GitHub API URL", type the URL you use to access GitHub Enterprise.
   
3. Klicke unter „GitHub Insights License" (Lizenz) auf „Choose Files" (Dateien Auswählen), dann lade Deine GitHub Enterprise Lizenzdatei.
   
4. Gib unter „App ID" die App-ID Deiner GitHub App ein, die Du beim Erstellen der App erfasst hast.
   
5. Gib unter „Client ID" die Client-ID Deiner GitHub App ein, die Du beim Erstellen der App erfasst hast.
   
6. Unter „Client Secret" gibst Du das Client-Geheimnis Deiner GitHub App ein, das Du beim Erstellen der App erfasst hast.
   
7. Unter "Private Key" (Privater Schlüssel) gibst Du den privaten Schlüssel Deiner GitHub App ein, die in der PEM-Datei vorhanden ist, die Du beim Erstellen der App heruntergeladen hast.
   
8. Gib unter "Webhook Secret" das Webhook-Geheimnis Deiner GitHub App ein, das Du beim Erstellen der App aufgezeichnet hast.
   
9. Wenn Du während der Installation kein SSL-Zertifikat angegeben hast, wähle Skip SSL Certificate Check (SSL-Zertifikatsprüfung überspringen).
   
10. Klicke auf Submit (Einreichen).
11. Click Log in with GitHub.
12. To authorize the GitHub App and access GitHub Insights, click Authorize GitHub App.

Weiterführende Informationen

• "Managing repositories"
• "GitHub Insights and data protection for your organization"