Update docs for Draupnir, D4A, and Mjolnir: adopt the common section "Extending the configuration"pull/3976/head
| @@ -46,19 +46,23 @@ matrix_appservice_draupnir_for_all_master_control_room_alias: "MANAGEMENT_ROOM_A | |||||
| ### Extending the configuration | ### Extending the configuration | ||||
| You can configure additional options by adding the `matrix_appservice_draupnir_for_all_extension_yaml` variable. | |||||
| There are some additional things you may wish to configure about the component. | |||||
| Take a look at: | |||||
| - `roles/custom/matrix-appservice-draupnir-for-all/defaults/main.yml` for some variables that you can customize via your `vars.yml` file. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_appservice_draupnir_for_all_configuration_extension_yaml` variable | |||||
| For example, to change Draupnir's `protectAllJoinedRooms` option to `true`, add the following configuration to your `vars.yml` file: | For example, to change Draupnir's `protectAllJoinedRooms` option to `true`, add the following configuration to your `vars.yml` file: | ||||
| ```yaml | ```yaml | ||||
| matrix_appservice_draupnir_for_all_extension_yaml: | | |||||
| matrix_appservice_draupnir_for_all_configuration_extension_yaml: | | |||||
| # Your custom YAML configuration goes here. | # Your custom YAML configuration goes here. | ||||
| # This configuration extends the default starting configuration (`matrix_appservice_draupnir_for_all_yaml`). | |||||
| # This configuration extends the default starting configuration (`matrix_appservice_draupnir_for_all_configuration_yaml`). | |||||
| # | # | ||||
| # You can override individual variables from the default configuration, or introduce new ones. | # You can override individual variables from the default configuration, or introduce new ones. | ||||
| # | # | ||||
| # If you need something more special, you can take full control by | # If you need something more special, you can take full control by | ||||
| # completely redefining `matrix_appservice_draupnir_for_all_yaml`. | |||||
| # completely redefining `matrix_appservice_draupnir_for_all_configuration_yaml`. | |||||
| protectAllJoinedRooms: true | protectAllJoinedRooms: true | ||||
| ``` | ``` | ||||
| @@ -117,7 +117,11 @@ The other method polls an Synapse Admin API endpoint, hence it is available only | |||||
| ### Extending the configuration | ### Extending the configuration | ||||
| You can configure additional options by adding the `matrix_bot_draupnir_configuration_extension_yaml` variable. | |||||
| There are some additional things you may wish to configure about the bot. | |||||
| Take a look at: | |||||
| - `roles/custom/matrix-bot-draupnir/defaults/main.yml` for some variables that you can customize via your `vars.yml` file. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_bot_draupnir_configuration_extension_yaml` variable | |||||
| For example, to change Draupnir's `acceptInvitesFromSpace` option to `!qporfwt:example.com`, add the following configuration to your `vars.yml` file: | For example, to change Draupnir's `acceptInvitesFromSpace` option to `!qporfwt:example.com`, add the following configuration to your `vars.yml` file: | ||||
| @@ -131,7 +131,11 @@ matrix_synapse_ext_spam_checker_mjolnir_antispam_config_ban_lists: [] | |||||
| ### Extending the configuration | ### Extending the configuration | ||||
| You can configure additional options by adding the `matrix_bot_mjolnir_configuration_extension_yaml` variable to your `inventory/host_vars/matrix.example.com/vars.yml` file. | |||||
| There are some additional things you may wish to configure about the bot. | |||||
| Take a look at: | |||||
| - `roles/custom/matrix-bot-mjolnir/defaults/main.yml` for some variables that you can customize via your `vars.yml` file. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_bot_mjolnir_configuration_extension_yaml` variable | |||||
| For example, to change Mjolnir's `recordIgnoredInvites` option to `true`, add the following configuration to your `vars.yml` file: | For example, to change Mjolnir's `recordIgnoredInvites` option to `true`, add the following configuration to your `vars.yml` file: | ||||