docs(nx-cloud): bitbucket auth (#11452)

This commit is contained in:
Rares Matei 2022-08-05 15:12:42 +01:00 committed by GitHub
parent 26ee770ac2
commit a829270344
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
11 changed files with 62 additions and 0 deletions

View File

@ -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",

View 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:
![Step 1](/nx-cloud/private/images/bitbucket_1.png)
Then "Settings":
![Step 2](/nx-cloud/private/images/bitbucket_2.png)
Then "OAuth consumers":
![Step 3](/nx-cloud/private/images/bitbucket_3.png)
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)
![Step 4](/nx-cloud/private/images/bitbucket_4.png)
Ensure you grant it the `account:read` and `account:email` scopes:
![Step 5](/nx-cloud/private/images/bitbucket_5.png)
Save your changes.
Once you create, keep a note of the Key and the Secret:
![Step 6](/nx-cloud/private/images/bitbucket_6.png)
## 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`

View File

@ -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

View File

@ -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)

Binary file not shown.

After

Width:  |  Height:  |  Size: 76 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 42 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 32 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 194 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 131 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 100 KiB

View File

@ -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',