3pp-mirror/rallly
1
0
Fork 0
mirror of https://github.com/lukevella/rallly.git synced 2025-06-01 02:01:48 +02:00
Code Issues Projects Releases Packages Wiki Activity

📝 Update SSO docs

Browse source
This commit is contained in:
Luke Vella 2023-11-26 13:08:42 +07:00
parent f7c8e8269b
commit 183ab09daa
6 changed files with 75 additions and 53 deletions
Download patch file Download diff file Expand all files Collapse all files

46
apps/docs/self-hosting/configuration-options.mdx
View file

@ -69,48 +69,6 @@ These variables need to be configured to let Rallly send out transactional email
Enable TLS for your SMTP connection
</ParamField>
### Single Sign On (SSO) with OpenID Connect (OIDC)
### Single Sign On (SSO)
To enable SSO with an OIDC compliant identity provider you will need to configure the following variables.
<ParamField path="OIDC_ENABLED">
Must be set to `true` to enable OIDC Login
</ParamField>
<ParamField path="OIDC_NAME" default="OpenID Connect">
The user-facing name of your provider as it will be shown on the login page
</ParamField>
<ParamField path="OIDC_DISCOVERY_URL">
URL of the `.well-known/openid-configuration` endpoint for your OIDC provider
</ParamField>
<ParamField path="OIDC_CLIENT_ID">
The client ID of your OIDC application
</ParamField>
<ParamField path="OIDC_CLIENT_SECRET">
The client secret of your OIDC application
</ParamField>
#### Required Scopes
The following scopes are required for OIDC to function properly.
- `openid`: Essential for OIDC to function, used to perform authentication.
- `profile`: Access to the user's personal information such as name and picture.
- `email`: Access to the user's email address.
#### Callback URL / Redirect URI
The callback URL for your OIDC application must be set to:
```
{NEXT_PUBLIC_BASE_URL}/api/auth/callback/oidc
```
<Info>
Replace `{NEXT_PUBLIC_BASE_URL}` with the base URL of your Rallly instance.
</Info>
Ensure this URL is added to the list of allowed redirect URIs in your OIDC provider's application settings.
Go to [Single Sign On](/self-hosting/sso) for information on how to configure SSO.