Skip to main content

Making a GitHub App public or private

When registering a GitHub App, you can make it public so that other GitHub users or organizations can install the app, or private so that you can only install it on the account that owns the app.

About visibility for GitHub Apps

You can make your GitHub App registration public or private. If you set your GitHub App registration to public, anyone on your GitHub Enterprise Server instance can install it, but the app is not available outside of your instance. If you set your GitHub App registration to private, it can only be installed on the account that owns the app.

If you want to make your app available to other GitHub Enterprise Server instances, then you need to take additional steps. For more information, see "Making your GitHub App available for GitHub Enterprise Server."

If it is important for other GitHub Enterprise Server users to be able to use your tool, consider using GitHub Actions instead of a GitHub App. Public actions are available on GitHub Enterprise Server instances with GitHub Connect. For more information, see "Enabling automatic access to GitHub.com actions using GitHub Connect" and "About GitHub Actions for enterprises."

For information about changing the visibility of a GitHub App registration, see "Modifying a GitHub App registration."

Public installation flow

Public GitHub Apps have a landing page with an Install button, so that other people can install the app in their repositories.

Private installation flow

Private GitHub Apps can only be installed on the user or organization account of the app owner. Limited information about the app will exist on a landing page for the app, but the Install button will only be available to organization owners and app managers for the organization that owns the app, or the personal account if the GitHub App is owned by an individual account.