From 5caff90bff1e90e7d9a53bdbeb5a307c666ab441 Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Mon, 2 May 2022 11:55:20 +0200 Subject: [PATCH] docs: initial auth troubleshooting docs Signed-off-by: Patrik Oldsberg --- docs/auth/troubleshooting.md | 21 +++++++++++++++++++++ microsite/sidebars.json | 1 + mkdocs.yml | 1 + 3 files changed, 23 insertions(+) create mode 100644 docs/auth/troubleshooting.md diff --git a/docs/auth/troubleshooting.md b/docs/auth/troubleshooting.md new file mode 100644 index 0000000000..caae343407 --- /dev/null +++ b/docs/auth/troubleshooting.md @@ -0,0 +1,21 @@ +--- +id: troubleshooting +title: Troubleshooting Auth +description: Guidance for various issues that one might run into when setting up authentication +--- + +Auth is tricky and doesn't always work as expected. Below you'll find some of the common +problems one might run into when setting up authentication, as well as some general +troubleshooting tips. + +## Sign-in fails with "... provider is not configured to support sign-in" + +This happens if you try to sign in using an auth provider that has not been +configured to allow sign-in. See the [Sign-in Identities and Resolvers](./identity-resolver.md) +page for information about how to configure and customize sign-in. + +As part of the 1.1 release of Backstage we removed the default implementations +of all sign-in resolvers. This was a necessary security fix as well as a step +towards providing more clarity in the configuration of the sign-in process. +You may encounter this error if you are upgrading from a previous version, in +which case you would need to configure a sign-in resolver as described above. diff --git a/microsite/sidebars.json b/microsite/sidebars.json index 43e9dd3978..af37b44bac 100644 --- a/microsite/sidebars.json +++ b/microsite/sidebars.json @@ -254,6 +254,7 @@ "auth/auth-backend", "auth/oauth", "auth/auth-backend-classes", + "auth/troubleshooting", "auth/glossary" ], "Deployment": [ diff --git a/mkdocs.yml b/mkdocs.yml index 0e56dcbd73..6e4e795f95 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -157,6 +157,7 @@ nav: - Auth backend: 'auth/auth-backend.md' - OAuth and OpenID Connect: 'auth/oauth.md' - Auth backend classes: 'auth/auth-backend-classes.md' + - Troubleshooting Auth: 'auth/troubleshooting.md' - Glossary: 'auth/glossary.md' - Deployment: - Deploying Backstage: 'deployment/index.md'