Sharing your GitHub App

Sharing your GitHub App via an install link

1. In the upper-right corner of any page on GitHub, click your profile photo.

2. Navigate to your account settings.

   • For an app owned by a personal account, click Settings.
   • For an app owned by an organization:
     1. Click Your organizations.
     2. To the right of the organization, click Settings.

3. In the left sidebar, click Developer settings.

4. In the left sidebar, click GitHub Apps.

5. Next to the GitHub App that you want to share, click Edit.

6. Click Public page. GitHub will bring you to the public page for your GitHub App.

7. Click Install. GitHub will bring you to the installation URL for your GitHub App. The URL will look something like http(s)://HOSTNAME/github-apps/APP-NAME/installations/new, where APP-NAME is the name of the GitHub App.

8. Share the installation URL with other users. For more information about how users can install your app from this URL, see Installing a GitHub App from a third party.

   When you share the URL, you can include a state query parameter in the installation URL to preserve the state of the application page and return people back to that state after they install, authenticate, or accept updates to your GitHub App. For example, you could use the state to correlate an installation to a user or account.

   To preserve a state, add it to the installation URL: http(s)://HOSTNAME/github-apps/<app name>/installations/new?state=AB12t

Sharing your GitHub App with GitHub Enterprise Server instances

If you want to share your GitHub App with GitHub Enterprise Server instances that you are not part of, you need to take additional steps. For more information, see Making your GitHub App available for GitHub Enterprise Server.