Przeglądaj źródła

Triple backticks with syntax highlighting: yml → yaml

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
pull/3832/head
Suguru Hirahara 1 rok temu
rodzic
commit
d68815860d
Nie znaleziono w bazie danych klucza dla tego podpisu ID klucza GPG: E4F9743DAB4B7B75
10 zmienionych plików z 24 dodań i 24 usunięć
  1. +7
    -7
      CHANGELOG.md
  2. +2
    -2
      docs/configuring-playbook-alertmanager-receiver.md
  3. +1
    -1
      docs/configuring-playbook-appservice-double-puppet.md
  4. +8
    -8
      docs/configuring-playbook-bot-baibot.md
  5. +1
    -1
      docs/configuring-playbook-matrix-authentication-service.md
  6. +1
    -1
      docs/configuring-playbook-synapse-auto-accept-invite.md
  7. +1
    -1
      docs/configuring-playbook-synapse.md
  8. +1
    -1
      docs/configuring-playbook-turn.md
  9. +1
    -1
      docs/maintenance-synapse.md
  10. +1
    -1
      roles/custom/matrix-synapse/defaults/main.yml

+ 7
- 7
CHANGELOG.md Wyświetl plik

@@ -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: 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: "{{ 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 }}" 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: 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 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: 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 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: To **disable HTTP/3**, you can use the following configuration:


```yml
```yaml
traefik_config_entrypoint_web_secure_http3_enabled: false traefik_config_entrypoint_web_secure_http3_enabled: false


# Disabling HTTP/3 for the web-secure entrypoint (above), # 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: 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. # Disable HTTP/3 for the federation entrypoint.
# If you'd like HTTP/3, consider configuring it for your other reverse-proxy. # 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: 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. # Use this configuration to allow synapse-admin to manage any homeserver instance.
matrix_synapse_admin_config_restrictBaseUrl: [] 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: **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 # Explicitly disable KeyDB, which will auto-enable Redis
# if the playbook requires it as a dependency for its operation. # if the playbook requires it as a dependency for its operation.
keydb_enabled: false keydb_enabled: false


+ 2
- 2
docs/configuring-playbook-alertmanager-receiver.md Wyświetl plik

@@ -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: 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 matrix_alertmanager_receiver_enabled: true


# If you'd like to change the username for this bot, uncomment and adjust. Otherwise, remove. # 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: Configure your Prometheus Alertmanager with configuration like this:


```yml
```yaml
receivers: receivers:
- name: matrix - name: matrix
webhook_configs: webhook_configs:


+ 1
- 1
docs/configuring-playbook-appservice-double-puppet.md Wyświetl plik

@@ -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: 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 matrix_appservice_double_puppet_enabled: true
``` ```




+ 8
- 8
docs/configuring-playbook-bot-baibot.md Wyświetl plik

@@ -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: **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: # Uncomment to add one or more admins to this bridge:
# #
# matrix_bot_baibot_config_access_admin_patterns: # 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: **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: # 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. # 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: 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_enabled: true


matrix_bot_baibot_config_agents_static_definitions_anthropic_config_api_key: "YOUR_API_KEY_HERE" 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: 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_enabled: true


matrix_bot_baibot_config_agents_static_definitions_groq_config_api_key: "YOUR_API_KEY_HERE" 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: 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_enabled: true


matrix_bot_baibot_config_agents_static_definitions_mistral_config_api_key: "YOUR_API_KEY_HERE" 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: 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_enabled: true


matrix_bot_baibot_config_agents_static_definitions_openai_config_api_key: "YOUR_API_KEY_HERE" 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**: Below is an an **example** demonstrating **statically-defining agents via Ansible without using presets**:


```yml
```yaml
matrix_bot_baibot_config_agents_static_definitions_custom: matrix_bot_baibot_config_agents_static_definitions_custom:
# This agent will use the GPT 3.5 model and will only support text-generation, # 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). # 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: Example **additional** `vars.yml` configuration:


```yml
```yaml
# Note: these are initial defaults for the bot's global configuration. # 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. # 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. # Once initially configured, the global configuration is managed via bot commands, not via Ansible.


+ 1
- 1
docs/configuring-playbook-matrix-authentication-service.md Wyświetl plik

@@ -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: 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. # 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. # Don't forget that Synapse automatically adds an `oidc-` prefix to provider ids defined in its configuration.
matrix_authentication_service_syn2mas_process_extra_arguments: matrix_authentication_service_syn2mas_process_extra_arguments:


+ 1
- 1
docs/configuring-playbook-synapse-auto-accept-invite.md Wyświetl plik

@@ -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: Here's example configuration for using the **native** Synapse feature:


```yml
```yaml
matrix_synapse_auto_accept_invites_enabled: true matrix_synapse_auto_accept_invites_enabled: true


# Default settings below. Uncomment and adjust this part if necessary. # Default settings below. Uncomment and adjust this part if necessary.


+ 1
- 1
docs/configuring-playbook-synapse.md Wyświetl plik

@@ -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 ; 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_enabled: true


matrix_synapse_oidc_providers: matrix_synapse_oidc_providers:


+ 1
- 1
docs/configuring-playbook-turn.md Wyświetl plik

@@ -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: To do so, add this override to your configuration:


```yml
```yaml
matrix_coturn_authentication_method: lt-cred-mech matrix_coturn_authentication_method: lt-cred-mech
``` ```




+ 1
- 1
docs/maintenance-synapse.md Wyświetl plik

@@ -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: To **disable cache auto-tuning**, unset all values:


```yml
```yaml
matrix_synapse_cache_autotuning_max_cache_memory_usage: '' matrix_synapse_cache_autotuning_max_cache_memory_usage: ''
matrix_synapse_cache_autotuning_target_cache_memory_usage: '' matrix_synapse_cache_autotuning_target_cache_memory_usage: ''
matrix_synapse_cache_autotuning_min_cache_ttl: '' matrix_synapse_cache_autotuning_min_cache_ttl: ''


+ 1
- 1
roles/custom/matrix-synapse/defaults/main.yml Wyświetl plik

@@ -56,7 +56,7 @@ matrix_synapse_container_image_customizations_auto_accept_invite_installation_en
# #
# Example usage: # Example usage:
# #
# ```yml
# ```yaml
# matrix_synapse_container_image_customizations_templates_enabled: true # matrix_synapse_container_image_customizations_templates_enabled: true
# # The templates are expected to be in a `templates/` subdirectory in # # The templates are expected to be in a `templates/` subdirectory in
# matrix_synapse_container_image_customizations_templates_in_container_template_files_relative_path: templates/ # matrix_synapse_container_image_customizations_templates_in_container_template_files_relative_path: templates/


Ładowanie…
Anuluj
Zapisz