docs(nx-cloud): bitbucket auth (#11452)
This commit is contained in:
parent
26ee770ac2
commit
a829270344
@ -797,6 +797,11 @@
|
||||
"id": "auth-gitlab",
|
||||
"file": "nx-cloud/private/auth-gitlab"
|
||||
},
|
||||
{
|
||||
"name": "Authenticate with BitBucket",
|
||||
"id": "auth-bitbucket",
|
||||
"file": "nx-cloud/private/auth-bitbucket"
|
||||
},
|
||||
{
|
||||
"name": "Advanced Configuration",
|
||||
"id": "advanced-config",
|
||||
|
||||
51
docs/nx-cloud/private/auth-bitbucket.md
Normal file
51
docs/nx-cloud/private/auth-bitbucket.md
Normal file
@ -0,0 +1,51 @@
|
||||
# BitBucket Auth
|
||||
|
||||
Nx Private Cloud currently only support **public** BitBucket auth. On-prem installation of BitBucket Server are currently not supported.
|
||||
|
||||
Before creating your container, you'll need to create a BitBucket "OAuth consumer" for your organisation.
|
||||
|
||||
## Creating a BitBucket OAuth consumer
|
||||
|
||||
From BitBucket, click on your profile picture and select your workspace:
|
||||
|
||||

|
||||
|
||||
Then "Settings":
|
||||
|
||||

|
||||
|
||||
Then "OAuth consumers":
|
||||
|
||||

|
||||
|
||||
And create a new consumer.
|
||||
|
||||
Give the app a name. The callback URL is the important bit. It needs to be in this form:
|
||||
|
||||
```
|
||||
[your-nx-cloud-url]/auth/bitbucket/callback
|
||||
|
||||
# for example
|
||||
https://my-private-cloud-url:8080/auth/bitbucket/callback
|
||||
```
|
||||
|
||||
**Important:** Ensure there is **no backslash at the end of the "Callback URL"** (i.e. it matches the above pattern)
|
||||
|
||||

|
||||
|
||||
Ensure you grant it the `account:read` and `account:email` scopes:
|
||||
|
||||

|
||||
|
||||
Save your changes.
|
||||
|
||||
Once you create, keep a note of the Key and the Secret:
|
||||
|
||||

|
||||
|
||||
## Connect your Nx Cloud installation to your new app
|
||||
|
||||
Provide the following env variables to the `nx-cloud-api` container:
|
||||
|
||||
- `BITBUCKET_APP_ID`
|
||||
- `BITBUCKET_APP_SECRET`
|
||||
@ -35,6 +35,7 @@ For instructions on how to set up third-party auth providers please refer to the
|
||||
|
||||
- [GitHub Auth](/nx-cloud/private-cloud/auth-github)
|
||||
- [GitLab Auth](/nx-cloud/private-cloud/auth-gitlab)
|
||||
- [BitBucket Auth](/nx-cloud/private-cloud/auth-bitbucket)
|
||||
|
||||
## Inviting users
|
||||
|
||||
|
||||
@ -21,4 +21,5 @@ documented.
|
||||
- [Auth (Basic)](/nx-cloud/private-cloud/auth-single-admin)
|
||||
- [GitHub Auth](/nx-cloud/private-cloud/auth-github)
|
||||
- [GitLab Auth](/nx-cloud/private-cloud/auth-gitlab)
|
||||
- [BitBucket Auth](/nx-cloud/private-cloud/auth-bitbucket)
|
||||
- [Advanced Configuration](/nx-cloud/private-cloud/advanced-config)
|
||||
|
||||
BIN
docs/nx-cloud/private/images/bitbucket_1.png
Normal file
BIN
docs/nx-cloud/private/images/bitbucket_1.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 76 KiB |
BIN
docs/nx-cloud/private/images/bitbucket_2.png
Normal file
BIN
docs/nx-cloud/private/images/bitbucket_2.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 42 KiB |
BIN
docs/nx-cloud/private/images/bitbucket_3.png
Normal file
BIN
docs/nx-cloud/private/images/bitbucket_3.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 32 KiB |
BIN
docs/nx-cloud/private/images/bitbucket_4.png
Normal file
BIN
docs/nx-cloud/private/images/bitbucket_4.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 194 KiB |
BIN
docs/nx-cloud/private/images/bitbucket_5.png
Normal file
BIN
docs/nx-cloud/private/images/bitbucket_5.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 131 KiB |
BIN
docs/nx-cloud/private/images/bitbucket_6.png
Normal file
BIN
docs/nx-cloud/private/images/bitbucket_6.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 100 KiB |
@ -79,6 +79,10 @@ xdescribe('nx-dev: Nx Cloud section', () => {
|
||||
title: 'Nx Private Cloud GitLab Auth',
|
||||
path: '/nx-cloud/private-cloud/auth-gitlab',
|
||||
},
|
||||
{
|
||||
title: 'Nx Private Cloud BitBucket Auth',
|
||||
path: '/nx-cloud/private-cloud/auth-bitbucket',
|
||||
},
|
||||
{
|
||||
title: 'Advanced Configuration',
|
||||
path: '/nx-cloud/private-cloud/advanced-config',
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user