finallycoffee
/
fediverse
2
0
Fork 0
Code Issues 1 Pull Requests 1 Projects Releases Wiki Activity

chore(gotosocial): extend README, fix typos

This commit is contained in:
transcaffeine 2023-07-28 19:30:56 +02:00
parent 1f2f89ff03
commit 327e4c746c
Signed by: transcaffeine
GPG Key ID: 03624C433676E465
2 changed files with 24 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
roles/gotosocial/README.md
View File

@ -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
```

2
roles/gotosocial/defaults/main.yml
View File

@ -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