-
Notifications
You must be signed in to change notification settings - Fork 14
Integrations: update GitHub guides #110
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
d2cc6fb
Upgrade the integrations page
stevenrombauts c75923e
Update the GitHub integration guides
stevenrombauts 64409d5
Optimised images with calibre/image-actions
github-actions[bot] db23b95
Apply suggestions from code review
stevenrombauts 24065c5
Rename screenshots that were edited in place
stevenrombauts bb9562b
Optimised images with calibre/image-actions
github-actions[bot] File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified
BIN
+30 KB
(140%)
...ublic/img/docs/integration-setup/cloud/github-enterprise-01-packagist-setup.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+95.5 KB
...s/public/img/docs/integration-setup/cloud/github-enterprise-02-register-app.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+73.8 KB
.../public/img/docs/integration-setup/cloud/github-enterprise-04-complete-form.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed
BIN
-87.6 KB
...public/img/docs/integration-setup/cloud/github-enterprise-04-packagist-form.png
Binary file not shown.
Binary file added
BIN
+54.7 KB
...es/public/img/docs/integration-setup/cloud/github-enterprise-05-integration.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed
BIN
-166 KB
Resources/public/img/docs/integration-setup/github-01-packagist-setup.png
Binary file not shown.
Binary file removed
BIN
-172 KB
Resources/public/img/docs/integration-setup/github-02-github-register-app.png
Binary file not shown.
Binary file modified
BIN
-116 KB
(47%)
Resources/public/img/docs/integration-setup/github-03-github-credentials.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed
BIN
-196 KB
Resources/public/img/docs/integration-setup/github-04-packagist-form.png
Binary file not shown.
Binary file added
BIN
+107 KB
...ces/public/img/docs/integration-setup/self-hosted/github-01-packagist-setup.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+84.2 KB
...public/img/docs/integration-setup/self-hosted/github-02-github-register-app.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+87.4 KB
...rces/public/img/docs/integration-setup/self-hosted/github-04-packagist-form.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+17.1 KB
...blic/img/docs/integration-setup/self-hosted/github-05-integrations-overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,31 +1,55 @@ | ||
# GitHub (Enterprise) Integration Setup | ||
# GitHub Enterprise Integration Setup | ||
## Private Packagist Cloud | ||
|
||
## Initial Setup | ||
<div class="row column"> | ||
<div class="callout success"> | ||
<p> | ||
This guide explains how to setup an OAuth integration for Private Packagist Cloud with GitHub Enterprise Cloud/Server. | ||
stevenrombauts marked this conversation as resolved.
Show resolved
Hide resolved
|
||
If you use their public service on GitHub.com, these instructions are not relevant to you. | ||
</p> | ||
<p>If you are using our Self-Hosted product, please <a href="/docs/self-hosted/github-integration-setup">use this guide</a>.</p> | ||
</div> | ||
</div> | ||
|
||
To allow your users to authenticate to Private Packagist with their GitHub Enterprise account, you'll first need to create | ||
an integration in Private Packagist. This document walks you through the required steps. | ||
|
||
## Open the Add Integration form | ||
|
||
From the organization settings page, select the "Integrations" subtab. Hit the "Add Integration" button on the integrations listing page to get to the form below. | ||
To set up a GitHub Enterprise integration with Private Packagist start by selecting "GitHub" as the platform and enter the URL of your GitHub Enterprise server, as seen in the example below. | ||
A link to setup the OAuth application on your GitHub enterprise server will automatically be displayed. | ||
A link to create a new OAuth application on your GitHub enterprise server will automatically be displayed. | ||
stevenrombauts marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
 | ||
|
||
## Creating an OAuth Application | ||
## Create a GitHub Enterprise OAuth Application | ||
|
||
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. | ||
|
||
 | ||
 | ||
|
||
Register a new application on GitHub. This will reveal the client ID and client | ||
secret required for finishing the setup on Private Packagist. | ||
Register a new application on GitHub Enterprise. You'll be redirected to the application's page. Click the "Generate a new client secret" button | ||
to get a new secret. You'll need the client ID and client secret to finish the setup on Private Packagist. | ||
|
||
 | ||
|
||
## Finish the Setup | ||
## Create the integration | ||
|
||
Copy and paste the "Client ID" and "Client Secret" values back into the Private | ||
Packagist integration form and submit the form with the "Save Integration" | ||
button. | ||
|
||
 | ||
 | ||
|
||
You'll be redirected back to the list of integrations. | ||
|
||
### Share the GitHub Enterprise login link | ||
|
||
The final step is sharing your organization-specific login link with your users. Look for the "Login link" button next to | ||
your newly created GitHub Enterprise integration on the integrations page, and copy the URL. | ||
|
||
 | ||
|
||
This link presents the option to authenticate with your GitHub Enterprise account and can now be used to log in to Private Packagist. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,28 +1,50 @@ | ||
# GitHub (Enterprise) Integration Setup | ||
## Private Packagist Self-Hosted | ||
|
||
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. | ||
If you are using our cloud product at packagist.com, [use this guide](../cloud/github-integration-setup.md). | ||
<div class="row column"> | ||
<div class="callout success"> | ||
<p>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.</p> | ||
stevenrombauts marked this conversation as resolved.
Show resolved
Hide resolved
|
||
<p>If you are using our Cloud product at packagist.com, <a href="/docs/cloud/github-integration-setup">use this guide</a>.</p> | ||
</div> | ||
</div> | ||
|
||
## Initial Setup | ||
Hit the “Add Integration“ button on the admin page to get to the form below. | ||
To allow your users to authenticate to Private Packagist Self-Hosted with their GitHub or GitHub Enterprise account, you'll | ||
first need to create an integration in Private Packagist. This document walks you through the required steps. | ||
|
||
## Open the Add Integration form | ||
|
||
Log in with an admin account, go to the Admin section and hit the “Add Integration“ button to open the form to create your integration. | ||
glaubinix marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
 | ||
|
||
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. | ||
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 set up the OAuth application on GitHub will automatically be displayed. | ||
|
||
 | ||
 | ||
|
||
## Creating an OAuth Application | ||
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. | ||
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. | ||
|
||
 | ||
 | ||
|
||
Register a new application on GitHub. This will reveal the client ID and client secret required for finishing the setup on Private Packagist. | ||
Register a new application on GitHub Enterprise. You'll be redirected to the application's page. Click the "Generate a new client secret" button | ||
to get a new secret. You'll need the client ID and client secret to finish the setup on Private Packagist. | ||
|
||
 | ||
|
||
## Finish the Setup | ||
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. | ||
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. | ||
|
||
 | ||
|
||
The GitHub integration will be created and you will be redirected to the admin page. | ||
|
||
The new integration will be shown in the list of available integrations, and your users can | ||
now log in to your Private Packagist Self-Hosted installation using their GitHub account. | ||
|
||
 | ||
 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.