Skip to main content

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.

For authentication information, see "About authentication with a GitHub App."

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 personal account if the GitHub App is owned by an individual account. Private 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.

    Screenshot of GitHub's account menu showing options for users to view and edit their profile, content, and settings. The menu item "Settings" is outlined in dark orange.

  2. In the left sidebar, click Developer settings.

  3. In the left sidebar, click GitHub Apps. GitHub Apps section

  4. Select the GitHub App whose installation option you want to change.

  5. In the left sidebar, click Advanced.

  6. Depending on the installation option of your GitHub App, click either Make public or Make private.

  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.