7.3 KiB
title, intro, redirect_from, permissions, versions, shortTitle
| title | intro | redirect_from | permissions | versions | shortTitle | ||||
|---|---|---|---|---|---|---|---|---|---|
| Installing GitHub Insights | You can install {% data variables.product.prodname_insights %} and connect the standalone application to {% data variables.product.prodname_ghe_server %}. |
|
Organization owners in {% data variables.product.prodname_enterprise %} with read permissions to the `github/insights-releases` repository and administrative access to the application server can install {% data variables.product.prodname_insights %}. |
|
Install GitHub Insights |
Prerequisites
-
You must have a {% data variables.product.prodname_enterprise %} license file that includes {% data variables.product.prodname_insights %}. After you purchase {% data variables.product.prodname_insights %}, you can download the updated license file in the {% data variables.product.prodname_enterprise %} web portal.
-
{% data reusables.github-insights.requires-machine %} For more information, see "System overview for {% data variables.product.prodname_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
{% note %}
Note: {% data reusables.github-insights.docker-requirements %}
{% endnote %}
Creating a {% data variables.product.prodname_github_app %}
To connect {% data variables.product.prodname_insights %} to {% data variables.product.prodname_enterprise %}, you must create a {% data variables.product.prodname_github_app %} in an organization on {% data variables.product.prodname_enterprise %}. A slugged version of your app's name will be shown on {% data variables.product.prodname_enterprise %} when your integration takes an action.
{% data reusables.enterprise_site_admin_settings.sign-in %}
2. Navigate to the organization you'd like to connect to {% data variables.product.prodname_insights %}.
{% data reusables.organizations.org_settings %}
{% data reusables.organizations.github-apps-settings-sidebar %}
5. Click New {% data variables.product.prodname_github_app %}.
6. Under "{% data variables.product.prodname_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 {% data variables.product.prodname_insights %}. For more information, see "System overview for {% data variables.product.prodname_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.
9. Under "Webhook URL", type <application-server-url>/webhooks.
10. Under "Webhook secret", type a secret, then record the secret for later reference.
11. 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
- Organization:
- Members: Read-only
- Projects: Read-only
12. Under "Subscribe to events", select:
- Member
- Pull request
- Push
- Repository
- Team
- To enable the {% data variables.product.prodname_github_app %} to access data from any user or organization in {% data variables.product.product_location %}, under "Where can this {% data variables.product.prodname_github_app %} be installed?", select Any account.
- Click Create {% data variables.product.prodname_github_app %}.
- Review your app's configuration.
- Under "Private keys", click Generate a private key.
- Save the resulting PEM file for later reference.
- Make note of the following information about your app for later reference.
- App ID
- Client ID
- Client secret
- Private key
- Webhook secret
Installing {% data variables.product.prodname_insights %}
{% data reusables.github-insights.download-latest-release %} {% data reusables.github-insights.install-script %} {% data reusables.github-insights.run-script %}
Configuring {% data variables.product.prodname_insights %}
To configure {% data variables.product.prodname_insights %} to connect to {% data variables.product.prodname_ghe_server %}, you must provide the information you recorded in previous steps.
- In your browser, navigate to
<application-server-url>/setup. {% data reusables.github-insights.enterprise-api-url %} {% data reusables.github-insights.insights-license %} {% data reusables.github-insights.app-id %} {% data reusables.github-insights.client-id %} {% data reusables.github-insights.client-secret %} {% data reusables.github-insights.private-key %} {% data reusables.github-insights.webhook-secret %} {% data reusables.github-insights.skip-ssl %} - Click Submit.
- Click Log in with {% data variables.product.prodname_dotcom %}.
- To authorize the {% data variables.product.prodname_github_app %} and access {% data variables.product.prodname_insights %}, click Authorize {% data variables.product.prodname_github_app %}.