From 486dda4a10dcdb163b974b95f6f90a52938f5b14 Mon Sep 17 00:00:00 2001 From: Peter Macdonald Date: Wed, 29 Jan 2025 10:37:57 +0100 Subject: [PATCH 1/4] adds some additional information to the guest provider thats not immediately obvious Signed-off-by: Peter Macdonald --- docs/auth/guest/provider.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docs/auth/guest/provider.md b/docs/auth/guest/provider.md index b541178571..4045db3148 100644 --- a/docs/auth/guest/provider.md +++ b/docs/auth/guest/provider.md @@ -63,3 +63,20 @@ auth: # highlight-add-next-line guest: {} ``` + +The above is all you need to get working with the guest provider. However, you can also add additional configuration if you need to such as the following: + +```yaml title="app-config.local.yaml" +auth: + providers: + guest: + userEntityRef: user:default/john-smith + ownershipEntityRefs: [group:default/smith-family] + dangerouslyAllowOutsideDevelopment: false +``` + +The `userEntityRef` is used as the entity reference for the guest user and the `ownershipEntityRefs` is a list of entity references to user for ownership of the guest user if the user is not found in the catalog. + +The `dangerouslyAllowOutsideDevelopment` flag is used to allow users to sign in with the guest provider outside of their development environments. + +You can find this information by looking at the config file [here](https://github.com/backstage/backstage/blob/master/plugins/auth-backend-module-guest-provider/config.d.ts) From e470cc49a4d331141b8a1d8b2b6e4a311cb346c7 Mon Sep 17 00:00:00 2001 From: Peter Macdonald Date: Wed, 29 Jan 2025 15:30:43 +0100 Subject: [PATCH 2/4] Update docs/auth/guest/provider.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Fredrik Adelöw Signed-off-by: Peter Macdonald --- docs/auth/guest/provider.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/auth/guest/provider.md b/docs/auth/guest/provider.md index 4045db3148..d593a44f32 100644 --- a/docs/auth/guest/provider.md +++ b/docs/auth/guest/provider.md @@ -75,7 +75,7 @@ auth: dangerouslyAllowOutsideDevelopment: false ``` -The `userEntityRef` is used as the entity reference for the guest user and the `ownershipEntityRefs` is a list of entity references to user for ownership of the guest user if the user is not found in the catalog. +The `userEntityRef` is used as the entity reference for the guest user and the `ownershipEntityRefs` is a list of entity references to use for ownership of the guest user, if the user is not found in the catalog. The `dangerouslyAllowOutsideDevelopment` flag is used to allow users to sign in with the guest provider outside of their development environments. From c5fa051925a75b115b3422952953ec998a3a0448 Mon Sep 17 00:00:00 2001 From: Peter Macdonald Date: Wed, 29 Jan 2025 15:30:59 +0100 Subject: [PATCH 3/4] Update docs/auth/guest/provider.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Fredrik Adelöw Signed-off-by: Peter Macdonald --- docs/auth/guest/provider.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/auth/guest/provider.md b/docs/auth/guest/provider.md index d593a44f32..0a3c46c757 100644 --- a/docs/auth/guest/provider.md +++ b/docs/auth/guest/provider.md @@ -77,6 +77,6 @@ auth: The `userEntityRef` is used as the entity reference for the guest user and the `ownershipEntityRefs` is a list of entity references to use for ownership of the guest user, if the user is not found in the catalog. -The `dangerouslyAllowOutsideDevelopment` flag is used to allow users to sign in with the guest provider outside of their development environments. +The `dangerouslyAllowOutsideDevelopment` flag is used to allow users to sign in with the guest provider outside of their development environments, e.g. in production. You can find this information by looking at the config file [here](https://github.com/backstage/backstage/blob/master/plugins/auth-backend-module-guest-provider/config.d.ts) From e80dbc5b95588590916f82a1f715fdef89b5365b Mon Sep 17 00:00:00 2001 From: Peter Macdonald Date: Wed, 29 Jan 2025 15:31:10 +0100 Subject: [PATCH 4/4] Update docs/auth/guest/provider.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Fredrik Adelöw Signed-off-by: Peter Macdonald --- docs/auth/guest/provider.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/auth/guest/provider.md b/docs/auth/guest/provider.md index 0a3c46c757..5072aabe50 100644 --- a/docs/auth/guest/provider.md +++ b/docs/auth/guest/provider.md @@ -79,4 +79,4 @@ The `userEntityRef` is used as the entity reference for the guest user and the ` The `dangerouslyAllowOutsideDevelopment` flag is used to allow users to sign in with the guest provider outside of their development environments, e.g. in production. -You can find this information by looking at the config file [here](https://github.com/backstage/backstage/blob/master/plugins/auth-backend-module-guest-provider/config.d.ts) +You can find this information by looking at the config file [here](https://github.com/backstage/backstage/blob/master/plugins/auth-backend-module-guest-provider/config.d.ts).