diff --git a/CHANGELOG.md b/CHANGELOG.md index eb1140930..47e9d92bb 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 @@ -2800,7 +2800,7 @@ You can now customize the server name string that Riot-web displays in its login These playbook variables, with these default values, have been added: -``` +```yaml matrix_riot_web_default_server_name: "{{ matrix_domain }}" ``` @@ -2828,7 +2828,7 @@ Still, we might become affected in the future. In any case, it's imminent that S To avoid future problems, we recommend that you run the following command: -``` +```sh ansible-playbook -i inventory/hosts setup.yml --tags=upgrade-postgres --extra-vars='{"postgres_force_upgrade": true}' ``` @@ -3289,7 +3289,7 @@ The certificates from the Matrix domain will be used for the Coturn server. This feature is enabled by default for new installations. To make use of TLS support for your existing Matrix server's Coturn, make sure to rebuild both Coturn and Synapse: -```bash +```sh ansible-playbook -i inventory/hosts setup.yml --tags=setup-coturn,setup-synapse,start ``` @@ -3628,7 +3628,7 @@ The playbook now allows you to set the log levels used by Synapse. The default l You can now override following variables with any of the supported log levels listed here: https://docs.python.org/3/library/logging.html#logging-levels -``` +```yaml matrix_synapse_log_level: "INFO" matrix_synapse_storage_sql_log_level: "INFO" matrix_synapse_root_log_level: "INFO" @@ -3641,7 +3641,7 @@ matrix_synapse_root_log_level: "INFO" You can now customize some parts of Riot's `config.json`. These playbook variables, with these default values, have been added: -``` +```yaml matrix_riot_web_disable_custom_urls: true matrix_riot_web_disable_guests: true matrix_riot_web_integrations_ui_url: "https://scalar.vector.im/" @@ -3652,7 +3652,7 @@ matrix_riot_web_integrations_jitsi_widget_url: "https://scalar.vector.im/api/wid This now allows you use a custom integration manager like [Dimension](https://dimension.t2bot.io). For example, if you wish to use the Dimension instance hosted at dimension.t2bot.io, you can set the following in your vars.yml file: -``` +```yaml matrix_riot_web_integrations_ui_url: "https://dimension.t2bot.io/riot" matrix_riot_web_integrations_rest_url: "https://dimension.t2bot.io/api/v1/scalar" matrix_riot_web_integrations_widgets_urls: "https://dimension.t2bot.io/widgets" diff --git a/docs/ansible.md b/docs/ansible.md index 7783c55be..95fb72dbd 100644 --- a/docs/ansible.md +++ b/docs/ansible.md @@ -55,7 +55,7 @@ Alternatively, you can leave your `inventory/hosts` as is and specify the connec Run this from the playbook's directory: -```bash +```sh docker run -it --rm \ --privileged \ --pid=host \ @@ -76,7 +76,7 @@ Finally, you can execute `ansible-playbook ...` (or `ansible-playbook --connecti Run this from the playbook's directory: -```bash +```sh docker run -it --rm \ -w /work \ -v `pwd`:/work \ @@ -99,7 +99,7 @@ Finally, you execute `ansible-playbook ...` commands as per normal now. If you don't use SSH keys for authentication, simply remove that whole line (`-v $HOME/.ssh/id_rsa:/root/.ssh/id_rsa:ro`). To authenticate at your server using a password, you need to add a package. So, when you are in the shell of the ansible docker container (the previously used `docker run -it ...` command), run: -```bash +```sh apk add sshpass ``` Then, to be asked for the password whenever running an `ansible-playbook` command add `--ask-pass` to the arguments of the command. 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-appservice-draupnir-for-all.md b/docs/configuring-playbook-appservice-draupnir-for-all.md index 862bf3dd7..37b7f86d3 100644 --- a/docs/configuring-playbook-appservice-draupnir-for-all.md +++ b/docs/configuring-playbook-appservice-draupnir-for-all.md @@ -51,7 +51,7 @@ matrix_appservice_draupnir_for_all_master_control_room_alias: "ALIAS_FROM_STEP_2 After configuring the playbook, run the [installation](installing.md) command: -``` +```sh ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` diff --git a/docs/configuring-playbook-backup-borg.md b/docs/configuring-playbook-backup-borg.md index b0bcfe68b..a7902d8de 100644 --- a/docs/configuring-playbook-backup-borg.md +++ b/docs/configuring-playbook-backup-borg.md @@ -18,7 +18,7 @@ By default, if you're using the integrated Postgres database server (as opposed 2. Create a new SSH key: - ```bash + ```sh ssh-keygen -t ed25519 -N '' -f matrix-borg-backup -C matrix ``` @@ -28,7 +28,7 @@ By default, if you're using the integrated Postgres database server (as opposed If you plan to use a hosted solution, follow their instructions. If you have your own server, copy the key over: - ```bash + ```sh # example to append the new PUBKEY contents, where: # PUBKEY is path to the public key, # USER is a ssh user on a provider / server @@ -73,7 +73,7 @@ Check the [backup_borg role](https://github.com/mother-of-all-self-hosting/ansib After configuring the playbook, run the [installation](installing.md) command: -``` +```sh ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` 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-bot-chatgpt.md b/docs/configuring-playbook-bot-chatgpt.md index 26973d43e..c1cc9ea3b 100644 --- a/docs/configuring-playbook-bot-chatgpt.md +++ b/docs/configuring-playbook-bot-chatgpt.md @@ -16,7 +16,7 @@ Choose a strong password for the bot. You can generate a good password with a co You can use the playbook to [register a new user](registering-users.md): -``` +```sh ansible-playbook -i inventory/hosts setup.yml --extra-vars='username=bot.chatgpt password=PASSWORD_FOR_THE_BOT admin=no' --tags=register-user ``` diff --git a/docs/configuring-playbook-bot-draupnir.md b/docs/configuring-playbook-bot-draupnir.md index 77d93f589..b3427f1b0 100644 --- a/docs/configuring-playbook-bot-draupnir.md +++ b/docs/configuring-playbook-bot-draupnir.md @@ -19,7 +19,7 @@ Choose a strong password for the bot. You can generate a good password with a co You can use the playbook to [register a new user](registering-users.md): -``` +```sh ansible-playbook -i inventory/hosts setup.yml --extra-vars='username=bot.draupnir password=PASSWORD_FOR_THE_BOT admin=no' --tags=register-user ``` @@ -117,7 +117,7 @@ That is all you need to do due to that Draupnir can complete migration on its ow After configuring the playbook, run the [installation](installing.md) command: -``` +```sh ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` diff --git a/docs/configuring-playbook-bot-go-neb.md b/docs/configuring-playbook-bot-go-neb.md index 1b21897ac..359aa7fe5 100644 --- a/docs/configuring-playbook-bot-go-neb.md +++ b/docs/configuring-playbook-bot-go-neb.md @@ -19,7 +19,7 @@ Choose a strong password for the bot. You can generate a good password with a co You can use the playbook to [register a new user](registering-users.md): -``` +```sh ansible-playbook -i inventory/hosts setup.yml --extra-vars='username=bot.go-neb password=PASSWORD_FOR_THE_BOT admin=no' --tags=register-user ``` @@ -221,7 +221,7 @@ If you've decided to reuse the `matrix.` domain, you won't need to do any extra After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: -``` +```sh ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` diff --git a/docs/configuring-playbook-bot-matrix-registration-bot.md b/docs/configuring-playbook-bot-matrix-registration-bot.md index 6583a92e0..2d6c55711 100644 --- a/docs/configuring-playbook-bot-matrix-registration-bot.md +++ b/docs/configuring-playbook-bot-matrix-registration-bot.md @@ -46,6 +46,6 @@ If you have any questions, or if you need help setting it up, read the [troublsh To clean the cache (session & encryption data) after you changed the bot's username, changed the login method from access_token to password etc... you can use: -```bash +```sh just run-tags bot-matrix-registration-bot-clean-cache ``` diff --git a/docs/configuring-playbook-bot-mjolnir.md b/docs/configuring-playbook-bot-mjolnir.md index f4ccca11c..664a0a4ae 100644 --- a/docs/configuring-playbook-bot-mjolnir.md +++ b/docs/configuring-playbook-bot-mjolnir.md @@ -15,7 +15,7 @@ Choose a strong password for the bot. You can generate a good password with a co You can use the playbook to [register a new user](registering-users.md): -``` +```sh ansible-playbook -i inventory/hosts setup.yml --extra-vars='username=bot.mjolnir password=PASSWORD_FOR_THE_BOT admin=no' --tags=register-user ``` @@ -119,7 +119,7 @@ matrix_synapse_ext_spam_checker_mjolnir_antispam_config_ban_lists: [] After configuring the playbook, run the [installation](installing.md) command: -``` +```sh ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` diff --git a/docs/configuring-playbook-bridge-appservice-kakaotalk.md b/docs/configuring-playbook-bridge-appservice-kakaotalk.md index 1e9816b41..88f8bfbd1 100644 --- a/docs/configuring-playbook-bridge-appservice-kakaotalk.md +++ b/docs/configuring-playbook-bridge-appservice-kakaotalk.md @@ -21,7 +21,7 @@ You may optionally wish to add some [Additional configuration](#additional-confi After configuring the playbook, run the [installation](installing.md) command: -``` +```sh ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` diff --git a/docs/configuring-playbook-bridge-mautrix-discord.md b/docs/configuring-playbook-bridge-mautrix-discord.md index ee736cda0..be5eb3969 100644 --- a/docs/configuring-playbook-bridge-mautrix-discord.md +++ b/docs/configuring-playbook-bridge-mautrix-discord.md @@ -29,7 +29,7 @@ You may optionally wish to add some [Additional configuration](#additional-confi After configuring the playbook, run the [installation](installing.md) command: -``` +```sh ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` diff --git a/docs/configuring-playbook-bridge-mautrix-facebook.md b/docs/configuring-playbook-bridge-mautrix-facebook.md index 9b881b1d8..0741d9f6e 100644 --- a/docs/configuring-playbook-bridge-mautrix-facebook.md +++ b/docs/configuring-playbook-bridge-mautrix-facebook.md @@ -97,7 +97,7 @@ The easiest way to do this may be to use [sshuttle](https://sshuttle.readthedocs Example command for proxying your traffic through the Matrix server: -``` +```sh sshuttle -r root@matrix.example.com:22 0/0 ``` diff --git a/docs/configuring-playbook-bridge-mautrix-slack.md b/docs/configuring-playbook-bridge-mautrix-slack.md index 9b5aab6de..9065ec0b4 100644 --- a/docs/configuring-playbook-bridge-mautrix-slack.md +++ b/docs/configuring-playbook-bridge-mautrix-slack.md @@ -32,7 +32,7 @@ You may optionally wish to add some [Additional configuration](#additional-confi After configuring the playbook, run the [installation](installing.md) command: -``` +```sh ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` diff --git a/docs/configuring-playbook-bridge-mx-puppet-slack.md b/docs/configuring-playbook-bridge-mx-puppet-slack.md index 18a8dff69..5372f73f6 100644 --- a/docs/configuring-playbook-bridge-mx-puppet-slack.md +++ b/docs/configuring-playbook-bridge-mx-puppet-slack.md @@ -25,7 +25,7 @@ matrix_mx_puppet_slack_oauth_client_secret: "" After configuring the playbook, run the [installation](installing.md) command: -``` +```sh ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` diff --git a/docs/configuring-playbook-dimension.md b/docs/configuring-playbook-dimension.md index 06abd3097..9f6e358c2 100644 --- a/docs/configuring-playbook-dimension.md +++ b/docs/configuring-playbook-dimension.md @@ -71,7 +71,7 @@ By default, you will need to create a CNAME record for `dimension`. See [Configu After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: -``` +```sh ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` diff --git a/docs/configuring-playbook-federation.md b/docs/configuring-playbook-federation.md index e187fa363..3a6c18ad9 100644 --- a/docs/configuring-playbook-federation.md +++ b/docs/configuring-playbook-federation.md @@ -57,7 +57,7 @@ Why? This change could be useful for people running small Synapse instances on s The following changes in the configuration file (`inventory/host_vars/matrix.example.com/vars.yml`) will allow this and make it possible to proxy the federation through a CDN such as CloudFlare or any other: -``` +```yaml matrix_synapse_http_listener_resource_names: ["client","federation"] # Any port can be used but in this case we use 443 matrix_federation_public_port: 443 diff --git a/docs/configuring-playbook-jitsi.md b/docs/configuring-playbook-jitsi.md index 55f647d90..623368b54 100644 --- a/docs/configuring-playbook-jitsi.md +++ b/docs/configuring-playbook-jitsi.md @@ -172,18 +172,18 @@ By default, a single JVB ([Jitsi VideoBridge](https://github.com/jitsi/jitsi-vid There is an ansible playbook that can be run with the following tag: `ansible-playbook -i inventory/hosts --limit jitsi_jvb_servers jitsi_jvb.yml --tags=common,setup-additional-jitsi-jvb,start` For this role to work you will need an additional section in the ansible hosts file with the details of the JVB hosts, for example: -``` +```INI [jitsi_jvb_servers] ansible_host= ``` Each JVB will require a server ID to be set so that it can be uniquely identified and this allows Jitsi to keep track of which conferences are on which JVB. The server ID is set with the variable `jitsi_jvb_server_id` which ends up as the JVB_WS_SERVER_ID environment variables in the JVB docker container. This variable can be set via the host file, a parameter to the ansible command or in the `vars.yaml` for the host which will have the additional JVB. For example: -``` yaml +```yaml jitsi_jvb_server_id: 'jvb-2' ``` -``` INI +```INI [jitsi_jvb_servers] jvb-2.example.com ansible_host=192.168.0.2 jitsi_jvb_server_id=jvb-2 jvb-3.example.com ansible_host=192.168.0.3 jitsi_jvb_server_id=jvb-2 @@ -271,7 +271,7 @@ jitsi_disable_gravatar: false After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: -``` +```sh ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` 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-matrix-registration.md b/docs/configuring-playbook-matrix-registration.md index edc529eda..670562e34 100644 --- a/docs/configuring-playbook-matrix-registration.md +++ b/docs/configuring-playbook-matrix-registration.md @@ -54,7 +54,7 @@ If you've decided to use the default hostname, you won't need to do any extra DN After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: -``` +```sh ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` @@ -72,7 +72,7 @@ We make the most common APIs easy to use via the playbook (see below). To **create a new user registration token (link)**, use this command: -```bash +```sh ansible-playbook -i inventory/hosts setup.yml \ --tags=generate-matrix-registration-token \ --extra-vars="one_time=yes ex_date=2021-12-31" @@ -87,7 +87,7 @@ Share the unique registration link (generated by the command above) with users t To **list the existing user registration tokens**, use this command: -```bash +```sh ansible-playbook -i inventory/hosts setup.yml \ --tags=list-matrix-registration-tokens ``` diff --git a/docs/configuring-playbook-ntfy.md b/docs/configuring-playbook-ntfy.md index abd10feed..93db3c0f5 100644 --- a/docs/configuring-playbook-ntfy.md +++ b/docs/configuring-playbook-ntfy.md @@ -52,7 +52,7 @@ By default, you will need to create a CNAME record for `ntfy`. See [Configuring After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: -``` +```sh ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` diff --git a/docs/configuring-playbook-postgres-backup.md b/docs/configuring-playbook-postgres-backup.md index 109cf8c20..b05dddca1 100644 --- a/docs/configuring-playbook-postgres-backup.md +++ b/docs/configuring-playbook-postgres-backup.md @@ -31,6 +31,6 @@ Refer to the table below for additional configuration variables and their defaul After configuring the playbook, run the [installation](installing.md) command: -``` +```sh ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` diff --git a/docs/configuring-playbook-rageshake.md b/docs/configuring-playbook-rageshake.md index 538e86928..abc679d3f 100644 --- a/docs/configuring-playbook-rageshake.md +++ b/docs/configuring-playbook-rageshake.md @@ -53,7 +53,7 @@ If you've decided to reuse the `matrix.` domain, you won't need to do any extra After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: -``` +```sh ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` diff --git a/docs/configuring-playbook-sygnal.md b/docs/configuring-playbook-sygnal.md index 28f50b78f..004b9f9dc 100644 --- a/docs/configuring-playbook-sygnal.md +++ b/docs/configuring-playbook-sygnal.md @@ -79,7 +79,7 @@ If you've decided to reuse the `matrix.` domain, you won't need to do any extra After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: -``` +```sh ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` 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-auto-compressor.md b/docs/configuring-playbook-synapse-auto-compressor.md index 3e1cda4bc..3a3a310d2 100644 --- a/docs/configuring-playbook-synapse-auto-compressor.md +++ b/docs/configuring-playbook-synapse-auto-compressor.md @@ -20,7 +20,7 @@ matrix_synapse_auto_compressor_enabled: true After configuring the playbook, run the [installation](installing.md) command: -``` +```sh ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` 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/configuring-playbook-user-verification-service.md b/docs/configuring-playbook-user-verification-service.md index e0566c86b..0664ae826 100644 --- a/docs/configuring-playbook-user-verification-service.md +++ b/docs/configuring-playbook-user-verification-service.md @@ -92,7 +92,7 @@ This will instruct UVS to verify the OpenID token against any domain given in a After these variables have been set, run the [installation](installing.md) command to restart UVS: -``` +```sh ansible-playbook -i inventory/hosts setup.yml --tags=setup-matrix-user-verification-service,start ``` diff --git a/docs/faq.md b/docs/faq.md index 37b1fb14d..74db0e8b9 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -267,7 +267,7 @@ matrix_server_fqn_etherpad: "etherpad.example.com" After configuring the playbook, run the [installation](installing.md) command: -``` +```sh ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` diff --git a/docs/getting-the-playbook.md b/docs/getting-the-playbook.md index aba240b4c..3ae14a705 100644 --- a/docs/getting-the-playbook.md +++ b/docs/getting-the-playbook.md @@ -19,7 +19,7 @@ We recommend using the [git](https://git-scm.com/) tool to get the playbook's so Once you've installed git on your computer, you can go to any directory of your choosing and run the following command to retrieve the playbook's source code: -```bash +```sh git clone https://github.com/spantaleev/matrix-docker-ansible-deploy.git ``` diff --git a/docs/importing-postgres.md b/docs/importing-postgres.md index 762900c64..cdba3f743 100644 --- a/docs/importing-postgres.md +++ b/docs/importing-postgres.md @@ -94,7 +94,7 @@ Once the database is clear and the ownership of the tables has been fixed in the Check, if `--dbname` is set to `synapse` (not `matrix`) and replace paths (or even better, copy this line from your terminal) -``` +```sh /usr/bin/env docker run --rm --name matrix-postgres-import --log-driver=none --user=998:1001 --cap-drop=ALL --network=matrix --env-file=/matrix/postgres/env-postgres-psql --mount type=bind,src=/migration/synapse_dump.sql,dst=/synapse_dump.sql,ro --entrypoint=/bin/sh docker.io/postgres:15.0-alpine -c "cat /synapse_dump.sql | grep -vE '^(CREATE|ALTER) ROLE (matrix)(;| WITH)' | grep -vE '^CREATE DATABASE (matrix)\s' | psql -v ON_ERROR_STOP=1 -h matrix-postgres --dbname=synapse" ``` diff --git a/docs/maintenance-and-troubleshooting.md b/docs/maintenance-and-troubleshooting.md index e16b75977..c8803c844 100644 --- a/docs/maintenance-and-troubleshooting.md +++ b/docs/maintenance-and-troubleshooting.md @@ -3,7 +3,7 @@ ## How to see the current status of your services You can check the status of your services by using `systemctl status`. Example: -``` +```sh sudo systemctl status matrix-synapse ● matrix-synapse.service - Synapse server @@ -41,7 +41,7 @@ Re-run the playbook after making these configuration changes. ## Remove unused Docker data You can free some disk space from Docker, see [docker system prune](https://docs.docker.com/engine/reference/commandline/system_prune/) for more information. -```bash +```sh ansible-playbook -i inventory/hosts setup.yml --tags=run-docker-prune ``` diff --git a/docs/maintenance-checking-services.md b/docs/maintenance-checking-services.md index 457cd0f47..e6975b9d1 100644 --- a/docs/maintenance-checking-services.md +++ b/docs/maintenance-checking-services.md @@ -4,7 +4,7 @@ This playbook can perform a check to ensure that you've configured things correc To perform the check, run: -```bash +```sh ansible-playbook -i inventory/hosts setup.yml --tags=self-check ``` diff --git a/docs/maintenance-postgres.md b/docs/maintenance-postgres.md index deac1faa7..9960e7e90 100644 --- a/docs/maintenance-postgres.md +++ b/docs/maintenance-postgres.md @@ -57,7 +57,7 @@ To automatically make Postgres database backups on a fixed schedule, see [Settin To make a one off back up of the current PostgreSQL database, make sure it's running and then execute a command like this on the server: -```bash +```sh /usr/bin/docker exec \ --env-file=/matrix/postgres/env-postgres-psql \ matrix-postgres \ diff --git a/docs/maintenance-synapse.md b/docs/maintenance-synapse.md index a7220f5b8..fdf2856d7 100644 --- a/docs/maintenance-synapse.md +++ b/docs/maintenance-synapse.md @@ -35,7 +35,7 @@ After deleting data, you may wish to run a [`FULL` Postgres `VACUUM`](./maintena To ask the playbook to run rust-synapse-compress-state, execute: -``` +```sh ansible-playbook -i inventory/hosts setup.yml --tags=rust-synapse-compress-state ``` @@ -52,14 +52,14 @@ Editing the database manually is not recommended or supported by the Synapse dev First, set up an SSH tunnel to your Matrix server (skip if it is your local machine): -``` +```sh # you may replace 1799 with an arbitrary port unbound on both machines ssh -L 1799:localhost:1799 matrix.example.com ``` Then start up an ephemeral [adminer](https://www.adminer.org/) container on the Matrix server, connecting it to the `matrix` network and linking the postgresql container: -``` +```sh docker run --rm --publish 1799:8080 --link matrix-postgres --net matrix adminer ``` @@ -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/docs/obtaining-access-tokens.md b/docs/obtaining-access-tokens.md index ba9381a82..12016cb96 100644 --- a/docs/obtaining-access-tokens.md +++ b/docs/obtaining-access-tokens.md @@ -25,7 +25,7 @@ Below, we describe 2 ways to generate an access token for a user - using [Elemen You can use the following command to get an access token for your user directly from the [Matrix Client-Server API](https://www.matrix.org/docs/guides/client-server-api#login): -``` +```sh curl -XPOST -d '{ "identifier": { "type": "m.id.user", "user": "USERNAME" }, "password": "PASSWORD", diff --git a/docs/updating-users-passwords.md b/docs/updating-users-passwords.md index 6461e1198..71cd3afe9 100644 --- a/docs/updating-users-passwords.md +++ b/docs/updating-users-passwords.md @@ -8,7 +8,7 @@ You can reset a user's password via the Ansible playbook: -``` +```sh ansible-playbook -i inventory/hosts setup.yml --extra-vars='username=USERNAME_HERE password=PASSWORD_HERE' --tags=update-user-password ``` @@ -19,7 +19,7 @@ ansible-playbook -i inventory/hosts setup.yml --extra-vars='username=USERNAME_HE You can manually generate the password hash by using the command-line after **SSH**-ing to your server (requires that [all services have been started](installing.md#finalize-the-installation): -``` +```sh docker exec -it matrix-synapse /usr/local/bin/hash_password -c /data/homeserver.yaml ``` @@ -42,6 +42,6 @@ If you didn't make your account a server admin when you created it, you can lear ### Example: To set @user:example.com's password to `correct_horse_battery_staple` you could use this curl command: -``` +```sh curl -XPOST -d '{ "new_password": "correct_horse_battery_staple" }' "https://matrix.example.com/_matrix/client/r0/admin/reset_password/@user:example.com?access_token=MDA...this_is_my_access_token ``` 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/