Skip to content

Commit a344dfb

Browse files
authored
Merge pull request #113 from packagist/update-bitbucket-integration-guides
Integrations: update Bitbucket guides
2 parents 83d75aa + 782c9c2 commit a344dfb

File tree

40 files changed

+162
-48
lines changed

40 files changed

+162
-48
lines changed
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading
Loading
Loading
Loading

docs/cloud/bitbucket-server-integration-setup.md

+43-12
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,67 @@
11
# Bitbucket Data Center / Server Integration Setup
22
## Private Packagist Cloud
33

4+
<div class="row column">
5+
<div class="callout success">
6+
<p>
7+
This guide explains how to set up an OAuth integration for Private Packagist Cloud with Bitbucket Data Center / Server.
8+
If you use their public service on bitbucket.org, these instructions are not relevant to you.
9+
</p>
10+
<p>If you are using our Self-Hosted product, please <a href="/docs/self-hosted/bitbucket-server-integration-setup.md">use this guide</a>.</p>
11+
</div>
12+
</div>
13+
414
<div class="row column">
515
<div class="callout warning">
616
<p>Note: Application Links using OAuth 2 are available since Bitbucket Data Center / Server v7.21. If you are using an older Bitbucket Data Center / Server version then consult the <a href="/docs/cloud/bitbucket-server-oauth1-integration-setup.md">Bitbucket Data Center / Server OAuth 1 setup guide</a>.</p>
717
</div>
818
</div>
919

10-
## Initial Setup
11-
From the organization settings page, select the "Integrations" subtab.
12-
Hit the "Add Integration" button on the integrations listing page to get to the form below.
13-
To set up a Bitbucket Data Center / Server integration with Private Packagist, start by selecting "Bitbucket Data Center / Server"
14-
as the platform, enter the URL of your on-premise Bitbucket Data Center / Server into the base URL field and select OAuth 2 as the OAuth version as seen in the example below.
20+
To allow your users to authenticate to Private Packagist with their Bitbucket Data Center / Server account, you'll
21+
first need to create an integration in Private Packagist. This document walks you through the required steps.
1522

16-
![Packagist Setup](/Resources/public/img/docs/integration-setup/cloud/bitbucket-server-01-packagist-setup.png)
23+
## Open the Add Integration form
24+
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.
25+
To set up a Bitbucket Data Center / Server integration with Private Packagist start by selecting "Bitbucket Data Center / Server" as the platform, enter
26+
the URL of your on-premise Bitbucket server into the base URL field and select OAuth 2 as the OAuth version as seen in the example below.
1727

18-
Copy the content from the "Callback URL / Redirect URL" field and follow the link to set up an Application Link.
28+
A link to create a new OAuth application on your Bitbucket Data Center / Server instance will automatically be displayed.
29+
30+
![Packagist Setup](/Resources/public/img/docs/integration-setup/cloud/bitbucket-server-01-packagist-setup-20250102.png)
1931

2032
## Configure Application link
21-
Click on the link to setup an Application Link on Bitbucket Data Center / Server and select "External application" as type and "Incoming" as direction.
33+
Do not submit the integration form yet, but copy the content from the "Callback
34+
URL / Redirect URL" and follow the setup link to your Bitbucket Data Center / Server instance. The fields
35+
Client ID and Client Secret remain empty for now.
36+
37+
In Bitbucket Data Center / Server, click on the "Create link" button and select "External application" as type and "Incoming" as direction.
2238

23-
![Bitbucket Data Center / Server Create Application Link](/Resources/public/img/docs/integration-setup/bitbucket-server-02-bitbucket-create-application-link.png)
39+
![Bitbucket Data Center / Server Create Application Link](/Resources/public/img/docs/integration-setup/bitbucket-server-02-bitbucket-create-application-link-20250102.png)
2440

2541
After you click the button to continue, enter a name and the content from the "Callback URL / Redirect URL" from the Private Packagist form.
2642
Select Repositories "Read" as application permission and save the form.
2743

28-
![Bitbucket Data Center / Server Configure Application Link](/Resources/public/img/docs/integration-setup/bitbucket-server-03-bitbucket-configure-application-link.png)
44+
![Bitbucket Data Center / Server Configure Application Link](/Resources/public/img/docs/integration-setup/cloud/bitbucket-server-03-bitbucket-configure-application-link.png)
45+
46+
Once the form is saved, Bitbucket Data Center / Server will show you the Client ID and secret.
2947

3048
## Finish the Setup
49+
Copy and paste the "Client ID" and "Client Secret" values back into the Private
50+
Packagist integration form and submit the form with the "Create Integration"
51+
button.
3152

32-
Once the form is saved, Bitbucket Data Center / Server will show you the Client ID and secret.
33-
Copy them over to Private Packagist and save the integration.
53+
![Packagist Finalize](/Resources/public/img/docs/integration-setup/cloud/bitbucket-server-04-packagist-finalize.png)
54+
55+
You'll be redirected back to the list of integrations.
56+
57+
### Share the Bitbucket login link
58+
59+
The final step is sharing your organization-specific login link with your users. Look for the "Login link" button next to
60+
your newly created Bitbucket Data Center / Server integration on the integrations page, and copy the URL.
61+
62+
![Bitbucket Data Center / Server integrations](/Resources/public/img/docs/integration-setup/cloud/bitbucket-server-05-integrations-overview.png)
63+
64+
This link presents the option to authenticate with your Bitbucket Data Center / Server account and can now be used to log in to Private Packagist.
3465

3566
## Configure Bitbucket Server plugins
3667

docs/cloud/bitbucket-server-oauth1-integration-setup.md

+25-5
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,16 @@
11
# Bitbucket Data Center / Server Integration Setup (OAuth 1)
22
## Private Packagist Cloud
33

4+
<div class="row column">
5+
<div class="callout success">
6+
<p>
7+
This guide explains how to set up an OAuth 1 integration for Private Packagist Cloud with Bitbucket Data Center / Server.
8+
If you use their public service on bitbucket.org, these instructions are not relevant to you.
9+
</p>
10+
<p>If you are using our Self-Hosted product, please <a href="/docs/self-hosted/bitbucket-server-oauth1-integration-setup.md">use this guide</a>.</p>
11+
</div>
12+
</div>
13+
414
<div class="row column">
515
<div class="callout warning">
616
<p>
@@ -12,18 +22,20 @@
1222
</div>
1323
</div>
1424

15-
## Initial Setup
25+
To allow your users to authenticate to Private Packagist with their Bitbucket Data Center / Server account, you'll
26+
first need to create an integration in Private Packagist. This document walks you through the required steps.
1627

28+
## Open the Add Integration form
1729
From the organization settings page, select the "Integrations" subtab.
1830
Hit the "Add Integration" button on the integrations listing page to get to the form below.
1931
To set up a Bitbucket Data Center / Server integration with Private Packagist, start by selecting "Bitbucket Data Center / Server"
2032
as the platform, enter the URL of your on-premise Bitbucket Data Center / Server into the base URL field and select OAuth 1 as the OAuth version as seen in the example below.
2133

22-
![Packagist Setup](/Resources/public/img/docs/integration-setup/cloud/bitbucket-server-oauth1-01-packagist-setup.png)
34+
![Packagist Setup](/Resources/public/img/docs/integration-setup/cloud/bitbucket-server-oauth1-01-packagist-setup-20250103.png)
2335

2436
Submit the form to see the additional information.
2537

26-
![Packagist Form](/Resources/public/img/docs/integration-setup/cloud/bitbucket-server-oauth1-02-packagist-details.png)
38+
![Packagist Form](/Resources/public/img/docs/integration-setup/cloud/bitbucket-server-oauth1-02-packagist-details-20250103.png)
2739

2840
## Configure Application link
2941
Click on the link to setup an Application Link on Bitbucket Data Center / Server. You will need the "Client Id" and the "Public Key" shown in the form.
@@ -32,7 +44,7 @@ Click on the link to setup an Application Link on Bitbucket Data Center / Server
3244

3345
For Bitbucket Data Center versions 7.21 and newer, select "Atlassian product" and not "External application" to be able to set up an OAuth1 link.
3446

35-
After you hit the button to create a new Application Link a configuration window may appear. If it does, verify that the url matches your Private Packagist URL and hit "Continue", otherwise skip this step.
47+
After you hit the button to create a new Application Link a configuration window may appear. If it does, verify that the url matches the "Application URL for Link" (_https://packagist.com_) and hit "Continue", otherwise skip this step.
3648

3749
![Bitbucket Data Center / Server Invalid Url](/Resources/public/img/docs/integration-setup/bitbucket-server-oauth1-04-bitbucket-invalid-url.png)
3850

@@ -48,7 +60,15 @@ Click on the pen icon to the right of the application you just created to edit t
4860

4961
This is where we will need the "Client ID" and the "Public Key" that were previously generated on the Private Packagist integration form.
5062
Enter the "Client ID" into the "Consumer Key" field, make sure the entire content of the "Public Key" field gets copied and the "Consumer Callback" field stays empty.
51-
Submit the form and go back to Private Packagist.
63+
Submit the form and go back to the list of integrations in Private Packagist.
64+
65+
### Share the Bitbucket login link
66+
The final step is sharing your organization-specific login link with your users. Look for the "Login link" button next to
67+
your newly created Bitbucket Data Center / Server integration on the integrations page, and copy the URL.
68+
69+
![Bitbucket Data Center / Server integrations](/Resources/public/img/docs/integration-setup/cloud/bitbucket-server-oauth1-08-integrations-overview.png)
70+
71+
This link presents the option to authenticate with your Bitbucket Data Center / Server account and can now be used to log in to Private Packagist.
5272

5373
## Configure Bitbucket Server plugins
5474

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

+30-12
Original file line numberDiff line numberDiff line change
@@ -2,32 +2,50 @@
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>
7+
This guide explains how to set up an OAuth integration for Private Packagist Self-Hosted with the public service on Bitbucket.org.
8+
If you use Bitbucket Data Center / Server instead, consult <a href="/docs/self-hosted/bitbucket-server-integration-setup.md">this guide for Self-Hosted</a>.
9+
</p>
10+
<p>If you are using our Cloud product at packagist.com, this page is not relevant to you.</p>
711
</div>
812
</div>
913

10-
## Initial Setup
11-
Hit the “Add Integration“ button on the admin page to get to the form below.
14+
To allow your users to authenticate to Private Packagist Self-Hosted with their Bitbucket account, you'll
15+
first need to create an integration in Private Packagist. This document walks you through the required steps.
16+
17+
## Open the Add Integration form
18+
Go to the Admin section and hit the “Add Integration“ button to open the form to create your integration. If you've just
19+
installed Private Packagist Self-Hosted and it is still running in Setup Mode, you do not need to log in. If the application
20+
is no longer in Setup mode, you will have to log in with an admin account first.
1221

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

1524
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.
25+
A link to set up the OAuth application on Bitbucket will automatically be displayed.
1626

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

1929
## 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)
30+
Do not submit the integration form yet, the fields Client ID and Client Secret remain empty for now.
31+
Copy the content from the "Callback URL / Redirect URL" and open the setup link to your Bitbucket
32+
account. Replace the `<WORKSPACE_NAME>` string in the setup link with your actual Bitbucket workspace name.
2333

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

26-
![Bitbucket Form](/Resources/public/img/docs/integration-setup/bitbucket-03-bitbucket-reveal-key.png)
36+
Make sure all the scopes listed on the Private Packagist form are checked and save the new consumer. Click on the consumer
37+
you just created to reveal the credentials required to finish the setup on Private Packagist.
2738

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

3041
## Finish the Setup
3142
Copy and paste the "Key" and "Secret" values back into the Private Packagist integration form and submit the form with the "Create Integration" button.
3243

33-
![Bitbucket Form](/Resources/public/img/docs/integration-setup/bitbucket-04-packagist-form.png)
44+
![Bitbucket Form](/Resources/public/img/docs/integration-setup/self-hosted/bitbucket-04-packagist-form.png)
45+
46+
The Bitbucket integration will be created and you will be redirected to the admin page.
47+
48+
The new integration will be shown in the list of available integrations, and your users can
49+
now log in to your Private Packagist Self-Hosted installation using their Bitbucket account.
50+
51+
![Available integrations](/Resources/public/img/docs/integration-setup/self-hosted/bitbucket-05-integrations-overview.png)

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

+39-12
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,44 @@
11
# Bitbucket Data Center / Server Integration Setup
22
## Private Packagist Self-Hosted
33

4-
This guide explains how to setup an OAuth integration for Private Packagist Self-Hosted with Bitbucket Data Center / Server integration.
5-
If you are using our cloud product at packagist.com, [use this guide](../cloud/bitbucket-server-integration-setup.md).
4+
<div class="row column">
5+
<div class="callout success">
6+
<p>
7+
This guide explains how to set up an OAuth integration for Private Packagist Self-Hosted with Bitbucket Data Center / Server.
8+
If you use their public service on bitbucket.org, follow <a href="/docs/self-hosted/bitbucket-integration-setup.md">these instructions</a>.
9+
</p>
10+
<p>If you are using our Cloud product at packagist.com, <a href="/docs/cloud/bitbucket-server-integration-setup.md">use this guide</a>.</p>
11+
</div>
12+
</div>
613

714
<div class="row column">
815
<div class="callout warning">
916
<p>Note: Application Links using OAuth 2 are available since Bitbucket Data Center / Server v7.21. If you are using an older Bitbucket Data Center / Server version then consult the <a href="/docs/self-hosted/bitbucket-server-oauth1-integration-setup.md">Bitbucket Data Center / Server OAuth 1 setup guide</a>.</p>
1017
</div>
1118
</div>
1219

13-
## Initial Setup
14-
Hit the “Add integration“ button on the admin page to get to the form below.
20+
To allow your users to authenticate to Private Packagist Self-Hosted with their Bitbucket Data Center / Server account, you'll
21+
first need to create an integration in Private Packagist. This document walks you through the required steps.
22+
23+
## Open the Add Integration form
24+
Go to the Admin section and hit the “Add Integration“ button to open the form to create your integration. If you've just
25+
installed Private Packagist Self-Hosted and it is still running in Setup Mode, you do not need to log in. If the application
26+
is no longer in Setup mode, you will have to log in with an admin account first.
27+
28+
![Add Integration](/Resources/public/img/docs/self-hosted/08-integration-create.png)
29+
1530
To setup a Bitbucket Data Center / Server integration with Private Packagist, start by selecting "Bitbucket Data Center / Server"
16-
as the platform, enter the URL of your on-premise Bitbucket Data Center / Server into the base URL field and select OAuth 2 as the OAuth version as seen in the example below.
31+
as the platform, enter the URL of your on-premise Bitbucket Data Center / Server into the base URL field and select OAuth 2
32+
as the OAuth version as seen in the example below. A link to set up the OAuth application on your Bitbucket instance will automatically be displayed.
1733

18-
![Packagist Setup](/Resources/public/img/docs/integration-setup/bitbucket-server-01-packagist-setup.png)
34+
![Packagist Setup](/Resources/public/img/docs/integration-setup/self-hosted/bitbucket-server-01-packagist-setup.png)
1935

20-
Copy the content from the "Callback URL / Redirect URL" field and follow the link to set up an Application Link.
36+
## Create Application link
37+
Do not submit the integration form yet, but copy the content from the "Callback
38+
URL / Redirect URL" and follow the setup link to your Bitbucket Data Center / Server instance. The fields
39+
Client ID and Client Secret remain empty for now.
2140

22-
## Configure Application link
23-
Click on the link to setup an Application Link on Bitbucket Data Center / Server and select "External application" as type and "Incoming" as direction.
41+
In Bitbucket, click on the "Create link" button and select "External application" as type and "Incoming" as direction.
2442

2543
![Bitbucket Data Center / Server Create Application Link](/Resources/public/img/docs/integration-setup/bitbucket-server-02-bitbucket-create-application-link.png)
2644

@@ -29,12 +47,21 @@ Select Repositories "Read" as application permission and save the form.
2947

3048
![Bitbucket Data Center / Server Configure Application Link](/Resources/public/img/docs/integration-setup/bitbucket-server-03-bitbucket-configure-application-link.png)
3149

50+
Once the form is saved, Bitbucket Data Center / Server will show you the Client ID and secret.
51+
3252
## Finish the Setup
53+
Copy and paste the "Client ID" and "Client Secret" values back into the Private
54+
Packagist integration form and submit the form with the "Create Integration"
55+
button.
3356

34-
Once the form is saved, Bitbucket Data Center / Server will show you the Client ID and secret.
35-
Copy them over to Private Packagist and save the integration.
57+
![Packagist Finalize](/Resources/public/img/docs/integration-setup/self-hosted/bitbucket-server-04-packagist-finalize.png)
58+
59+
The Bitbucket integration will be created and you will be redirected to the admin page.
60+
61+
The new integration will be shown in the list of available integrations, and your users can
62+
now log in to your Private Packagist Self-Hosted installation using their Bitbucket Data Center / Server account.
3663

37-
![Packagist Finalize](/Resources/public/img/docs/integration-setup/bitbucket-server-04-packagist-finalize.png)
64+
![Available integrations](/Resources/public/img/docs/integration-setup/self-hosted/bitbucket-server-05-integrations-overview.png)
3865

3966
## Configure Bitbucket Server plugins
4067

0 commit comments

Comments
 (0)