From 327e4c746ce32972333e3cd59b15ba526d2b0bb2 Mon Sep 17 00:00:00 2001 From: Johanna Dorothea Reichmann Date: Fri, 28 Jul 2023 19:30:56 +0200 Subject: [PATCH] chore(gotosocial): extend README, fix typos --- roles/gotosocial/README.md | 24 +++++++++++++++++++++++- roles/gotosocial/defaults/main.yml | 2 +- 2 files changed, 24 insertions(+), 2 deletions(-) diff --git a/roles/gotosocial/README.md b/roles/gotosocial/README.md index 92d50ce..4185f42 100644 --- a/roles/gotosocial/README.md +++ b/roles/gotosocial/README.md @@ -1,8 +1,18 @@ # `finallycoffee.fediverse.gotosocial` ansible role - ## Configuration +The server name can be set using `gotosocial_config_host`, with `gotosocial_config_account_domain` being available when webfinger delegation is used: + +```yaml +gotosocial_config_host: gotosocial.example.org +gotosocial_config_account_domain: example.org +``` + +### Database + +The database can be configured using the `gotosocial_config_db_[address|port|user|password|database]` variables. the `[...]_type` defaults to `postgres`. + ### Built-in LetsEncrypt client To use the built-in letsencrypt client, set `gotosocial_config_letsencrypt_enabled: true`. @@ -22,3 +32,15 @@ but with multiple acme clients all performing HTTP-01 challenges, you need to ma overwrite `gotosocial_container_ports` to fit your needs. ### Advanced configuration + +#### OIDC + +OIDC can be configured using `gotosocial_config_oidc_*` variables, disabled by default. A minimal configuration could look like this: + +```yaml +gotosocial_config_oidc_enabled: true +gotosocial_config_oidc_idp_name: "My fancy name for the configured IdP" +gotosocial_config_oidc_issuer: http://issuer/url +gotosocial_config_oidc_client_id: my_client_id +gotosocial_config_oidc_client_secret: my_client_secret +``` diff --git a/roles/gotosocial/defaults/main.yml b/roles/gotosocial/defaults/main.yml index 6a63eda..0c697bf 100644 --- a/roles/gotosocial/defaults/main.yml +++ b/roles/gotosocial/defaults/main.yml @@ -43,7 +43,7 @@ gotosocial_config_instance_expose_peers: false gotosocial_config_expose_suspended: false # account config -gotosocial_config_acounts_registration_open: true +gotosocial_config_accounts_registration_open: true gotosocial_config_accounts_approval_required: true gotosocial_config_accounts_reason_required: true