Octomerger Bot
@@ -86,14 +86,14 @@ As the app owner, you should include calls to action to encourage your users to
|
||||
|
||||
If you want your {% data variables.product.prodname_github_app %} to make API requests on behalf of itself or access organization or repository resources, the user must install your {% data variables.product.prodname_github_app %}. When a user installs a {% data variables.product.prodname_github_app %} on their account or organization, they choose which repositories the app can access, and they grant the app the organization and repository permissions that it requested.
|
||||
|
||||
To help your users install your {% data variables.product.prodname_github_app %}, you can add a link to your app's webpage that users can click to install the {% data variables.product.prodname_github_app %}. The format of the install URL is `https://github.com/apps/YOUR_APP_NAME/installations/new`. Replace `YOUR_APP_NAME` with the name of your {% data variables.product.prodname_github_app %} (converted to lowercase, with spaces replaced by `-`, and with special characters replaced).
|
||||
To help your users install your {% data variables.product.prodname_github_app %}, you can add a link to your app's webpage that users can click to install the {% data variables.product.prodname_github_app %}. The format of the install URL is `{% data variables.product.oauth_host_code %}/{% ifversion ghes or ghae %}github-apps{% else %}apps{% endif %}/YOUR_APP_NAME/installations/new`. Replace `YOUR_APP_NAME` with the sluggified name of your {% data variables.product.prodname_github_app %}, which you can find in the "Public link" field on the settings page for your {% data variables.product.prodname_github_app %}.
|
||||
|
||||
To pre-select any repositories your {% data variables.product.prodname_oauth_app %} had access to, you can append `/permissions` and query parameters to the install URL. This helps users grant your {% data variables.product.prodname_github_app %} access to repositories that your {% data variables.product.prodname_oauth_app %} already has access to. The query parameters are:
|
||||
|
||||
- `suggested_target_id`: The ID of the user or organization that is installing your {% data variables.product.prodname_github_app %}. This parameter is required.
|
||||
- `repository_ids[]`: The repository IDs to select for the installation. If omitted, all repositories are selected. The maximum number of repositories that can be pre-selected is 100. To get a list of repositories that your {% data variables.product.prodname_oauth_app %} has access to, use the [List repositories for the authenticated user](/rest/repos#list-repositories-for-the-authenticated-user) and [List organization repositories](/rest/repos#list-organization-repositories) endpoints.
|
||||
|
||||
For example: `https://github.com/apps/YOUR_APP_NAME/installations/new/permissions?suggested_target_id=ID_OF_USER_OR_ORG&repository_ids[]=REPO_A_ID&repository_ids[]=REPO_B_ID`.
|
||||
For example: `{% data variables.product.oauth_host_code %}/{% ifversion ghes or ghae %}github-apps{% else %}apps{% endif %}/YOUR_APP_NAME/installations/new/permissions?suggested_target_id=ID_OF_USER_OR_ORG&repository_ids[]=REPO_A_ID&repository_ids[]=REPO_B_ID`.
|
||||
|
||||
{% ifversion ghec or fpt %}For more information about installing {% data variables.product.prodname_github_app %}s, see "[AUTOTITLE](/apps/using-github-apps/installing-an-app-in-your-personal-account)" and "[AUTOTITLE](/apps/using-github-apps/installing-an-app-in-your-organization)."{% endif %}
|
||||
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
title: Maintaining {% data variables.product.prodname_github_apps %}
|
||||
title: 'Maintaining {% data variables.product.prodname_github_apps %}'
|
||||
intro: 'After you create and register a {% data variables.product.prodname_github_app %}, you can make modifications to the app, change permissions, transfer ownership, and delete the app.'
|
||||
redirect_from:
|
||||
- /apps/building-integrations/managing-github-apps
|
||||
@@ -16,9 +16,11 @@ children:
|
||||
- /about-github-app-managers
|
||||
- /modifying-a-github-app
|
||||
- /managing-allowed-ip-addresses-for-a-github-app
|
||||
- /installing-github-apps
|
||||
- /installing-your-own-github-app
|
||||
- /sharing-your-github-app
|
||||
- /activating-optional-features-for-github-apps
|
||||
- /suspending-a-github-app-installation
|
||||
- /transferring-ownership-of-a-github-app
|
||||
- /deleting-a-github-app
|
||||
---
|
||||
|
||||
|
||||
@@ -1,68 +0,0 @@
|
||||
---
|
||||
title: Installing GitHub Apps
|
||||
intro: 'When your app is public, anyone can use {% ifversion fpt or ghec %} the {% data variables.product.prodname_marketplace %} or {% endif %}an installation URL to install the app on their repository. When your app is private, only you can install the app on repositories that you own.'
|
||||
redirect_from:
|
||||
- /apps/installing-github-apps
|
||||
- /developers/apps/installing-github-apps
|
||||
- /developers/apps/managing-github-apps/installing-github-apps
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- GitHub Apps
|
||||
---
|
||||
{% note %}
|
||||
|
||||
**Note:** Your {% data variables.product.prodname_github_app %} will have access to any repositories the app creates, even if someone only installs your app on selected repositories.
|
||||
|
||||
{% endnote %}
|
||||
|
||||
## Installing your private GitHub App on your repository
|
||||
|
||||
Once you create a private GitHub App, you can install it on one of your org or user repositories. For more information, see "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/making-a-github-app-public-or-private#private-installation-flow)."
|
||||
|
||||
1. From the [GitHub Apps settings page](https://github.com/settings/apps), select your app.
|
||||
1. In the left sidebar, click **Install App**.
|
||||
1. Click **Install** next to the organization or personal account containing the correct repository.
|
||||
1. Select **All repositories** or **Only select repositories**.
|
||||
1. If you chose "Only select repositories," select the **Select repositories** dropdown menu and click the repositories where you want to install the app.
|
||||
1. Click **Install**. Once installed, you will see configuration options for the app on your selected account. You can make changes here, or repeat the previous steps to install the app on another account.
|
||||
|
||||
{% ifversion fpt or ghec %}
|
||||
## Offering your app in the GitHub Marketplace
|
||||
|
||||
You can offer a paid or free version of your app in [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace), where people can search for and view details about your app. {% data variables.product.prodname_marketplace %} automatically installs a GitHub App when an order is complete.
|
||||
|
||||
See "[AUTOTITLE](/apps/publishing-apps-to-github-marketplace/github-marketplace-overview/about-github-marketplace)" to learn more about listing your app on {% data variables.product.prodname_marketplace %}.
|
||||
|
||||
To learn more about how users can install your app from {% data variables.product.prodname_marketplace %}, see "[AUTOTITLE](/apps/using-github-apps)".
|
||||
|
||||
{% endif %}
|
||||
|
||||
## Allowing people to install your public app on their repository
|
||||
|
||||
You can enable others to install your public app by providing the installation URL in places like your app's homepage. You can then point to your app's homepage from the landing page on GitHub.
|
||||
|
||||
If you are migrating from an OAuth App to a GitHub App, you can use query parameters to preselect the repositories and account when installing the GitHub App. See "[AUTOTITLE](/apps/creating-github-apps/guides/migrating-oauth-apps-to-github-apps)" to learn more.
|
||||
|
||||
These steps assume you have [built a {% data variables.product.prodname_github_app %}](/apps/creating-github-apps/setting-up-a-github-app):
|
||||
|
||||
1. From the [GitHub Apps settings page](https://github.com/settings/apps), select the public app you want to configure for others to install.
|
||||
2. In the "General" tab, under "Homepage URL," type the URL for your app's homepage and click **Save changes**.
|
||||
3. GitHub provides a landing page for your app that includes a link to your app's "Homepage URL." To visit the landing page on GitHub, copy the URL from "Public link" and paste it into a browser.
|
||||
4. Create a homepage for your app that includes the app installation URL: `{% data variables.product.oauth_host_code %}/{% ifversion ghes or ghae %}github-apps{% else %}apps{% endif %}/<app name>/installations/new`.
|
||||
|
||||
## Authorizing users during installation
|
||||
|
||||
You can simplify the authorization process by completing it during app installation. To do this, select **Request user authorization (OAuth) during installation** when creating or modifying your app in GitHub. See "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app)" to learn more.
|
||||
|
||||
Once someone has installed your app, you will need to get an access token for the user. For more information, see "[AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app)."
|
||||
## Preserving an application state during installation
|
||||
|
||||
You can provide a `state` parameter in an app's 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:
|
||||
|
||||
`{% data variables.product.oauth_host_code %}/{% ifversion ghes or ghae %}github-apps{% else %}apps{% endif %}/<app name>/installations/new?state=AB12t`
|
||||
@@ -0,0 +1,43 @@
|
||||
---
|
||||
title: Installing your own GitHub App
|
||||
intro: 'You can install your {% data variables.product.prodname_github_app %} on the user or organization account that owns the app. If your app is public, the {% data variables.product.prodname_github_app %} can also be installed on other accounts.'
|
||||
redirect_from:
|
||||
- /apps/installing-github-apps
|
||||
- /developers/apps/installing-github-apps
|
||||
- /developers/apps/managing-github-apps/installing-github-apps
|
||||
- /apps/maintaining-github-apps/installing-github-apps
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- GitHub Apps
|
||||
shortTitle: Install your app
|
||||
---
|
||||
|
||||
## About installing your own {% data variables.product.prodname_github_app %}
|
||||
|
||||
Once you create a {% data variables.product.prodname_github_app %}, you can install it. If your {% data variables.product.prodname_github_app %} is owned by a personal account{% ifversion ghec%} and you are not an {% data variables.product.prodname_emu %}{% endif %}, you can install it on your account. If your {% data variables.product.prodname_github_app %} is owned by an organization and you are an organization owner, you can install it on your organization.
|
||||
|
||||
{% ifversion fpt or ghec %}
|
||||
If your {% data variables.product.prodname_github_app %} is public{% ifversion ghec%} and you are not an {% data variables.product.prodname_emu %}{% endif %}, you can also share your {% data variables.product.prodname_github_app %} with other users or organizations. {% ifversion ghec%}If you are an {% data variables.product.prodname_emu %}, then you can only share your app with other organizations within your enterprise.{% endif %}For more information, see "[AUTOTITLE](/apps/maintaining-github-apps/sharing-your-github-app)."
|
||||
{% else %}
|
||||
If your {% data variables.product.prodname_github_app %} is public, you can also share your {% data variables.product.prodname_github_app %} with other users or organizations within your enterprise. For more information, see "[AUTOTITLE](/apps/maintaining-github-apps/sharing-your-github-app)."
|
||||
{% endif %}
|
||||
|
||||
## Installing your own {% data variables.product.prodname_github_app %}
|
||||
|
||||
{% data reusables.apps.settings-step %}
|
||||
{% data reusables.user-settings.developer_settings %}
|
||||
{% data reusables.user-settings.github_apps %}
|
||||
1. Next to the {% data variables.product.prodname_github_app %} that you want to install, click **Edit**.
|
||||
1. Click **Install App**.
|
||||
1. Click **Install** next to the location where you want to install the {% data variables.product.prodname_github_app %}.
|
||||
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. Click **Install**.
|
||||
@@ -0,0 +1,44 @@
|
||||
---
|
||||
title: Sharing your GitHub App
|
||||
intro: 'You can share your {% data variables.product.prodname_github_app %} with other users.'
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
ghae: '*'
|
||||
ghes: '*'
|
||||
shortTitle: Share your app
|
||||
---
|
||||
|
||||
{% ifversion fpt or ghec %}
|
||||
|
||||
### Sharing your {% data variables.product.prodname_github_app %} on {% data variables.product.prodname_marketplace %}
|
||||
|
||||
If your {% data variables.product.prodname_github_app %} is public, you can 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)."
|
||||
|
||||
{% ifversion ghec %}If you are an {% data variables.product.prodname_emu %}, then you cannot share your app on {% data variables.product.prodname_marketplace %}.{% endif %}
|
||||
|
||||
For more information about how users can install your app from {% data variables.product.prodname_marketplace %}, see "[AUTOTITLE](/apps/using-github-apps/installing-a-github-app-from-github-marketplace-for-your-organizations)" and "[AUTOTITLE](/apps/using-github-apps/installing-a-github-app-from-github-marketplace-for-your-personal-account)."
|
||||
|
||||
{% endif %}
|
||||
|
||||
### Sharing your {% data variables.product.prodname_github_app %} via an install link
|
||||
|
||||
{% ifversion fpt or ghec %}
|
||||
If your {% data variables.product.prodname_github_app %} is public, other users and organizations {% ifversion ghae or ghec %}within your enterprise {% endif %}can install your app. For more information about making your app public, see "[AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/making-a-github-app-public-or-private)."
|
||||
|
||||
{% ifversion ghec %}If you are an {% data variables.product.prodname_emu %}, then you can only share your app with other users or organizations within your enterprise.{% endif %}
|
||||
|
||||
{% else %}
|
||||
{% endif %}
|
||||
|
||||
{% data reusables.apps.settings-step %}
|
||||
{% data reusables.user-settings.developer_settings %}
|
||||
{% data reusables.user-settings.github_apps %}
|
||||
1. Next to the {% data variables.product.prodname_github_app %} that you want to share, click **Edit**.
|
||||
1. Click **Public page**. {% data variables.product.company_short %} will bring you to the public page for your {% data variables.product.prodname_github_app %}.
|
||||
1. Click **Install**. {% data variables.product.company_short %} will bring you to the installation URL for your {% 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. Share the installation URL with other users. For more information about how users can install your app from this URL, see "[AUTOTITLE](/apps/using-github-apps/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: `{% data variables.product.oauth_host_code %}/{% ifversion ghes or ghae %}github-apps{% else %}apps{% endif %}/<app name>/installations/new?state=AB12t`
|
||||
@@ -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)"
|
||||
9
data/reusables/apps/about-installation.md
Normal file
9
data/reusables/apps/about-installation.md
Normal file
@@ -0,0 +1,9 @@
|
||||
In order to use a {% data variables.product.prodname_github_app %} on your repositories or organization, you must install the app.
|
||||
|
||||
When you install an app, you grant the app permission to access the organization and repository resources that it requested. During the installation process, {% data variables.product.company_short %} will tell you which permissions the {% data variables.product.prodname_github_app %} requested. 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)."
|
||||
|
||||
When you install an app, you will also choose which repositories to grant the {% data variables.product.prodname_github_app %} access to.
|
||||
|
||||
Before installing a {% data variables.product.prodname_github_app %}, you should ensure you trust the owner of the {% data variables.product.prodname_github_app %}. You should also review the permissions that the {% data variables.product.prodname_github_app %} is requesting and make sure you are comfortable granting those permissions. 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)."
|
||||
|
||||
There is no limit to how many apps you can install.
|
||||
5
data/reusables/apps/install-vs-authorize.md
Normal file
5
data/reusables/apps/install-vs-authorize.md
Normal file
@@ -0,0 +1,5 @@
|
||||
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.
|
||||
Reference in New Issue
Block a user