Skip to content

Commit ff97832

Browse files
Update Bitbucket Self-Hosted docs
1 parent 20b2b79 commit ff97832

11 files changed

+28
-13
lines changed
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
177 KB
Loading
207 KB
Loading
50.6 KB
Loading
143 KB
Loading
23.2 KB
Loading

docs/self-hosted/bitbucket-integration-setup.md

Lines changed: 27 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,32 +2,47 @@
22
## Private Packagist Self-Hosted
33

44
<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>
78
</div>
89
</div>
910

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.
1218

1319
![Add Integration](/Resources/public/img/docs/self-hosted/08-integration-create.png)
1420

1521
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.
1623

17-
![Packagist Setup](/Resources/public/img/docs/integration-setup/bitbucket-01-packagist-setup.png)
24+
![Packagist Setup](/Resources/public/img/docs/integration-setup/self-hosted/bitbucket-01-packagist-setup.png)
1825

1926
## 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-
![Bitbucket Form](/Resources/public/img/docs/integration-setup/bitbucket-02-bitbucket-form.png)
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.
2330

24-
Make sure all the scopes listed on the Private Packagist form are checked and save the new consumer.
31+
![Bitbucket Form](/Resources/public/img/docs/integration-setup/self-hosted/bitbucket-02-bitbucket-form.png)
2532

26-
![Bitbucket Form](/Resources/public/img/docs/integration-setup/bitbucket-03-bitbucket-reveal-key.png)
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.
2735

28-
Click on the consumer you just created to reveal the credentials required to finish the setup on Private Packagist.
36+
![Bitbucket Form](/Resources/public/img/docs/integration-setup/self-hosted/bitbucket-03-bitbucket-reveal-key.png)
2937

3038
## Finish the Setup
3139
Copy and paste the "Key" and "Secret" values back into the Private Packagist integration form and submit the form with the "Create Integration" button.
3240

33-
![Bitbucket Form](/Resources/public/img/docs/integration-setup/bitbucket-04-packagist-form.png)
41+
![Bitbucket Form](/Resources/public/img/docs/integration-setup/self-hosted/bitbucket-04-packagist-form.png)
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+
![Available integrations](/Resources/public/img/docs/integration-setup/self-hosted/bitbucket-05-integrations-overview.png)

0 commit comments

Comments
 (0)