Skip to content

Commit 4cf4d66

Browse files
committed
docs: update OIDC authentication guide with auto launch option
- Add documentation for `autoOidcLaunch` parameter - Clarify how to access authentication page when local auth is disabled - Improve explanation of OIDC authentication flow
1 parent 07b630d commit 4cf4d66

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

docs/content/guides/authentication.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -25,14 +25,17 @@ Once these are set, restart your Ryot instance and you should be able to see the
2525
"Continue with OpenID Connect" on the authentication pages. New users will have their
2626
username set to their email address. This can be changed later in the profile settings.
2727

28+
You can set `USERS_DISABLE_LOCAL_AUTH=true` to disable local authentication and only allow
29+
users to authenticate using OIDC. When OIDC is enabled and local authentication is
30+
disabled, users will be redirected to the OIDC provider when they visit the auth page. To
31+
see the authentication page anyway, you can visit
32+
`<FRONTEND_URL>/auth?autoOidcLaunch=false`.
33+
2834
!!! warning
2935

3036
A user can either have a username/password or it can use your OIDC provider to
3137
authenticate but not both.
3238

33-
You can set `USERS_DISABLE_LOCAL_AUTH=true` to disable local authentication and only allow
34-
users to authenticate using OIDC.
35-
3639
### Converting a local user to an OIDC user
3740

3841
- Setup OpenID on your instance using the the above guide.

0 commit comments

Comments
 (0)