diff --git a/README.md b/README.md index e4bfdff..c7c307d 100644 --- a/README.md +++ b/README.md @@ -116,6 +116,14 @@ And to promote them as an administrator of your instance: ./gotosocial --config-path config.yaml admin account promote --username some_username ``` +#### OpenID Connect + +To use OpenID Connect, the YunoHost admin must: + +* install the [dex_ynh](https://github.com/YunoHost-Apps/dex_ynh) package +* configure Dex properly during the installation (all entered information will be used in the next step, so keep it in a safe place) +* configure GTS using the config panel's OIDC form: `Applications > GoToSocial > Config Panel > OpenID Connect settings` + ## :red_circle: Antifeatures - **Alpha software**: Early development stage. May contain changing or unstable features, bugs, and security vulnerability.