|
2 | 2 | ## Private Packagist Self-Hosted |
3 | 3 |
|
4 | 4 | <div class="row column"> |
5 | | - <div class="callout warning"> |
6 | | - <p>Note: The instructions on this page create an integration with the public Bitbucket at bitbucket.org. If you are trying to setup an integration with your own Bitbucket Data Center / Server consult the <a href="/docs/self-hosted/bitbucket-server-integration-setup.md">Bitbucket Data Center / Server setup guide</a>.</p> |
| 5 | + <div class="callout success"> |
| 6 | + <p>This guide explains how to set up an OAuth integration for Private Packagist Self-Hosted with the public service on Bitbucket.org.</p> |
| 7 | + <p>If you are trying to setup an integration with your own Bitbucket Data Center / Server, consult <a href="/docs/self-hosted/bitbucket-server-integration-setup.md">this guide for Self-Hosted</a>. If you are using our Cloud product at packagist.com, use <a href="/docs/cloud/bitbucket-server-integration-setup.md">this guide</a>.</p> |
7 | 8 | </div> |
8 | 9 | </div> |
9 | 10 |
|
10 | | -## Initial Setup |
11 | | -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 Bitbucket account, you'll |
| 12 | +first need to create an integration in Private Packagist. This document walks you through the required steps. |
| 13 | + |
| 14 | +## Open the Add Integration form |
| 15 | +Go to the Admin section and hit the “Add Integration“ button to open the form to create your integration. If you've just |
| 16 | +installed Private Packagist Self-Hosted and it is still running in Setup Mode, you do not need to log in. If the application |
| 17 | +is no longer in Setup mode, you will have to log in with an admin account first. |
12 | 18 |
|
13 | 19 |  |
14 | 20 |
|
15 | 21 | To setup a Bitbucket integration with Private Packagist start by selecting "Bitbucket" as the platform and enter <i>https://bitbucket.org</i> as the base URL, as seen in the example below. |
| 22 | +A link to set up the OAuth application on Bitbucket will automatically be displayed. |
16 | 23 |
|
17 | | - |
| 24 | + |
18 | 25 |
|
19 | 26 | ## Creating an OAuth Application |
20 | | -Do not submit the integration form yet, but copy the content from the "Callback URL / Redirect URL" and go to <a href="https://bitbucket.org/account">https://bitbucket.org/account</a>. Find the "OAuth" menu item under "Access Management" and click on "Add consumer". |
21 | | - |
22 | | - |
| 27 | +Do not submit the integration form yet, the fields Client ID and Client Secret remain empty for now. |
| 28 | +Copy the content from the "Callback URL / Redirect URL" and open the setup link to your Bitbucket |
| 29 | +account. Replace the `<WORKSPACE_NAME>` string in the setup link with your actual Bitbucket workspace name. |
23 | 30 |
|
24 | | -Make sure all the scopes listed on the Private Packagist form are checked and save the new consumer. |
| 31 | + |
25 | 32 |
|
26 | | - |
| 33 | +Make sure all the scopes listed on the Private Packagist form are checked and save the new consumer. Click on the consumer |
| 34 | +you just created to reveal the credentials required to finish the setup on Private Packagist. |
27 | 35 |
|
28 | | -Click on the consumer you just created to reveal the credentials required to finish the setup on Private Packagist. |
| 36 | + |
29 | 37 |
|
30 | 38 | ## Finish the Setup |
31 | 39 | Copy and paste the "Key" and "Secret" values back into the Private Packagist integration form and submit the form with the "Create Integration" button. |
32 | 40 |
|
33 | | - |
| 41 | + |
| 42 | + |
| 43 | +The Bitbucket integration will be created and you will be redirected to the admin page. |
| 44 | + |
| 45 | +The new integration will be shown in the list of available integrations, and your users can |
| 46 | +now log in to your Private Packagist Self-Hosted installation using their Bitbucket account. |
| 47 | + |
| 48 | + |
0 commit comments