update content about github app installation (#36783)
This commit is contained in:
Sarah Edwards
@@ -29,11 +29,7 @@ You can review and revoke your authorization at any time. For more information,
|
||||
|
||||
## Difference between authorization and installation
|
||||
|
||||
When you install a {% data variables.product.prodname_github_app %} on your account or organization, you grant the app permission to access the organization and repository resources that it requested. You also specify which repositories the app can access.
|
||||
|
||||
When you authorize a {% data variables.product.prodname_github_app %} you grant the app access to your GitHub account, based on the account permissions the app requested. You also grant the app permission to act on your behalf.
|
||||
|
||||
You can install a {% data variables.product.prodname_github_app %} without authorizing the app. Similarly, you can authorize the app without installing the app.
|
||||
{% data reusables.apps.install-vs-authorize %}
|
||||
|
||||
For more information about installation, see {% ifversion ghec or fpt %}"[AUTOTITLE](/apps/using-github-apps/installing-an-app-in-your-personal-account)" and "[AUTOTITLE](/apps/using-github-apps/installing-an-app-in-your-organization)."{% else %}"[AUTOTITLE](/apps/maintaining-github-apps/installing-github-apps)."{% endif %}
|
||||
|
||||
|
||||
@@ -13,8 +13,9 @@ versions:
|
||||
shortTitle: 'Using {% data variables.product.prodname_github_apps %}'
|
||||
children:
|
||||
- /about-using-github-apps
|
||||
- /installing-a-github-app-in-your-personal-account
|
||||
- /installing-a-github-app-in-your-organization
|
||||
- /installing-a-github-app-from-github-marketplace-for-your-personal-account
|
||||
- /installing-a-github-app-from-github-marketplace-for-your-organizations
|
||||
- /installing-a-github-app-from-a-third-party
|
||||
- /authorizing-github-apps
|
||||
- /reviewing-and-revoking-authorization-of-github-apps
|
||||
- /approving-updated-permissions-for-a-github-app
|
||||
|
||||
@@ -0,0 +1,62 @@
|
||||
---
|
||||
title: Installing a GitHub App from a third party
|
||||
intro: 'You can install {% data variables.product.prodname_github_app %}s directly from the app owner to use on your personal account or organizations.'
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
ghae: '*'
|
||||
ghes: '*'
|
||||
shortTitle: Install from third party
|
||||
---
|
||||
|
||||
{% ifversion ghes or ghae %}
|
||||
|
||||
You cannot install third-party {% data variables.product.prodname_github_app %}s on organizations owned by your enterprise. If you want to use the functionality of a third-party {% data variables.product.prodname_github_app %}, you can contact the app developer about creating an app from a manifest or from URL parameters. For more information, see "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest)" and "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-using-url-parameters)." Once you create the {% data variables.product.prodname_github_app %} from the manifest or URL parameters, you will install your app and share your app credentials with the third party.
|
||||
|
||||
For more information about installing {% data variables.product.prodname_github_app %}s that you own, see "[AUTOTITLE](/apps/maintaining-github-apps/installing-your-own-github-app)."
|
||||
|
||||
{% else %}
|
||||
|
||||
## About installing {% data variables.product.prodname_github_app %}s
|
||||
|
||||
{% ifversion ghec or fpt %}
|
||||
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_app %}s 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)."
|
||||
{% 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_app %}s, 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_app %}s on their personal account.
|
||||
|
||||
Organization owners can install {% data variables.product.prodname_github_app %}s on their organization.
|
||||
|
||||
Admins of repositories that are owned by an organization can also install {% data variables.product.prodname_github_app %}s on the organization if they only grant the app access to repositories that they are an admin of and if the app does not request any organization resources. Organization owners can prevent outside collaborators who are repository admins from installing {% data variables.product.prodname_github_app %}s.
|
||||
|
||||
Organization members who are not organization owners or repository admins 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 "app manager" role in an organization does not give a person the ability to install a {% data variables.product.prodname_github_app %} in the organization. For more information, 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 or ghae %}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.
|
||||
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 some or all of the requested access for the app.
|
||||
|
||||
{% endif %}
|
||||
@@ -0,0 +1,67 @@
|
||||
---
|
||||
title: Installing a GitHub App from GitHub Marketplace for your organizations
|
||||
intro: >-
|
||||
You can install {% data variables.product.prodname_github_app %}s from {% data
|
||||
variables.product.prodname_marketplace %} to use on your organizations.
|
||||
redirect_from:
|
||||
- /articles/installing-an-app-in-your-organization
|
||||
- /github/customizing-your-github-workflow/installing-an-app-in-your-organization
|
||||
- /github/customizing-your-github-workflow/purchasing-and-installing-apps-in-github-marketplace/installing-an-app-in-your-organization
|
||||
- /get-started/customizing-your-github-workflow/purchasing-and-installing-apps-in-github-marketplace/installing-an-app-in-your-organization
|
||||
- /apps/using-github-apps/installing-an-app-in-your-organization
|
||||
- /apps/using-github-apps/installing-a-github-app-in-your-organization
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
shortTitle: Install from Marketplace for org
|
||||
---
|
||||
|
||||
## About {% data variables.product.prodname_marketplace %}
|
||||
|
||||
This article applies to installing and purchasing {% data variables.product.prodname_github_app %}s from {% data variables.product.prodname_marketplace %}. For more information on installing {% data variables.product.prodname_github_app %}s from a source other than {% data variables.product.prodname_marketplace %}, see "[AUTOTITLE](/apps/using-github-apps/installing-a-github-app-from-a-third-party)."
|
||||
|
||||
If you install a {% data variables.product.prodname_github_app %} on your organization account and you choose a paid plan, you will pay for your app subscription on your organization's current billing date using your organization's existing payment method.
|
||||
|
||||
{% data reusables.marketplace.free-trials %}
|
||||
|
||||
For more information about installing an {% data variables.product.prodname_oauth_app %} from {% data variables.product.prodname_marketplace %}, see "[AUTOTITLE](/apps/oauth-apps/using-oauth-apps/installing-an-oauth-app-in-your-organization)."
|
||||
|
||||
## About installing {% data variables.product.prodname_github_app %}s
|
||||
|
||||
{% 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_app %}s, see "[AUTOTITLE](/apps/using-github-apps/authorizing-github-apps)."
|
||||
|
||||
## Requirements to install a {% data variables.product.prodname_github_app %} on an organization
|
||||
|
||||
Organization owners can install {% data variables.product.prodname_github_app %}s on their organization.
|
||||
|
||||
Admins of repositories that are owned by an organization can also install {% data variables.product.prodname_github_app %}s on the organization if they only grant the app access to repositories that they are an admin of and if the app does not request any organization resources. Organization owners can prevent outside collaborators who are repository admins from installing {% data variables.product.prodname_github_app %}s.
|
||||
|
||||
The "app manager" role in an organization does not give a person the ability to install a {% data variables.product.prodname_github_app %} in the organization. For more information, see "[AUTOTITLE](/apps/maintaining-github-apps/about-github-app-managers)."
|
||||
|
||||
## Installing a {% data variables.product.prodname_github_app %} in your organization
|
||||
|
||||
{% data reusables.marketplace.visit-marketplace %}
|
||||
{% data reusables.marketplace.browse-to-app %}
|
||||
{% data reusables.marketplace.choose-plan %}
|
||||
{% data reusables.marketplace.install-buy %}
|
||||
{% data reusables.marketplace.confirm-install-account-org %}
|
||||
{% data reusables.marketplace.add-payment-method-org %}
|
||||
{% data reusables.marketplace.complete-order-begin-installation %}
|
||||
1. If the app requires access to repositories, select **All repositories** or **Only select repositories**.
|
||||
|
||||
If the app creates any repositories, the app will automatically be granted access to those repositories as well.
|
||||
{% data reusables.marketplace.select-installation-repos %}
|
||||
{% data reusables.marketplace.review-app-perms-install %}
|
||||
|
||||
## Further reading
|
||||
|
||||
- "[AUTOTITLE](/billing/managing-your-github-billing-settings/adding-or-editing-a-payment-method)"
|
||||
- "[AUTOTITLE](/apps/using-github-apps/installing-an-app-in-your-personal-account)"
|
||||
@@ -0,0 +1,57 @@
|
||||
---
|
||||
title: Installing a GitHub App from GitHub Marketplace for your personal account
|
||||
intro: 'You can install {% data variables.product.prodname_github_app %}s from {% data variables.product.prodname_marketplace %} to use on your personal account.'
|
||||
redirect_from:
|
||||
- /articles/installing-an-app-in-your-personal-account
|
||||
- /github/customizing-your-github-workflow/installing-an-app-in-your-personal-account
|
||||
- /github/customizing-your-github-workflow/purchasing-and-installing-apps-in-github-marketplace/installing-an-app-in-your-personal-account
|
||||
- /get-started/customizing-your-github-workflow/purchasing-and-installing-apps-in-github-marketplace/installing-an-app-in-your-personal-account
|
||||
- /apps/using-github-apps/installing-an-app-in-your-personal-account
|
||||
- /apps/using-github-apps/installing-a-github-app-in-your-personal-account
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
shortTitle: Install from Marketplace for user
|
||||
---
|
||||
|
||||
## About {% data variables.product.prodname_marketplace %}
|
||||
|
||||
This article applies to installing and purchasing {% data variables.product.prodname_github_app %}s from {% data variables.product.prodname_marketplace %}. For more information on installing {% data variables.product.prodname_github_app %}s from a source other than {% data variables.product.prodname_marketplace %}, see "[AUTOTITLE](/apps/using-github-apps/installing-a-github-app-from-a-third-party)."
|
||||
|
||||
If you install a {% data variables.product.prodname_github_app %} on your personal account and you choose a paid plan, you will pay for your app subscription on your personal account's current billing date using your existing payment method.
|
||||
|
||||
{% data reusables.marketplace.free-trials %}
|
||||
|
||||
For more information about installing an {% data variables.product.prodname_oauth_app %} from {% data variables.product.prodname_marketplace %}, see "[AUTOTITLE](/apps/oauth-apps/using-oauth-apps/installing-an-oauth-app-in-your-personal-account)."
|
||||
|
||||
## About installing {% data variables.product.prodname_github_app %}s
|
||||
|
||||
{% 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_app %}s, see "[AUTOTITLE](/apps/using-github-apps/authorizing-github-apps)."
|
||||
|
||||
## Installing a {% data variables.product.prodname_github_app %} in your personal account
|
||||
|
||||
{% data reusables.marketplace.visit-marketplace %}
|
||||
{% data reusables.marketplace.browse-to-app %}
|
||||
{% data reusables.marketplace.choose-plan %}
|
||||
{% data reusables.marketplace.install-buy %}
|
||||
{% data reusables.marketplace.confirm-install-account-personal %}
|
||||
{% data reusables.marketplace.add-payment-method-personal %}
|
||||
{% data reusables.marketplace.complete-order-begin-installation %}
|
||||
1. If the app requires access to repositories, select **All repositories** or **Only select repositories**.
|
||||
|
||||
If the app creates any repositories, the app will automatically be granted access to those repositories as well.
|
||||
{% data reusables.marketplace.select-installation-repos %}
|
||||
{% data reusables.marketplace.review-app-perms-install %}
|
||||
|
||||
## Further reading
|
||||
|
||||
- "[AUTOTITLE](/billing/managing-your-github-billing-settings/adding-or-editing-a-payment-method)"
|
||||
- "[AUTOTITLE](/apps/using-github-apps/installing-an-app-in-your-organization)"
|
||||
@@ -1,41 +0,0 @@
|
||||
---
|
||||
title: Installing a GitHub App in your organization
|
||||
intro: 'You can install apps from {% data variables.product.prodname_marketplace %} to use in your organization.'
|
||||
redirect_from:
|
||||
- /articles/installing-an-app-in-your-organization
|
||||
- /github/customizing-your-github-workflow/installing-an-app-in-your-organization
|
||||
- /github/customizing-your-github-workflow/purchasing-and-installing-apps-in-github-marketplace/installing-an-app-in-your-organization
|
||||
- /get-started/customizing-your-github-workflow/purchasing-and-installing-apps-in-github-marketplace/installing-an-app-in-your-organization
|
||||
- /apps/using-github-apps/installing-an-app-in-your-organization
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
shortTitle: Install app organization
|
||||
---
|
||||
{% data reusables.marketplace.marketplace-apps-only %}
|
||||
|
||||
{% data reusables.marketplace.marketplace-org-perms %}
|
||||
|
||||
If you choose a paid plan, you'll pay for your app subscription on your organization's current billing date using your organization's existing payment method.
|
||||
|
||||
{% data reusables.marketplace.free-trials %}
|
||||
|
||||
For more information about installing an {% data variables.product.prodname_oauth_app %}, see "[AUTOTITLE](/apps/oauth-apps/using-oauth-apps/installing-an-oauth-app-in-your-organization)."
|
||||
|
||||
## Installing a {% data variables.product.prodname_github_app %} in your organization
|
||||
|
||||
{% data reusables.marketplace.visit-marketplace %}
|
||||
{% data reusables.marketplace.browse-to-app %}
|
||||
{% data reusables.marketplace.choose-plan %}
|
||||
{% data reusables.marketplace.install-buy %}
|
||||
{% data reusables.marketplace.confirm-install-account-org %}
|
||||
{% data reusables.marketplace.add-payment-method-org %}
|
||||
{% data reusables.marketplace.complete-order-begin-installation %}
|
||||
1. If the app requires access to repositories, select **All repositories** or **Only select repositories**.
|
||||
{% data reusables.marketplace.select-installation-repos %}
|
||||
{% data reusables.marketplace.review-app-perms-install %}
|
||||
|
||||
## Further reading
|
||||
|
||||
- "[AUTOTITLE](/billing/managing-your-github-billing-settings/adding-or-editing-a-payment-method)"
|
||||
- "[AUTOTITLE](/apps/using-github-apps/installing-an-app-in-your-personal-account)"
|
||||
@@ -1,39 +0,0 @@
|
||||
---
|
||||
title: Installing a GitHub App in your personal account
|
||||
intro: 'You can install apps from {% data variables.product.prodname_marketplace %} to use in your personal account.'
|
||||
redirect_from:
|
||||
- /articles/installing-an-app-in-your-personal-account
|
||||
- /github/customizing-your-github-workflow/installing-an-app-in-your-personal-account
|
||||
- /github/customizing-your-github-workflow/purchasing-and-installing-apps-in-github-marketplace/installing-an-app-in-your-personal-account
|
||||
- /get-started/customizing-your-github-workflow/purchasing-and-installing-apps-in-github-marketplace/installing-an-app-in-your-personal-account
|
||||
- /apps/using-github-apps/installing-an-app-in-your-personal-account
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
shortTitle: Install app personal account
|
||||
---
|
||||
{% data reusables.marketplace.marketplace-apps-only %}
|
||||
|
||||
If you choose a paid plan, you'll pay for your app subscription on your personal account's current billing date using your existing payment method.
|
||||
|
||||
{% data reusables.marketplace.free-trials %}
|
||||
|
||||
For more information about installing an {% data variables.product.prodname_oauth_app %}, see "[AUTOTITLE](/apps/oauth-apps/using-oauth-apps/installing-an-oauth-app-in-your-personal-account)."
|
||||
|
||||
## Installing a {% data variables.product.prodname_github_app %} in your personal account
|
||||
|
||||
{% data reusables.marketplace.visit-marketplace %}
|
||||
{% data reusables.marketplace.browse-to-app %}
|
||||
{% data reusables.marketplace.choose-plan %}
|
||||
{% data reusables.marketplace.install-buy %}
|
||||
{% data reusables.marketplace.confirm-install-account-personal %}
|
||||
{% data reusables.marketplace.add-payment-method-personal %}
|
||||
{% data reusables.marketplace.complete-order-begin-installation %}
|
||||
8. Decide whether to give the app access to all of your repositories, or to certain repositories, then select **All repositories** or **Only select repositories**.
|
||||
{% data reusables.marketplace.select-installation-repos %}
|
||||
{% data reusables.marketplace.review-app-perms-install %}
|
||||
|
||||
## Further reading
|
||||
|
||||
- "[AUTOTITLE](/billing/managing-your-github-billing-settings/adding-or-editing-a-payment-method)"
|
||||
- "[AUTOTITLE](/apps/using-github-apps/installing-an-app-in-your-organization)"
|
||||
Reference in New Issue
Block a user