From 52f91da67876e911e7ce05cced659252a76bbe4f Mon Sep 17 00:00:00 2001 From: Josh Maxwell Date: Mon, 24 Oct 2022 22:21:12 -0600 Subject: [PATCH] Adding notes about using a custom callbackUrl with the GitLab Auth provider Signed-off-by: Josh Maxwell --- docs/auth/gitlab/provider.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/auth/gitlab/provider.md b/docs/auth/gitlab/provider.md index c587f60aa9..15488bc4c1 100644 --- a/docs/auth/gitlab/provider.md +++ b/docs/auth/gitlab/provider.md @@ -35,6 +35,8 @@ auth: clientSecret: ${AUTH_GITLAB_CLIENT_SECRET} ## uncomment if using self-hosted GitLab # audience: https://gitlab.company.com + ## uncomment if using a custom redirect URI + # callbackUrl: https://${BASE_URL}/api/auth/gitlab/handler/frame ``` The GitLab provider is a structure with three configuration keys: @@ -44,6 +46,9 @@ The GitLab provider is a structure with three configuration keys: - `clientSecret`: The Application secret - `audience` (optional): The base URL for the self-hosted GitLab instance, e.g. `https://gitlab.company.com` +- `callbackUrl` (optional): The URL matching the Redirect URI registered when creating your GitLab OAuth App, e.g. + `https://$backstage.acme.corp/api/auth/gitlab/handler/frame` + Note: Due to a peculiarity with GitLab OAuth, ensure there is no trailing `/` after 'frame' in the URL. ## Adding the provider to the Backstage frontend