From 879f27f59644687da95547e05cf8c0c43fd28bcf Mon Sep 17 00:00:00 2001 From: Max Gardner Date: Wed, 6 Mar 2019 21:27:50 -0600 Subject: [PATCH] Clarify that base_url should contain only hostname If users include any path in their base_url, the postMessage does not work. --- website/content/docs/authentication-backends.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/content/docs/authentication-backends.md b/website/content/docs/authentication-backends.md index 57d8665a8442..c238864e5ef3 100644 --- a/website/content/docs/authentication-backends.md +++ b/website/content/docs/authentication-backends.md @@ -178,5 +178,5 @@ Netlify CMS backends allow some additional fields for certain use cases. A full | `branch` | `master` | The branch where published content is stored. All CMS commits and PRs are made to this branch. | | `api_root` | `https://api.github.com` (GitHub), `https://gitlab.com/api/v4` (GitLab), or `https://api.bitbucket.org/2.0` (Bitbucket) | The API endpoint. Only necessary in certain cases, like with GitHub Enterprise or self-hosted GitLab. | | `site_domain` | `location.hostname` (or `cms.netlify.com` when on `localhost`) | Sets the `site_id` query param sent to the API endpoint. Non-Netlify auth setups will often need to set this for local development to work properly. | -| `base_url` | `https://api.netlify.com` (GitHub, Bitbucket) or `https://gitlab.com` (GitLab) | OAuth client URL. **Required** when using an external OAuth server or self-hosted GitLab. | +| `base_url` | `https://api.netlify.com` (GitHub, Bitbucket) or `https://gitlab.com` (GitLab) | OAuth client hostname (just the base domain, no path). **Required** when using an external OAuth server or self-hosted GitLab. | | `auth_endpoint` | `auth` (GitHub, Bitbucket) or `oauth/authorize` (GitLab) | Path to append to `base_url` for authentication requests. Optional. |