77 lines
6.3 KiB
Markdown
77 lines
6.3 KiB
Markdown
---
|
||
title: Installing a GitHub App from a third party
|
||
intro: 'You can install {% data variables.product.prodname_github_apps %} directly from the app owner to use on your account.'
|
||
versions:
|
||
fpt: '*'
|
||
ghec: '*'
|
||
ghes: '*'
|
||
shortTitle: Install from third party
|
||
---
|
||
|
||
{% ifversion ghes < 3.16 %}
|
||
|
||
You cannot install third-party {% data variables.product.prodname_github_apps %} on organizations owned by your instance. If you want to use the functionality of a third-party {% data variables.product.prodname_github_app %}, you can contact the app developer about making the {% data variables.product.prodname_github_app %} available for {% data variables.product.prodname_ghe_server %}. For more information, see [AUTOTITLE](/apps/sharing-github-apps/making-your-github-app-available-for-github-enterprise-server).
|
||
|
||
For more information about installing {% data variables.product.prodname_github_apps %} that you own, see [AUTOTITLE](/apps/maintaining-github-apps/installing-your-own-github-app).
|
||
|
||
{% else %}
|
||
|
||
## About installing {% data variables.product.prodname_github_apps %}
|
||
|
||
{% ifversion fpt or ghec %}
|
||
|
||
This article describes how to install a {% data variables.product.prodname_github_app %} directly from the app owner instead of from {% data variables.product.prodname_marketplace %}. For more information on installing {% data variables.product.prodname_github_apps %} from {% data variables.product.prodname_marketplace %}, see [AUTOTITLE](/apps/using-github-apps/installing-a-github-app-in-your-personal-account) and [AUTOTITLE](/apps/using-github-apps/installing-a-github-app-in-your-organization). For more information about installing {% data variables.product.prodname_github_apps %} that you own, see [AUTOTITLE](/apps/maintaining-github-apps/installing-your-own-github-app).{% endif %}
|
||
|
||
{% ifversion enterprise-apps-public-beta %}
|
||
>[!NOTE] This installation flow applies to any {% data variables.product.prodname_github_app %}, whether it’s a third-party app or an app owned by your enterprise. You can install the app manually using the link provided by the app owner.
|
||
{% endif %}
|
||
|
||
{% data reusables.apps.about-installation %}
|
||
|
||
### Difference between installation and authorization
|
||
|
||
After you install a {% data variables.product.prodname_github_app %}, you may also be asked to authorize the app.
|
||
|
||
{% data reusables.apps.install-vs-authorize %}
|
||
|
||
For more information about authorizing {% data variables.product.prodname_github_apps %}, see [AUTOTITLE](/apps/using-github-apps/authorizing-github-apps).
|
||
|
||
## Requirements to install a {% data variables.product.prodname_github_app %}
|
||
|
||
Anyone can install {% data variables.product.prodname_github_apps %} on their personal account{% ifversion ghec %}, unless they are an {% data variables.product.prodname_emu %}{% endif %}.
|
||
|
||
Organization owners can install {% data variables.product.prodname_github_apps %} on their organization.{% ifversion enterprise-installed-apps %}
|
||
|
||
Enterprise owners can install {% data variables.product.prodname_github_apps %} on their enterprise accounts, if the application requests enterprise permissions and is owned by the enterprise or one of its organizations.
|
||
{% endif %}
|
||
|
||
{% data reusables.apps.repo-admin-install-restriction %}
|
||
|
||
Organization members and outside collaborators that cannot install an app on the organization can still select the organization during the install process. Instead of installing the app, {% data variables.product.company_short %} will send a notification to the organization owner to request the organization owner to install the app. The ability to make these requests can be controlled using app access request policies. See [AUTOTITLE](/organizations/managing-programmatic-access-to-your-organization/limiting-oauth-app-and-github-app-access-requests).
|
||
|
||
The "app manager" role does not give a person the ability to install a {% data variables.product.prodname_github_app %} on the organization{% ifversion enterprise-app-manager %} or enterprise{% endif %}. See [AUTOTITLE](/apps/maintaining-github-apps/about-github-app-managers).
|
||
|
||
## Installing a {% data variables.product.prodname_github_app %}
|
||
|
||
During the installation process, the app owner will direct you to a {% data variables.product.company_short %} URL to install the {% data variables.product.prodname_github_app %}. The URL will look something like `{% data variables.product.oauth_host_code %}/{% ifversion ghes %}github-apps{% else %}apps{% endif %}/APP-NAME/installations/new`, where `APP-NAME` is the name of the {% data variables.product.prodname_github_app %}.
|
||
|
||
1. Select the location where you want to install the {% data variables.product.prodname_github_app %}. You can select your personal account or an organization that you are a member of.{% ifversion enterprise-installed-apps %} If you are an enterprise owner, you can also choose to install the app on your enterprise, if the app supports enterprises.{% endif %}
|
||
|
||
{% ifversion ghec %}
|
||
|
||
> [!NOTE]
|
||
> {% data reusables.apps.github_app_install_saml %}
|
||
|
||
{% endif %}
|
||
|
||
1. If the app requires repository permissions, select **All repositories** or **Only select repositories**. The app will always have at least read-only access to all public repositories on {% data variables.product.company_short %}.
|
||
|
||
If the app does not require repository permissions, these options will be omitted.
|
||
1. If you selected **Only select repositories** in the previous step, under the **Select repositories** dropdown, select the repositories that you want the app to access.
|
||
|
||
If the app creates any repositories, the app will automatically be granted access to those repositories as well.
|
||
1. Review the permissions that the app is requesting. For more information about the REST API requests the {% data variables.product.prodname_github_app %} can make with those permissions, see [AUTOTITLE](/rest/overview/permissions-required-for-github-apps).
|
||
1. Click **Install**, **Install and request**, or **Request**. The button that is presented depends on whether your organization owner must approve none, some, or all of the requested access for the app.{% ifversion enterprise-installed-apps %} Enterprise installations cannot be requested—the enterprise owner must install the app directly.{% endif %} For more information, see [Requirements to install a {% data variables.product.prodname_github_app %}](#requirements-to-install-a-github-app).
|
||
|
||
{% endif %}
|