GitHub AE is currently under limited release. Please contact our Sales Team to find out more.

Making a GitHub App public or private

When setting up a GitHub App, you can make its installation public so any GitHub user or organization can install the app, or private so you can only install it on the account that created it.

In this article

For authentication information, see "Authenticating with GitHub Apps."

Public installation flow

Public installation flows have a landing page to enable other people besides the app owner to install the app in their repositories. This link is provided in the "Public link" field when setting up your GitHub App. For more information, see "Installing GitHub Apps."

Private installation flow

Private installation flows allow only the owner of a GitHub App to install it. Limited information about the GitHub App will still exist on a public page, but the Install button will only be available to organization administrators or the user account if the GitHub App is owned by an individual account. Private, or internal, GitHub Apps can only be installed on the user or organization account of the owner.

Changing who can install your GitHub App

To change who can install the GitHub App:

  1. In the upper-right corner of any page, click your profile photo, then click Settings. Settings icon in the user bar
  2. In the left sidebar, click Developer settings. Developer settings section
  3. In the left sidebar, click GitHub Apps. GitHub Apps section
  4. Select the GitHub App whose installation option you want to change. App selection
  5. In the left sidebar, click Advanced. Advanced tab
  6. Depending on the installation option of your GitHub App, click either Make public or Make internal. Button to change the installation option of your GitHub App
  7. Depending on the installation option of your GitHub App, click either Yes, make this GitHub App public or Yes, make this GitHub App internal. Button to confirm the change of your installation option

Did this doc help you? Privacy policy

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Make a contribution

Or, learn how to contribute.