mirror of
https://github.com/lennart-k/rustical.git
synced 2025-12-14 02:22:21 +00:00
First attempt at some documentation
This commit is contained in:
34
docs/setup/oidc.md
Normal file
34
docs/setup/oidc.md
Normal file
@@ -0,0 +1,34 @@
|
||||
# OpenID Connect
|
||||
|
||||
You can set up RustiCal with an OpenID Connect identity provider
|
||||
|
||||
## Example: Authelia
|
||||
|
||||
```toml title="RustiCal configuration"
|
||||
[frontend.oidc]
|
||||
name = "Authelia"
|
||||
issuer = "https://auth.example.com"
|
||||
client_id = "rustical"
|
||||
client_secret = "secret..."
|
||||
claim_userid = "preferred_username" # (1)!
|
||||
scopes = ["openid", "profile", "groups"]
|
||||
require_group = "app/rustical" # (2)!
|
||||
allow_sign_up = false
|
||||
```
|
||||
|
||||
1. Can be either `preferred_username` or `sub`
|
||||
2. Optional: You can require a user to be in a certain group to use RustiCal
|
||||
|
||||
```yaml title="Authelia configuration"
|
||||
identity_providers:
|
||||
oidc:
|
||||
clients:
|
||||
- client_id: rustical
|
||||
client_secret: secret...
|
||||
public: false
|
||||
consent_mode: implicit
|
||||
scopes: [openid, profile, groups]
|
||||
token_endpoint_auth_method: client_secret_basic
|
||||
redirect_uris:
|
||||
- https://rustical.example.com/frontend/login/oidc/callback
|
||||
```
|
||||
Reference in New Issue
Block a user