diff --git a/CHANGELOG.md b/CHANGELOG.md index eb1140930..ec96c3f05 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -174,7 +174,7 @@ If upstream synapse-admin picks up the pace and improves, the etke.cc fork may d If you'd like to switch back to the original synapse-admin software, you can do so by adding the following configuration to your `vars.yml` file: -```yml +```yaml matrix_synapse_admin_docker_image: "{{ matrix_synapse_admin_docker_image_name_prefix }}awesometechnologies/synapse-admin:{{ matrix_synapse_admin_version }}" matrix_synapse_admin_docker_image_name_prefix: "{{ 'localhost/' if matrix_synapse_admin_container_image_self_build else matrix_container_global_registry_prefix }}" @@ -199,7 +199,7 @@ All non-deprecated mautrix bridges in the playbook have been reworked to support We recommend **enabling double-puppeting via the new Appservice method** by adding the following configuration to your `vars.yml` file: -```yml +```yaml matrix_appservice_double_puppet_enabled: true ``` @@ -231,7 +231,7 @@ This upgrade necessitates configuration policy changes as described in [matrix-c If you'd like to remain on the old (v2) version of matrix-corporal, you can do so by adding the following configuration to your `vars.yml` file: -```yml +```yaml matrix_corporal_version: 2.8.0 ``` @@ -287,7 +287,7 @@ Still, if HTTP/3 cannot function correctly in your setup, it's best to disable a To **disable HTTP/3**, you can use the following configuration: -```yml +```yaml traefik_config_entrypoint_web_secure_http3_enabled: false # Disabling HTTP/3 for the web-secure entrypoint (above), @@ -301,7 +301,7 @@ matrix_playbook_public_matrix_federation_api_traefik_entrypoint_config_http3_ena If you are using [your own webserver](./docs/configuring-playbook-own-webserver.md) (in front of Traefik), port binding on UDP port `8448` by default due to HTTP/3 is either unnecessary or [may get in the way](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/3402). If it does, you can disable it: -```yml +```yaml # Disable HTTP/3 for the federation entrypoint. # If you'd like HTTP/3, consider configuring it for your other reverse-proxy. # @@ -322,7 +322,7 @@ The playbook has just started making use of this feature. **From now on, your sy If you'd like **to go back to the old unrestricted behavior**, use the following configuration: -```yml +```yaml # Use this configuration to allow synapse-admin to manage any homeserver instance. matrix_synapse_admin_config_restrictBaseUrl: [] ``` @@ -387,7 +387,7 @@ Users on `arm32` should be aware that there's **neither a prebuilt `arm32` conta **The playbook still supports Redis** and you can keep using Redis (for now) if you'd like, by adding this additional configuration to your `vars.yml` file: -```yml +```yaml # Explicitly disable KeyDB, which will auto-enable Redis # if the playbook requires it as a dependency for its operation. keydb_enabled: false diff --git a/docs/configuring-playbook-alertmanager-receiver.md b/docs/configuring-playbook-alertmanager-receiver.md index ab81eb7c0..9eca526bd 100644 --- a/docs/configuring-playbook-alertmanager-receiver.md +++ b/docs/configuring-playbook-alertmanager-receiver.md @@ -12,7 +12,7 @@ This service is meant to be used with an external [Alertmanager](https://prometh To enable matrix-alertmanager-receiver, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file: -```yml +```yaml matrix_alertmanager_receiver_enabled: true # If you'd like to change the username for this bot, uncomment and adjust. Otherwise, remove. @@ -85,7 +85,7 @@ Then, you can proceed to [Usage](#usage). Configure your Prometheus Alertmanager with configuration like this: -```yml +```yaml receivers: - name: matrix webhook_configs: diff --git a/docs/configuring-playbook-appservice-double-puppet.md b/docs/configuring-playbook-appservice-double-puppet.md index 814f34b9a..b07662059 100644 --- a/docs/configuring-playbook-appservice-double-puppet.md +++ b/docs/configuring-playbook-appservice-double-puppet.md @@ -10,7 +10,7 @@ Previously, bridges supported performing [double-puppeting](https://docs.mau.fi/ To enable the Appservice Double Puppet service, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file: -```yml +```yaml matrix_appservice_double_puppet_enabled: true ``` diff --git a/docs/configuring-playbook-bot-baibot.md b/docs/configuring-playbook-bot-baibot.md index 1c7aa419e..be21ab98a 100644 --- a/docs/configuring-playbook-bot-baibot.md +++ b/docs/configuring-playbook-bot-baibot.md @@ -84,7 +84,7 @@ If `matrix_admin` is already configured in your `vars.yml` configuration, you ca **If necessary**, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file: -```yml +```yaml # Uncomment to add one or more admins to this bridge: # # matrix_bot_baibot_config_access_admin_patterns: @@ -113,7 +113,7 @@ Configuring `matrix_bot_baibot_config_initial_global_config_user_patterns` is op **If necessary**, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file: -```yml +```yaml # Uncomment and adjust the bot users if necessary: # # Subsequent changes to `matrix_bot_baibot_config_initial_global_config_user_patterns` do not affect the bot's behavior. @@ -146,7 +146,7 @@ You can statically-define a single [🤖 agent](https://github.com/etkecc/baibot Here's an example **addition** to your `vars.yml` file: -```yml +```yaml matrix_bot_baibot_config_agents_static_definitions_anthropic_enabled: true matrix_bot_baibot_config_agents_static_definitions_anthropic_config_api_key: "YOUR_API_KEY_HERE" @@ -173,7 +173,7 @@ You can statically-define a single [🤖 agent](https://github.com/etkecc/baibot Here's an example **addition** to your `vars.yml` file: -```yml +```yaml matrix_bot_baibot_config_agents_static_definitions_groq_enabled: true matrix_bot_baibot_config_agents_static_definitions_groq_config_api_key: "YOUR_API_KEY_HERE" @@ -207,7 +207,7 @@ You can statically-define a single [🤖 agent](https://github.com/etkecc/baibot Here's an example **addition** to your `vars.yml` file: -```yml +```yaml matrix_bot_baibot_config_agents_static_definitions_mistral_enabled: true matrix_bot_baibot_config_agents_static_definitions_mistral_config_api_key: "YOUR_API_KEY_HERE" @@ -238,7 +238,7 @@ The OpenAI provider is **only meant to be used with OpenAI's official API** and Here's an example **addition** to your `vars.yml` file: -```yml +```yaml matrix_bot_baibot_config_agents_static_definitions_openai_enabled: true matrix_bot_baibot_config_agents_static_definitions_openai_config_api_key: "YOUR_API_KEY_HERE" @@ -282,7 +282,7 @@ You can also define providers at runtime, by chatting with the bot, so using Ans Below is an an **example** demonstrating **statically-defining agents via Ansible without using presets**: -```yml +```yaml matrix_bot_baibot_config_agents_static_definitions_custom: # This agent will use the GPT 3.5 model and will only support text-generation, # even though the `openai` provider could support other features (e.g. image-generation). @@ -356,7 +356,7 @@ You can configure the **initial values** for these via Ansible, via the `matrix_ Example **additional** `vars.yml` configuration: -```yml +```yaml # Note: these are initial defaults for the bot's global configuration. # As such, changing any of these values subsequently has no effect on the bot's behavior. # Once initially configured, the global configuration is managed via bot commands, not via Ansible. diff --git a/docs/configuring-playbook-matrix-authentication-service.md b/docs/configuring-playbook-matrix-authentication-service.md index c94a250d9..fc79b7044 100644 --- a/docs/configuring-playbook-matrix-authentication-service.md +++ b/docs/configuring-playbook-matrix-authentication-service.md @@ -364,7 +364,7 @@ The same OIDC provider may have an `id` of `01HFVBY12TMNTYTBV8W921M5FA` on the M To tell `syn2mas` how the Synapse-configured OIDC provider maps to the new MAS-configured OIDC provider, add this additional configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file: -```yml +```yaml # Adjust the mapping below to match your provider IDs on the Synapse side and the MAS side. # Don't forget that Synapse automatically adds an `oidc-` prefix to provider ids defined in its configuration. matrix_authentication_service_syn2mas_process_extra_arguments: diff --git a/docs/configuring-playbook-synapse-auto-accept-invite.md b/docs/configuring-playbook-synapse-auto-accept-invite.md index d315f6410..33e9268c2 100644 --- a/docs/configuring-playbook-synapse-auto-accept-invite.md +++ b/docs/configuring-playbook-synapse-auto-accept-invite.md @@ -34,7 +34,7 @@ Since Synapse [v1.109.0](https://github.com/element-hq/synapse/releases/tag/v1.1 Here's example configuration for using the **native** Synapse feature: -```yml +```yaml matrix_synapse_auto_accept_invites_enabled: true # Default settings below. Uncomment and adjust this part if necessary. diff --git a/docs/configuring-playbook-synapse.md b/docs/configuring-playbook-synapse.md index a529d3e34..b9291c3b9 100644 --- a/docs/configuring-playbook-synapse.md +++ b/docs/configuring-playbook-synapse.md @@ -98,7 +98,7 @@ For more detailed documentation on available options and how to setup keycloak, In case you encounter errors regarding the parsing of the variables, you can try to add `{% raw %}` and `{% endraw %}` blocks around them. For example ; -```yml +```yaml matrix_synapse_oidc_enabled: true matrix_synapse_oidc_providers: diff --git a/docs/configuring-playbook-turn.md b/docs/configuring-playbook-turn.md index b52b54691..6bd0a8ad7 100644 --- a/docs/configuring-playbook-turn.md +++ b/docs/configuring-playbook-turn.md @@ -40,7 +40,7 @@ The playbook uses the [`auth-secret` authentication method](https://github.com/c To do so, add this override to your configuration: -```yml +```yaml matrix_coturn_authentication_method: lt-cred-mech ``` diff --git a/docs/maintenance-synapse.md b/docs/maintenance-synapse.md index a7220f5b8..40812be0c 100644 --- a/docs/maintenance-synapse.md +++ b/docs/maintenance-synapse.md @@ -93,7 +93,7 @@ You can **learn more about cache-autotuning and the global cache factor settings To **disable cache auto-tuning**, unset all values: -```yml +```yaml matrix_synapse_cache_autotuning_max_cache_memory_usage: '' matrix_synapse_cache_autotuning_target_cache_memory_usage: '' matrix_synapse_cache_autotuning_min_cache_ttl: '' diff --git a/roles/custom/matrix-synapse/defaults/main.yml b/roles/custom/matrix-synapse/defaults/main.yml index 8435ff8c0..7896886b0 100644 --- a/roles/custom/matrix-synapse/defaults/main.yml +++ b/roles/custom/matrix-synapse/defaults/main.yml @@ -56,7 +56,7 @@ matrix_synapse_container_image_customizations_auto_accept_invite_installation_en # # Example usage: # -# ```yml +# ```yaml # matrix_synapse_container_image_customizations_templates_enabled: true # # The templates are expected to be in a `templates/` subdirectory in # matrix_synapse_container_image_customizations_templates_in_container_template_files_relative_path: templates/