docs(nx-cloud): update the enterprise auth docs
@ -23,10 +23,10 @@ And create a new consumer.
|
|||||||
Give the app a name. The callback URL is the important bit. It needs to be in this form:
|
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
|
[your-nx-cloud-url]/auth-callback
|
||||||
|
|
||||||
# for example
|
# for example
|
||||||
https://my-private-cloud-url:8080/auth/bitbucket/callback
|
https://my.nx-enterprise.url:8080/auth-callback
|
||||||
```
|
```
|
||||||
|
|
||||||
**Important:** Ensure there is **no backslash at the end of the "Callback URL"** (i.e. it matches the above pattern)
|
**Important:** Ensure there is **no backslash at the end of the "Callback URL"** (i.e. it matches the above pattern)
|
||||||
@ -45,7 +45,11 @@ Once you create, keep a note of the Key and the Secret:
|
|||||||
|
|
||||||
## Connect your Nx Cloud installation to your new app
|
## Connect your Nx Cloud installation to your new app
|
||||||
|
|
||||||
Provide the following env variables to the `nx-cloud-api` container:
|
Provide the following env variables to the `nx-cloud-frontend` container:
|
||||||
|
|
||||||
- `BITBUCKET_APP_ID`
|
- `BITBUCKET_APP_ID`
|
||||||
- `BITBUCKET_APP_SECRET`
|
- `BITBUCKET_APP_SECRET`
|
||||||
|
|
||||||
|
{% callout title="Helm Chart Environment Variables" %}
|
||||||
|
If you are using our Helm chart, you can find all the information you need about env variables in [the Helm chart repository](https://github.com/nrwl/nx-cloud-helm/blob/main/AUTH-GUIDE.md).
|
||||||
|
{% /callout %}
|
||||||
|
|||||||
@ -22,7 +22,12 @@ And create a new OAuth app:
|
|||||||
|
|
||||||
Give it a name, and a homepage URL. The authorization callback is the important bit. It needs to be in this form:
|
Give it a name, and a homepage URL. The authorization callback is the important bit. It needs to be in this form:
|
||||||
|
|
||||||
`[your-nx-cloud-url]/auth/github/callback`
|
```
|
||||||
|
[your-nx-cloud-url]/auth-callback
|
||||||
|
|
||||||
|
# for example
|
||||||
|
https://my.nx-enterprise.url:8080/auth-callback
|
||||||
|
```
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
@ -60,16 +65,18 @@ see [Nx Cloud Helm Charts](https://github.com/nrwl/nx-cloud-helm) for more conte
|
|||||||
|
|
||||||
### Not using Helm:
|
### Not using Helm:
|
||||||
|
|
||||||
Provide the following env variables to the `nx-cloud-api` container:
|
Provide the following env variables to the `nx-cloud-frontend` container:
|
||||||
|
|
||||||
- `GITHUB_AUTH_CLIENT_ID`
|
- `GITHUB_AUTH_CLIENT_ID`
|
||||||
- `GITHUB_AUTH_CLIENT_SECRET`
|
- `GITHUB_AUTH_CLIENT_SECRET`
|
||||||
|
|
||||||
> If you are running Nx Cloud as a single container, the two env vars should be provisioned for that container.
|
{% callout title="Helm Chart Environment Variables" %}
|
||||||
|
If you are using our Helm chart, you can find all the information you need about env variables in [the Helm chart repository](https://github.com/nrwl/nx-cloud-helm/blob/main/AUTH-GUIDE.md).
|
||||||
|
{% /callout %}
|
||||||
|
|
||||||
## GitHub Enterprise
|
## GitHub Enterprise
|
||||||
|
|
||||||
If you are running an on-premise version of GitHub (Enterprise Server), you will need to configure one additional
|
If you are running a self-hosted version of GitHub (Enterprise Server), you will need to configure one additional
|
||||||
environment variable:
|
environment variable:
|
||||||
|
|
||||||
`GITHUB_API_URL=https://custom-github-instance.com`
|
`GITHUB_API_URL=https://custom-github-instance.com`
|
||||||
|
|||||||
@ -14,7 +14,12 @@ Then "Applications" from the left-hand menu:
|
|||||||
|
|
||||||
Give the app a name. The authorization callback is the important bit. It needs to be in this form:
|
Give the app a name. The authorization callback is the important bit. It needs to be in this form:
|
||||||
|
|
||||||
`[your-nx-cloud-url]/auth/gitlab/callback`
|
```
|
||||||
|
[your-nx-cloud-url]/auth-callback
|
||||||
|
|
||||||
|
# for example
|
||||||
|
https://my.nx-enterprise.url:8080/auth-callback
|
||||||
|
```
|
||||||
|
|
||||||
**Important:** Ensure there is **no backslash at the end of the "Redirect URI"** (i.e. it matches the above pattern)
|
**Important:** Ensure there is **no backslash at the end of the "Redirect URI"** (i.e. it matches the above pattern)
|
||||||
|
|
||||||
@ -24,7 +29,7 @@ Ensure you grant it the "`read_user`" scope:
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
Click "Save".
|
Click "Save application".
|
||||||
|
|
||||||
Once you create, keep a note of the Client ID and the Secret:
|
Once you create, keep a note of the Client ID and the Secret:
|
||||||
|
|
||||||
@ -32,14 +37,18 @@ Once you create, keep a note of the Client ID and the Secret:
|
|||||||
|
|
||||||
## Connect your Nx Cloud installation to your new app
|
## Connect your Nx Cloud installation to your new app
|
||||||
|
|
||||||
Provide the following env variables to the `nx-cloud-api` container:
|
Provide the following env variables to the `nx-cloud-frontend` container:
|
||||||
|
|
||||||
- `GITLAB_APP_ID`
|
- `GITLAB_APP_ID`
|
||||||
- `GITLAB_APP_SECRET`
|
- `GITLAB_APP_SECRET`
|
||||||
|
|
||||||
## On-premise GitLab
|
{% callout title="Helm Chart Environment Variables" %}
|
||||||
|
If you are using our Helm chart, you can find all the information you need about env variables in [the Helm chart repository](https://github.com/nrwl/nx-cloud-helm/blob/main/AUTH-GUIDE.md).
|
||||||
|
{% /callout %}
|
||||||
|
|
||||||
If you are running an on-premise version of GitLab, you will need to configure one additional environment variable:
|
## Self-hosted GitLab
|
||||||
|
|
||||||
|
If you are running a self-hosted version of GitLab, you will need to configure one additional environment variable:
|
||||||
|
|
||||||
`GITLAB_API_URL=https://custom-gitlab-instance.com`
|
`GITLAB_API_URL=https://custom-gitlab-instance.com`
|
||||||
|
|
||||||
|
|||||||
@ -39,7 +39,7 @@ if you are interested.
|
|||||||
7. Add these configuration options
|
7. Add these configuration options
|
||||||
|
|
||||||
1. Configure the Identifier **exactly** as `nx-private-cloud`
|
1. Configure the Identifier **exactly** as `nx-private-cloud`
|
||||||
2. For the **Reply URL**, it should point to your Private Cloud instance URL. Make sure it ends with `/auth/saml/callback`
|
2. For the **Reply URL**, it should point to your Private Cloud instance URL. Make sure it ends with `/auth-callback`
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
|||||||
|
Before Width: | Height: | Size: 170 KiB After Width: | Height: | Size: 167 KiB |
|
Before Width: | Height: | Size: 48 KiB After Width: | Height: | Size: 64 KiB |
|
Before Width: | Height: | Size: 43 KiB After Width: | Height: | Size: 53 KiB |
|
Before Width: | Height: | Size: 161 KiB After Width: | Height: | Size: 198 KiB |
|
Before Width: | Height: | Size: 100 KiB After Width: | Height: | Size: 129 KiB |
|
Before Width: | Height: | Size: 92 KiB After Width: | Height: | Size: 168 KiB |
|
Before Width: | Height: | Size: 239 KiB After Width: | Height: | Size: 287 KiB |
|
Before Width: | Height: | Size: 133 KiB After Width: | Height: | Size: 168 KiB |