docs/content/insights/installing-and-configuring-github-insights/installing-github-insights.md

title, intro, product, redirect_from, permissions, versions

title	intro	product	redirect_from	permissions	versions
Installing GitHub Insights	You can install {{ site.data.variables.product.prodname_insights }} and connect the standalone application to {{ site.data.variables.product.prodname_ghe_server }}.	{{ site.data.reusables.gated-features.github-insights }}	/github/installing-and-configuring-github-insights/installing-github-insights	Organization owners in {{ site.data.variables.product.prodname_enterprise }} with read permissions to the `github/insights-releases` repository and administrative access to the application server can install {{ site.data.variables.product.prodname_insights }}.	enterprise-server *

Prerequisites

• You must have a {{ site.data.variables.product.prodname_enterprise }} license file that includes {{ site.data.variables.product.prodname_insights }}. After you purchase {{ site.data.variables.product.prodname_insights }}, you can download the updated license file in the {{ site.data.variables.product.prodname_enterprise }} web portal.

• {{ site.data.reusables.github-insights.requires-machine }} For more information, see "System overview for {{ site.data.variables.product.prodname_insights }}."

• You must install dependencies on the application server.

  • Docker 1.13.0+
  • Docker Compose v1.17.0+

  {% note %}

  Note: {{ site.data.reusables.github-insights.docker-requirements }}

  {% endnote %}

Creating a {{ site.data.variables.product.prodname_github_app }}

To connect {{ site.data.variables.product.prodname_insights }} to {{ site.data.variables.product.prodname_enterprise }}, you must create a {{ site.data.variables.product.prodname_github_app }} in an organization on {{ site.data.variables.product.prodname_enterprise }}. A slugged version of your app's name will be shown on {{ site.data.variables.product.prodname_enterprise }} when your integration takes an action.

{{ site.data.reusables.enterprise_site_admin_settings.sign-in }} 2. Navigate to the organization you'd like to connect to {{ site.data.variables.product.prodname_insights }}. {{ site.data.reusables.organizations.org_settings }} {{ site.data.reusables.organizations.github-apps-settings-sidebar }} 5. Click New {{ site.data.variables.product.prodname_github_app }}. 6. Under "{{ site.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 {{ site.data.variables.product.prodname_insights }}. For more information, see "System overview for {{ site.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

13. To enable the {{ site.data.variables.product.prodname_github_app }} to access data from any user or organization in {{ site.data.variables.product.product_location_enterprise }}, under "Where can this {{ site.data.variables.product.prodname_github_app }} be installed?", select Any account.
14. Click Create {{ site.data.variables.product.prodname_github_app }}.
15. Review your app's configuration.
16. Under "Private keys", click Generate a private key.
17. Save the resulting PEM file for later reference.
18. Make note of the following information about your app for later reference.
    • App ID
    • Client ID
    • Client secret
    • Private key
    • Webhook secret

Installing {{ site.data.variables.product.prodname_insights }}

{{ site.data.reusables.github-insights.download-latest-release }} {{ site.data.reusables.github-insights.install-script }} {{ site.data.reusables.github-insights.run-script }}

Configuring {{ site.data.variables.product.prodname_insights }}

To configure {{ site.data.variables.product.prodname_insights }} to connect to {{ site.data.variables.product.prodname_ghe_server }}, you must provide the information you recorded in previous steps.

1. In your browser, navigate to <application-server-url>/setup. {{ site.data.reusables.github-insights.enterprise-api-url }} {{ site.data.reusables.github-insights.insights-license }} {{ site.data.reusables.github-insights.app-id }} {{ site.data.reusables.github-insights.client-id }} {{ site.data.reusables.github-insights.client-secret }} {{ site.data.reusables.github-insights.private-key }} {{ site.data.reusables.github-insights.webhook-secret }} {{ site.data.reusables.github-insights.skip-ssl }}
2. Click Submit.
3. Click Log in with {{ site.data.variables.product.prodname_dotcom }}.
4. To authorize the {{ site.data.variables.product.prodname_github_app }} and access {{ site.data.variables.product.prodname_insights }}, click Authorize {{ site.data.variables.product.prodname_github_app }}.

Further reading

• "Managing repositories"
• "{{ site.data.variables.product.prodname_insights }} and data protection for your organization"