Sharing your GitHub App

You can share your GitHub App with other users.

In this article

Sharing your GitHub App on GitHub Marketplace

If your GitHub App is public, you can choose to publish it to GitHub Marketplace. For more information, see "About GitHub Marketplace for apps."

If you are an Enterprise Managed User, then you cannot share your app on GitHub Marketplace.

For more information about how users can install your app from GitHub Marketplace, see "Installing a GitHub App from GitHub Marketplace for your organizations" and "Installing a GitHub App from GitHub Marketplace for your personal account."

If your GitHub App is public, other users and organizations within your enterprise can install your app. For more information about making your app public, see "Making a GitHub App public or private."

If you are an Enterprise Managed User, you can only share your app with users or organizations within your enterprise.

  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.
    • For an app owned by an enterprise:
      1. If you use Enterprise Managed Users, click Your enterprise to go directly to the enterprise account settings.
      2. If you use personal accounts, click Your enterprises and then to the right of the enterprise, click Settings.

  3. Navigate to the GitHub App settings.

    • For an app owned by a personal account or organization:
      1. In the left sidebar, click Developer settings, then click GitHub Apps.
    • For an app owned by an enterprise:
      1. In the left sidebar, under "Settings", click GitHub Apps.

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

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

  6. Click Install. GitHub will bring you to the installation URL for your GitHub App. The URL will look something like https://github.com/apps/APP-NAME/installations/new, where APP-NAME is the name of the GitHub App.

  7. 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: https://github.com/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."