diff --git a/docs/configuration.md b/docs/configuration.md index d903a21e..a8fa07de 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -11,6 +11,7 @@ Conduit's configuration file is divided into the following sections: - [Global](#global) - [TLS](#tls) - [Proxy](#proxy) + - [SSO (Single Sign-On)](#sso) ## Global @@ -109,3 +110,39 @@ exclude = ["*.clearnet.onion"] [global] {{#include ../conduit-example.toml:22:}} ``` + +### SSO (Single Sign-On) + +Authentication through SSO instead of a password can be enabled by configuring OIDC (OpenID Connect) identity providers. +Identity providers using OAuth such as Github are not supported yet. + +> **Note:** The `*` symbol indicates that the field is required, and the values in **parentheses** are the possible values + +| Field | Type | Description | Default | +| --- | --- | --- | --- | +| `issuer`* | `Url` | The issuer URL. | N/A | +| `name` | `string` | The name displayed on fallback pages. | `issuer` | +| `icon` | `Url` OR `MxcUri` | The icon displayed on fallback pages. | N/A | +| `scopes` | `array` | The scopes used to obtain extra claims which can be used for templates. | `["openid"]` | + + + + +| `client_id`* | `string` | The provider-supplied, unique ID for the client. | N/A | +| `client_secret`* | `string` | The provider-supplied, unique ID for the client. | N/A | +| `authentication_method`* | `"basic" | "post"` | The method used for client authentication. | N/A | + + + + + + + + + + + + + + +