|
1 | 1 | # GitHub (Enterprise) Integration Setup |
2 | 2 | ## Private Packagist Self-Hosted |
3 | 3 |
|
4 | | -This guide explains how to setup an OAuth integration for Private Packagist Self-Hosted with either the on-premises version of GitHub, or their public service on github.com. |
5 | | -If you are using our cloud product at packagist.com, [use this guide](../cloud/github-integration-setup.md). |
| 4 | +<div class="row column"> |
| 5 | + <div class="callout success"> |
| 6 | + <p>This guide explains how to set up an OAuth integration for Private Packagist Self-Hosted with either the on-premises version of GitHub, or their public service on GitHub.com.</p> |
| 7 | + <p>If you are using our Cloud product at packagist.com, <a href="/docs/cloud/github-integration-setup">use this guide</a>.</p> |
| 8 | + </div> |
| 9 | +</div> |
6 | 10 |
|
7 | | -## Initial Setup |
8 | | -Hit the “Add Integration“ button on the admin page to get to the form below. |
| 11 | +To allow your users to authenticate to Private Packagist Self-Hosted with their GitHub or GitHub Enterprise account, you'll |
| 12 | +first need to create an integration in Private Packagist. This document walks you through the required steps. |
9 | 13 |
|
10 | | - |
| 14 | +## Open the Add Integration form |
11 | 15 |
|
12 | | -To setup a GitHub integration with Private Packagist start by selecting "GitHub" as the platform and enter the URL of your GitHub Enterprise Server or <i>https://github.com</i> to use the public GitHub server as seen in the example below. A link to setup the OAuth application on GitHub will automatically be displayed. |
| 16 | +Go to the Admin section and hit the “Add Integration“ button to open the form to create your integration. If you've just |
| 17 | +installed Private Packagist Self-Hosted and it is still running in Setup Mode, you do not need to log in. If the application |
| 18 | +is no longer in Setup mode, you will have to log in with an admin account first. |
13 | 19 |
|
14 | | - |
| 20 | + |
| 21 | + |
| 22 | +To setup a GitHub integration with Private Packagist start by selecting "GitHub" as the platform and enter the URL of |
| 23 | +your GitHub Enterprise Server or <i>https://github.com</i> to use the public GitHub server as seen in the example below. |
| 24 | +A link to set up the OAuth application on GitHub will automatically be displayed. |
| 25 | + |
| 26 | + |
15 | 27 |
|
16 | 28 | ## Creating an OAuth Application |
17 | | -Do not submit the integration form yet, but copy the content from the "Callback URL / Redirect URL" and follow the setup link to your GitHub server. The fields Client ID and Client Secret remain empty for now. |
| 29 | +Do not submit the integration form yet, but copy the content from the "Callback |
| 30 | +URL / Redirect URL" and follow the setup link to your GitHub server. The fields |
| 31 | +Client ID and Client Secret remain empty for now. |
18 | 32 |
|
19 | | - |
| 33 | + |
20 | 34 |
|
21 | | -Register a new application on GitHub. This will reveal the client ID and client secret required for finishing the setup on Private Packagist. |
| 35 | +Register a new application on GitHub Enterprise. You'll be redirected to the application's page. Click the "Generate a new client secret" button |
| 36 | +to get a new secret. You'll need the client ID and client secret to finish the setup on Private Packagist. |
22 | 37 |
|
23 | | - |
| 38 | + |
24 | 39 |
|
25 | 40 | ## Finish the Setup |
26 | | -Copy and paste the "Client ID" and "Client Secret" values back into the Private Packagist integration form and submit the form with the "Create Integration" button. |
| 41 | +Copy and paste the "Client ID" and "Client Secret" values back into the Private |
| 42 | +Packagist integration form and submit the form with the "Create Integration" |
| 43 | +button. |
| 44 | + |
| 45 | + |
| 46 | + |
| 47 | +The GitHub integration will be created and you will be redirected to the admin page. |
| 48 | + |
| 49 | +The new integration will be shown in the list of available integrations, and your users can |
| 50 | +now log in to your Private Packagist Self-Hosted installation using their GitHub account. |
27 | 51 |
|
28 | | - |
| 52 | + |
0 commit comments