diff --git a/docs/nx-cloud/private/auth-bitbucket.md b/docs/nx-cloud/private/auth-bitbucket.md index ad12dd0b42..37fbe7f3ec 100644 --- a/docs/nx-cloud/private/auth-bitbucket.md +++ b/docs/nx-cloud/private/auth-bitbucket.md @@ -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: ``` -[your-nx-cloud-url]/auth/bitbucket/callback +[your-nx-cloud-url]/auth-callback # 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) @@ -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 -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_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 %} diff --git a/docs/nx-cloud/private/auth-github.md b/docs/nx-cloud/private/auth-github.md index 4994b76f59..ad563fda3e 100644 --- a/docs/nx-cloud/private/auth-github.md +++ b/docs/nx-cloud/private/auth-github.md @@ -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: -`[your-nx-cloud-url]/auth/github/callback` +``` +[your-nx-cloud-url]/auth-callback + +# for example +https://my.nx-enterprise.url:8080/auth-callback +``` ![Step 5](/nx-cloud/private/images/github_auth_step_5.png) @@ -60,16 +65,18 @@ see [Nx Cloud Helm Charts](https://github.com/nrwl/nx-cloud-helm) for more conte ### 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_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 -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: `GITHUB_API_URL=https://custom-github-instance.com` diff --git a/docs/nx-cloud/private/auth-gitlab.md b/docs/nx-cloud/private/auth-gitlab.md index 19f4b955fa..d610458d81 100644 --- a/docs/nx-cloud/private/auth-gitlab.md +++ b/docs/nx-cloud/private/auth-gitlab.md @@ -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: -`[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) @@ -24,7 +29,7 @@ Ensure you grant it the "`read_user`" scope: ![Step 4](/nx-cloud/private/images/gitlab_step_4.png) -Click "Save". +Click "Save application". 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 -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_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` diff --git a/docs/nx-cloud/private/auth-saml.md b/docs/nx-cloud/private/auth-saml.md index dfba392516..2f13789e7a 100644 --- a/docs/nx-cloud/private/auth-saml.md +++ b/docs/nx-cloud/private/auth-saml.md @@ -39,7 +39,7 @@ if you are interested. 7. Add these configuration options 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` ![Step 8](/nx-cloud/private/images/saml/azure_8.png) diff --git a/docs/nx-cloud/private/images/github_auth_step_5.png b/docs/nx-cloud/private/images/github_auth_step_5.png index 1bdb109460..1aa09d0c3e 100644 Binary files a/docs/nx-cloud/private/images/github_auth_step_5.png and b/docs/nx-cloud/private/images/github_auth_step_5.png differ diff --git a/docs/nx-cloud/private/images/gitlab_step_1.png b/docs/nx-cloud/private/images/gitlab_step_1.png index fef273c0dc..012688f9d6 100644 Binary files a/docs/nx-cloud/private/images/gitlab_step_1.png and b/docs/nx-cloud/private/images/gitlab_step_1.png differ diff --git a/docs/nx-cloud/private/images/gitlab_step_2.png b/docs/nx-cloud/private/images/gitlab_step_2.png index a172655586..15b2f9863e 100644 Binary files a/docs/nx-cloud/private/images/gitlab_step_2.png and b/docs/nx-cloud/private/images/gitlab_step_2.png differ diff --git a/docs/nx-cloud/private/images/gitlab_step_3.png b/docs/nx-cloud/private/images/gitlab_step_3.png index 308937ac1b..76e79b41b1 100644 Binary files a/docs/nx-cloud/private/images/gitlab_step_3.png and b/docs/nx-cloud/private/images/gitlab_step_3.png differ diff --git a/docs/nx-cloud/private/images/gitlab_step_4.png b/docs/nx-cloud/private/images/gitlab_step_4.png index adb4473c03..4ce2cc1f97 100644 Binary files a/docs/nx-cloud/private/images/gitlab_step_4.png and b/docs/nx-cloud/private/images/gitlab_step_4.png differ diff --git a/docs/nx-cloud/private/images/gitlab_step_5.png b/docs/nx-cloud/private/images/gitlab_step_5.png index 5119326eec..ee05685d7c 100644 Binary files a/docs/nx-cloud/private/images/gitlab_step_5.png and b/docs/nx-cloud/private/images/gitlab_step_5.png differ diff --git a/docs/nx-cloud/private/images/saml/azure_8.png b/docs/nx-cloud/private/images/saml/azure_8.png index 026b01d3ba..c4dbc06091 100644 Binary files a/docs/nx-cloud/private/images/saml/azure_8.png and b/docs/nx-cloud/private/images/saml/azure_8.png differ diff --git a/docs/nx-cloud/private/images/saml/okta_4.png b/docs/nx-cloud/private/images/saml/okta_4.png index c2b4d62290..658b1a4836 100644 Binary files a/docs/nx-cloud/private/images/saml/okta_4.png and b/docs/nx-cloud/private/images/saml/okta_4.png differ