Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>pull/3911/head
| @@ -6,7 +6,7 @@ The playbook can install and configure [Heisenbridge](https://github.com/hifi/he | |||||
| See the project's [documentation](https://github.com/hifi/heisenbridge/blob/master/README.md) to learn what it does and why it might be useful to you. You can also take a look at [this demonstration video](https://www.youtube.com/watch?v=nQk1Bp4tk4I). | See the project's [documentation](https://github.com/hifi/heisenbridge/blob/master/README.md) to learn what it does and why it might be useful to you. You can also take a look at [this demonstration video](https://www.youtube.com/watch?v=nQk1Bp4tk4I). | ||||
| ## Configuration | |||||
| ## Adjusting the playbook configuration | |||||
| To enable Heisenbridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file: | To enable Heisenbridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file: | ||||
| @@ -14,7 +14,7 @@ The playbook contains 2 roles for configuring different pieces of the Cactus Com | |||||
| You can enable whichever component you need (typically both). | You can enable whichever component you need (typically both). | ||||
| ## Configuration | |||||
| ## Adjusting the playbook configuration | |||||
| To enable Cactus Comments, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file: | To enable Cactus Comments, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file: | ||||
| @@ -8,7 +8,7 @@ See the project's [documentation](https://github.com/devture/email2matrix/blob/m | |||||
| ## Preparation | ## Preparation | ||||
| ### DNS configuration | |||||
| ## Adjusting DNS records | |||||
| It's not strictly necessary, but you may increase the chances that incoming emails reach your server by adding an `MX` record for `matrix.example.com`, as described in the [Configuring DNS](configuring-dns.md) documentation page. | It's not strictly necessary, but you may increase the chances that incoming emails reach your server by adding an `MX` record for `matrix.example.com`, as described in the [Configuring DNS](configuring-dns.md) documentation page. | ||||
| @@ -30,7 +30,7 @@ matrix_mautrix_SERVICENAME_configuration_extension_yaml: | | |||||
| '@alice:{{ matrix_domain }}': admin | '@alice:{{ matrix_domain }}': admin | ||||
| ``` | ``` | ||||
| ## encryption | |||||
| ### Encryption | |||||
| Encryption support is off by default. If you would like to enable encryption, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file: | Encryption support is off by default. If you would like to enable encryption, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file: | ||||
| @@ -48,7 +48,7 @@ matrix_mautrix_SERVICENAME_bridge_encryption_enabled: true | |||||
| matrix_mautrix_SERVICENAME_bridge_encryption_default: true | matrix_mautrix_SERVICENAME_bridge_encryption_default: true | ||||
| ``` | ``` | ||||
| ## relay mode | |||||
| ### Relay mode | |||||
| Relay mode is off by default. If you would like to enable relay mode, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file: | Relay mode is off by default. If you would like to enable relay mode, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file: | ||||
| @@ -79,7 +79,7 @@ matrix_mautrix_SERVICENAME_configuration_extension_yaml: | | |||||
| default: true | default: true | ||||
| ``` | ``` | ||||
| ## Setting the bot's username | |||||
| ### Setting the bot's username | |||||
| ```yaml | ```yaml | ||||
| matrix_mautrix_SERVICENAME_appservice_bot_username: "BOTNAME" | matrix_mautrix_SERVICENAME_appservice_bot_username: "BOTNAME" | ||||
| @@ -87,7 +87,7 @@ matrix_mautrix_SERVICENAME_appservice_bot_username: "BOTNAME" | |||||
| Can be used to set the username for the bridge. | Can be used to set the username for the bridge. | ||||
| ## Discovering additional configuration options | |||||
| ### Extending the configuration | |||||
| You may wish to look at `roles/custom/matrix-bridge-mautrix-SERVICENAME/templates/config.yaml.j2` and `roles/custom/matrix-bridge-mautrix-SERVICENAME/defaults/main.yml` to find other things you would like to configure. | You may wish to look at `roles/custom/matrix-bridge-mautrix-SERVICENAME/templates/config.yaml.j2` and `roles/custom/matrix-bridge-mautrix-SERVICENAME/defaults/main.yml` to find other things you would like to configure. | ||||
| @@ -12,7 +12,7 @@ To make use of this, you need to install [Prometheus](./configuring-playbook-pro | |||||
| If your setup includes [Grafana](./configuring-playbook-prometheus-grafana.md), a dedicated `NGINX PROXY` Grafana dashboard will be created. | If your setup includes [Grafana](./configuring-playbook-prometheus-grafana.md), a dedicated `NGINX PROXY` Grafana dashboard will be created. | ||||
| ## Configuration | |||||
| ## Adjusting the playbook configuration | |||||
| Add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file: | Add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file: | ||||
| @@ -8,7 +8,7 @@ See the project's [documentation](https://github.com/matrix-org/synapse-auto-acc | |||||
| **Note**: Synapse [v1.109.0](https://github.com/element-hq/synapse/releases/tag/v1.109.0), the same feature [has been merged](https://github.com/element-hq/synapse/pull/17147) into Synapse (see the [Native alternative](#native-alternative) section below). You'd better use the native feature, instead of the [synapse-auto-invite-accept](https://github.com/matrix-org/synapse-auto-accept-invite) 3rd party module. | **Note**: Synapse [v1.109.0](https://github.com/element-hq/synapse/releases/tag/v1.109.0), the same feature [has been merged](https://github.com/element-hq/synapse/pull/17147) into Synapse (see the [Native alternative](#native-alternative) section below). You'd better use the native feature, instead of the [synapse-auto-invite-accept](https://github.com/matrix-org/synapse-auto-accept-invite) 3rd party module. | ||||
| ## Configuration | |||||
| ## Adjusting the playbook configuration | |||||
| If you decide that you'd like to let this playbook install the [synapse-auto-invite-accept](https://github.com/matrix-org/synapse-auto-accept-invite module for you, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file: | If you decide that you'd like to let this playbook install the [synapse-auto-invite-accept](https://github.com/matrix-org/synapse-auto-accept-invite module for you, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file: | ||||
| @@ -21,7 +21,7 @@ You can run some scripts to delete the local files once in a while (which we do | |||||
| While you will need some local disk space around, it's only to accommodate usage, etc., and won't grow as large as your S3 store. | While you will need some local disk space around, it's only to accommodate usage, etc., and won't grow as large as your S3 store. | ||||
| ## Installing | |||||
| ## Adjusting the playbook configuration | |||||
| After [creating the S3 bucket and configuring it](configuring-playbook-s3.md#bucket-creation-and-security-configuration), you can proceed to configure `s3-storage-provider` in your configuration file (`inventory/host_vars/matrix.example.com/vars.yml`): | After [creating the S3 bucket and configuring it](configuring-playbook-s3.md#bucket-creation-and-security-configuration), you can proceed to configure `s3-storage-provider` in your configuration file (`inventory/host_vars/matrix.example.com/vars.yml`): | ||||
| @@ -4,7 +4,7 @@ By default, this playbook configures your Matrix homeserver to not send any tele | |||||
| The [matrix.org](https://matrix.org) team would really appreciate it if you could help the project out by reporting usage statistics from your homeserver. Enabling usage statistics helps track the growth of the Matrix community, and helps to make Matrix a success. | The [matrix.org](https://matrix.org) team would really appreciate it if you could help the project out by reporting usage statistics from your homeserver. Enabling usage statistics helps track the growth of the Matrix community, and helps to make Matrix a success. | ||||
| ## Enabling Telemetry | |||||
| ## Adjusting the playbook configuration | |||||
| If you'd like to **help by enabling submission of general usage statistics** for your homeserver, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file: | If you'd like to **help by enabling submission of general usage statistics** for your homeserver, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file: | ||||
| @@ -14,7 +14,7 @@ This means that this is **limited to the list of DNS providers supported by Trae | |||||
| The up-to-date list can be accessed on [traefik's documentation](https://doc.traefik.io/traefik/https/acme/#providers) | The up-to-date list can be accessed on [traefik's documentation](https://doc.traefik.io/traefik/https/acme/#providers) | ||||
| ## The changes | |||||
| ## Adjusting the playbook configuration | |||||
| **Note**: the changes below instruct you how to do this for a basic Synapse installation. You will need to adapt the variable name and the content of the labels: | **Note**: the changes below instruct you how to do this for a basic Synapse installation. You will need to adapt the variable name and the content of the labels: | ||||