Skip to content

Commit 2a66cec

Browse files
authored
Merge branch 'main' into repo-sync
2 parents 1494b91 + 1724a15 commit 2a66cec

File tree

3 files changed

+21
-16
lines changed

3 files changed

+21
-16
lines changed
Lines changed: 20 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Making a GitHub App public or private
3-
intro: '{% data reusables.shortdesc.making-a-github-app-public-or-private %}'
3+
intro: 'When setting up a {% data variables.product.prodname_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.'
44
redirect_from:
55
- /apps/building-integrations/setting-up-and-registering-github-apps/about-installation-options-for-github-apps
66
- /apps/building-github-apps/installation-options-for-github-apps
@@ -18,24 +18,29 @@ topics:
1818
- GitHub Apps
1919
shortTitle: Manage app visibility
2020
---
21-
For authentication information, see "[AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/about-authentication-with-a-github-app)."
2221

23-
## Public installation flow
22+
## About visibility for {% data variables.product.prodname_github_app %}s
2423

25-
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 "[AUTOTITLE](/apps/maintaining-github-apps/installing-github-apps)."
24+
You can make your {% data variables.product.prodname_github_app %} public or private. {% ifversion fpt %}If you set your {% data variables.product.prodname_github_app %} to public, any user on {% data variables.product.prodname_dotcom_the_website %} or {% data variables.product.prodname_ghe_cloud %} can install it. If you set your {% data variables.product.prodname_github_app %} to private, it can only be installed on the account that owns the app.
2625

27-
## Private installation flow
26+
{% elsif ghes %}If you set your {% data variables.product.prodname_github_app %} to public, anyone on your {% data variables.product.prodname_ghe_server %} instance can install it, but the app is not available outside of your instance. If you set your {% data variables.product.prodname_github_app %} to private, it can only be installed on the account that owns the app.
2827

29-
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.
28+
{% elsif ghec %}If you set your {% data variables.product.prodname_github_app %} to public, and the {% data variables.product.prodname_github_app %} is owned by an {% data variables.product.prodname_emu %} account, accounts owned by your enterprise can install it, but the app cannot be installed on accounts outside of your enterprise. If a {% data variables.product.prodname_github_app %} is owned by an account that is not an {% data variables.product.prodname_emu %}, and the app is set to public, any user on {% data variables.product.prodname_dotcom_the_website %} or {% data variables.product.prodname_ghe_cloud %} can install the app. If you set your {% data variables.product.prodname_github_app %} to private, it can only be installed on the account that owns the app.{% endif %}
3029

31-
## Changing who can install your GitHub App
30+
{% ifversion fpt or ghec %}You can create a {% data variables.product.prodname_github_app %} from your individual user account and make it available for organization accounts to install. You do not need an enterprise plan or an organization account to create a {% data variables.product.prodname_github_app %} for organizations even if the organization is owned by an enterprise on {% data variables.product.prodname_ghe_cloud %}.{% endif %}
3231

33-
To change who can install the GitHub App:
32+
If you want to make your app available to {% ifversion ghes %}other {% endif %}{% data variables.product.prodname_ghe_server %} instances, then you need to use an app manifest. The {% data variables.product.prodname_ghe_server %} instance will create the app from the manifest and provide you with the required information. For more information, see "[AUTOTITLE](/developers/apps/building-github-apps/creating-a-github-app-from-a-manifest)."
3433

35-
{% data reusables.user-settings.access_settings %}
36-
{% data reusables.user-settings.developer_settings %}
37-
{% data reusables.user-settings.github_apps %}
38-
3. Select the GitHub App whose installation option you want to change.
39-
{% data reusables.user-settings.github_apps_advanced %}
40-
5. Depending on the installation option of your GitHub App, click either **Make public** or **Make private**.
41-
6. Depending on the installation option of your GitHub App, click either **Yes, make this GitHub App public** or **Yes, make this GitHub App {% ifversion fpt or ghec %}internal{% else %}private{% endif %}**.
34+
If it is important for {% ifversion ghes %}other {% endif %}{% data variables.product.prodname_ghe_server %} users to be able to use your tool, consider using {% data variables.product.prodname_actions %} instead of a {% data variables.product.prodname_github_app %}. Public actions are available on {% data variables.product.prodname_ghe_server %} instances with GitHub Connect. For more information, see "[AUTOTITLE](/github-ae@latest/admin/github-actions/managing-access-to-actions-from-githubcom/enabling-automatic-access-to-githubcom-actions-using-github-connect)" and "[AUTOTITLE](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/about-github-actions-for-enterprises)."
35+
36+
For information about changing the visibility of an existing {% data variables.product.prodname_github_app %}, see "[AUTOTITLE](/apps/maintaining-github-apps/modifying-a-github-app)."
37+
38+
### Public installation flow
39+
40+
Public {% data variables.product.prodname_github_apps %} have a landing page with an **Install** button, so that other people can install the app in their repositories. If you don't want to use the default landing page, you can modify the "Public link" field on the settings page for your {% data variables.product.prodname_github_app %}. For more information, see "[AUTOTITLE](/apps/maintaining-github-apps/modifying-a-github-app)."
41+
42+
{% ifversion fpt or ghec %}If your {% data variables.product.prodname_github_app %} is public to all users on {% data variables.product.prodname_dotcom_the_website %}, you can also choose to publish it to {% data variables.product.prodname_marketplace %}. For more information, see "[AUTOTITLE](/apps/publishing-apps-to-github-marketplace/github-marketplace-overview/about-github-marketplace)."{% endif %}
43+
44+
### Private installation flow
45+
46+
Private {% data variables.product.prodname_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 {% data variables.product.prodname_github_app %} is owned by an individual account.

data/reusables/shortdesc/making-a-github-app-public-or-private.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

data/variables/product.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,7 @@ prodname_discussions: 'GitHub Discussions'
138138
prodname_emu_idp_application: 'GitHub Enterprise Managed User'
139139
prodname_emu_idp_oidc_application: 'GitHub Enterprise Managed User (OIDC)'
140140
prodname_emus: 'Enterprise Managed Users'
141+
prodname_emu: 'Enterprise Managed User'
141142

142143
# GitHub Issues
143144
prodname_github_issues: 'GitHub Issues'

0 commit comments

Comments
 (0)