finallycoffee/matrix-docker-ansible-deploy
5
1
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Use common expression on documentation regarding playbook configuration

Browse Source 
Overall the playbook uses the expression "Add the following configuration to your `inventory/host_vars/matrix.DOMAIN/vars.yml` file:" with the heading "Adjusting the playbook configuration" for sections to explain what to be added as variables

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
This commit is contained in:
Suguru Hirahara
2024-10-12 20:48:24 +09:00
parent a4bfb9611e
commit bf5373479b
54 changed files with 150 additions and 112 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/configuring-playbook-ma1sd.md
View File

@ -10,14 +10,15 @@ This server is private by default, potentially at the expense of user discoverab
**Note**: enabling ma1sd, means that the `openid` API endpoints will be exposed on the Matrix Federation port (usually `8448`), even if [federation](configuring-playbook-federation.md) is disabled. It's something to be aware of, especially in terms of firewall whitelisting (make sure port `8448` is accessible).
To enable ma1sd, use the following additional configuration in your `vars.yml` file:
## Adjusting the playbook configuration
To enable ma1sd, add the following configuration to your `inventory/host_vars/matrix.DOMAIN/vars.yml` file:
```yaml
matrix_ma1sd_enabled: true
```
## Matrix.org lookup forwarding
### Matrix.org lookup forwarding
To ensure maximum discovery, you can make your identity server also forward lookups to the central matrix.org Identity server (at the cost of potentially leaking all your contacts information).
@ -29,8 +30,7 @@ Enabling matrix.org forwarding can happen with the following configuration:
matrix_ma1sd_matrixorg_forwarding_enabled: true
```
## Customizing email templates
### Customizing email templates
If you'd like to change the default email templates used by ma1sd, take a look at the `matrix_ma1sd_threepid_medium_email_custom_` variables
(in the `roles/custom/matrix-ma1sd/defaults/main.yml` file.