From 3653f9f89b9bc921af4091072a8ca4cb732289ea Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Mon, 2 Jun 2025 22:16:14 +0900 Subject: [PATCH] Run codespell --write-changes Signed-off-by: Suguru Hirahara --- CHANGELOG.md | 20 +++++++++---------- YEAR-IN-REVIEW.md | 2 +- docs/README.md | 2 +- docs/ansible.md | 2 +- ...ng-playbook-appservice-draupnir-for-all.md | 4 ++-- docs/configuring-playbook-bot-chatgpt.md | 2 +- docs/configuring-playbook-bot-draupnir.md | 2 +- ...ng-playbook-bot-matrix-registration-bot.md | 2 +- docs/configuring-playbook-bridge-hookshot.md | 2 +- ...iguring-playbook-bridge-mautrix-wsproxy.md | 2 +- docs/configuring-playbook-element-call.md | 2 +- ...-playbook-matrix-authentication-service.md | 6 +++--- docs/configuring-playbook-matrix-corporal.md | 2 +- .../configuring-playbook-matrix-media-repo.md | 2 +- docs/configuring-playbook-ntfy.md | 2 +- docs/configuring-playbook-ssl-certificates.md | 2 +- docs/configuring-playbook-synapse.md | 2 +- docs/faq.md | 4 ++-- docs/howto-srv-server-delegation.md | 2 +- .../nginx-proxy-manager/README.md | 4 ++-- group_vars/matrix_servers | 2 +- i18n/README.md | 2 +- .../defaults/main.yml | 2 +- roles/custom/matrix-base/defaults/main.yml | 4 ++-- .../matrix-base/tasks/validate_config.yml | 2 +- .../tasks/validate_config.yml | 2 +- .../tasks/validate_config.yml | 2 +- .../templates/config.yaml.j2 | 2 +- .../defaults/main.yml | 2 +- .../templates/config.yaml.j2 | 2 +- .../tasks/validate_config.yml | 2 +- .../templates/conduwuit.toml.j2 | 4 ++-- .../templates/continuwuity.toml.j2 | 4 ++-- roles/custom/matrix-coturn/defaults/main.yml | 2 +- .../custom/matrix-dendrite/defaults/main.yml | 2 +- .../matrix-dynamic-dns/defaults/main.yml | 2 +- roles/custom/matrix-ma1sd/defaults/main.yml | 2 +- .../templates/grafana/media-repo.json | 2 +- .../tasks/validate_config.yml | 2 +- roles/custom/matrix-synapse/defaults/main.yml | 6 +++--- .../templates/synapse/homeserver.yaml.j2 | 6 +++--- .../custom/matrix-user-creator/tasks/main.yml | 2 +- .../defaults/main.yml | 2 +- .../docker_daemon_options_file_cleanup.yml | 2 +- 44 files changed, 65 insertions(+), 65 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index a037191cf..cd8d2089e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -156,7 +156,7 @@ To **completely eliminate the problem** of DDoS amplification attacks done throu The playbook now **only exposes the Coturn STUN port (`3478`) over TCP by default**. -💡 Users may wish to further remove the (now unnnecessary) firewall rule allowing access to `3478/udp`. +💡 Users may wish to further remove the (now unnecessary) firewall rule allowing access to `3478/udp`. If you'd like the Coturn STUN port to be exposed over UDP like before, you can revert to the previous behavior by using the following configuration in your `vars.yml` file: @@ -170,7 +170,7 @@ matrix_coturn_container_stun_plain_host_bind_port_udp: "3478" # 2025-02-17 -## FluffyChat Web suport +## FluffyChat Web support Thanks to [Aine](https://gitlab.com/etke.cc) of [etke.cc](https://etke.cc/), the playbook now supports [FluffyChat Web](https://github.com/krille-chan/fluffychat) as an additional Matrix client you can self-host. @@ -192,7 +192,7 @@ The playbook will let you know if you're using any `matrix_mautrix_hangouts_*` v ## Redis and KeyDB are no longer part of the playbook -**TLDR**: The playbook now exclusively uses Valkey as its Redis-compatible memorystore implementation, removing support for Redis and KeyDB. Most users are unaffected by this change unless they explicitly configured Redis or KeyDB variables. Only users that were explicitly definining `redis_*` or `keydb_*` variables will need to update their configuration to use `valkey_*` variables instead. +**TLDR**: The playbook now exclusively uses Valkey as its Redis-compatible memorystore implementation, removing support for Redis and KeyDB. Most users are unaffected by this change unless they explicitly configured Redis or KeyDB variables. Only users that were explicitly defining `redis_*` or `keydb_*` variables will need to update their configuration to use `valkey_*` variables instead. The playbook has gone through several iterations of memorystore implementations: @@ -745,7 +745,7 @@ For people building commercial products on top of Synapse, they may have to eith We're no lawyers and this changelog entry does not aim to give you the best legal advice, so please research on your own! -If you'd like to continue using the old Apache-2.0-licensed Synapse (for a while longer anyway), the playbook makes it possible by intruducing a new Ansible variable. You can do it like this: +If you'd like to continue using the old Apache-2.0-licensed Synapse (for a while longer anyway), the playbook makes it possible by introducing a new Ansible variable. You can do it like this: ```yaml # Switch the organization that Synapse container images (or source code for self-building) are pulled from. @@ -828,7 +828,7 @@ Despite these downsides (which the playbook manages automatically), we believe i People running the default Traefik setup do not need to do anything to make Traefik take on this extra job. Your Traefik configuration will be updated automatically. -**People runnning their own Traefik reverse-proxy need to do [minor adjustments](#people-managing-their-own-traefik-instance-need-to-do-minor-changes)**, as described in the section below. +**People running their own Traefik reverse-proxy need to do [minor adjustments](#people-managing-their-own-traefik-instance-need-to-do-minor-changes)**, as described in the section below. You may disable Traefik acting as an intermediary by explicitly setting `matrix_playbook_public_matrix_federation_api_traefik_entrypoint_enabled` to `false`. Services would then be configured to talk to the homeserver directly, giving you a slight performance boost and a "simpler" Traefik setup. However, such a configuration is less tested and will cause troubles, especially if you enable more services (like `matrix-media-repo`, etc.) in the future. As such, it's not recommended. @@ -2851,7 +2851,7 @@ As always, re-running the playbook is enough to get the updated bits. ## SMS bridging requires db reset -The current version of [matrix-sms-bridge](https://github.com/benkuly/matrix-sms-bridge) needs you to delete the database to work as expected. Just remove `/matrix/matrix-sms-bridge/database/*`. It also adds a new requried var `matrix_sms_bridge_default_region`. +The current version of [matrix-sms-bridge](https://github.com/benkuly/matrix-sms-bridge) needs you to delete the database to work as expected. Just remove `/matrix/matrix-sms-bridge/database/*`. It also adds a new required var `matrix_sms_bridge_default_region`. To reuse your existing rooms, invite `@smsbot:yourServer` to the room or write a message. You are also able to use automated room creation with telephonenumers by writing `sms send -t 01749292923 "Hello World"` in a room with `@smsbot:yourServer`. See [the docs](https://github.com/benkuly/matrix-sms-bridge) for more information. @@ -2883,7 +2883,7 @@ Until the issue gets fixed, we're making User Directory search not go to ma1sd b This upgrades matrix-appservice-irc from 0.14.1 to 0.16.0. Upstream made a change to how you define manual mappings. If you added a -`mapping` to your configuration, you will need to update it accoring +`mapping` to your configuration, you will need to update it according to the [upstream instructions](https://github.com/matrix-org/matrix-appservice-irc/blob/master/CHANGELOG.md#0150-2020-02-05). If you did not include `mappings` in your configuration for IRC, no change is necessary. `mappings` is not part of the default @@ -3046,7 +3046,7 @@ As per this [advisory blog post](https://matrix.org/blog/2019/11/09/avoiding-unw Our general goal is to favor privacy and security when running personal (family & friends) and corporate homeservers. Both of these likely benefit from having a more secure default of **not showing the room directory without authentication** and **not publishing the room directory over federation**. -As with anything else, these new defaults can be overriden by changing the `matrix_synapse_allow_public_rooms_without_auth` and `matrix_synapse_allow_public_rooms_over_federation` variables, respectively. +As with anything else, these new defaults can be overridden by changing the `matrix_synapse_allow_public_rooms_without_auth` and `matrix_synapse_allow_public_rooms_over_federation` variables, respectively. # 2019-10-05 @@ -3600,7 +3600,7 @@ The following changes had to be done: - glue variables had to be introduced to the playbook, so it can wire together the various components. Those glue vars are stored in the [`group_vars/matrix-servers`](group_vars/matrix-servers) file. When overriding variables for a given component (role), you need to be aware of both the role defaults (`role/ROLE/defaults/main.yml`) and the role's corresponding section in the [`group_vars/matrix-servers`](group_vars/matrix-servers) file. -- `matrix_postgres_use_external` has been superceeded by the more consistently named `matrix_postgres_enabled` variable and a few other `matrix_synapse_database_` variables. See the [Using an external PostgreSQL server (optional)](docs/configuring-playbook-external-postgres.md) documentation page for an up-to-date replacement. +- `matrix_postgres_use_external` has been superseded by the more consistently named `matrix_postgres_enabled` variable and a few other `matrix_synapse_database_` variables. See the [Using an external PostgreSQL server (optional)](docs/configuring-playbook-external-postgres.md) documentation page for an up-to-date replacement. - Postgres tools (`matrix-postgres-cli` and `matrix-make-user-admin`) are no longer installed if you're not enabling the `matrix-postgres` role (`matrix_postgres_enabled: false`) @@ -3789,7 +3789,7 @@ matrix_riot_web_integrations_jitsi_widget_url: "https://dimension.t2bot.io/widge There's now a new `matrix_nginx_proxy_ssl_protocols` playbook variable, which controls the SSL protocols used to serve Riot and Synapse. Its default value is `TLSv1.1 TLSv1.2`. This playbook previously used `TLSv1 TLSv1.1 TLSv1.2` to serve Riot and Synapse. -You may wish to reenable TLSv1 if you need to access Riot in older browsers. +You may wish to re-enable TLSv1 if you need to access Riot in older browsers. Note: Currently the dockerized nginx doesn't support TLSv1.3. See https://github.com/nginxinc/docker-nginx/issues/190 for more details. diff --git a/YEAR-IN-REVIEW.md b/YEAR-IN-REVIEW.md index e66882873..8ca6db9cb 100644 --- a/YEAR-IN-REVIEW.md +++ b/YEAR-IN-REVIEW.md @@ -11,7 +11,7 @@ SPDX-License-Identifier: AGPL-3.0-or-later 2023 is probably [the year of AI](https://journal.everypixel.com/2023-the-year-of-ai), with millions of people jumping aboard [OpenAI](https://openai.com/)'s [ChatGPT](https://openai.com/chatgpt) train. matrix-docker-ansible-deploy is no stranger to this and 2023 began with a PR from [bertybuttface](https://github.com/bertybuttface) who added support for [matrix-chatgpt-bot](https://github.com/matrixgpt/matrix-chatgpt-bot) (see the [changelog entry](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/CHANGELOG.md#chatgpt-support)). While OpenAI's chat GPT website was frequently overloaded in the past, their API was up which made using this bot both convenient and more reliable. -AI aside, with the playbook's focus being containers, we're **doubling down on being "container native"** and becoming more interoperable for people hosting other containers on the Matrix server. In [2022](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/YEAR-IN-REVIEW.md#2022), we've announced a few sibling Ansible playbooks, their use of [Traefik](https://doc.traefik.io/traefik/) and the possiblity of matrix-docker-ansible-deploy also switching to this reverse-proxy. This prediction materialized quickly. The **largest change** in the playbook in 2023 happened way back in February - matrix-docker-ansible-deploy [starting the switch from nginx to Traefik](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/CHANGELOG.md#backward-compatibility-reverse-proxy-configuration-changes-and-initial-traefik-support) and then quickly [making Treafik the default reverse-proxy](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/CHANGELOG.md#traefik-is-the-default-reverse-proxy-now). As noted in the changelog entries, we envisioned a quick and complete elimination of `matrix-nginx-proxy`, but at the end of 2023, it hasn't happened yet. The playbook is already using Traefik as the front-most reverse-proxy, but nginx (via `matrix-nginx-proxy`) is still around - it has taken a step back and is only used internally for new setups. Work got to a stall due to: +AI aside, with the playbook's focus being containers, we're **doubling down on being "container native"** and becoming more interoperable for people hosting other containers on the Matrix server. In [2022](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/YEAR-IN-REVIEW.md#2022), we've announced a few sibling Ansible playbooks, their use of [Traefik](https://doc.traefik.io/traefik/) and the possibility of matrix-docker-ansible-deploy also switching to this reverse-proxy. This prediction materialized quickly. The **largest change** in the playbook in 2023 happened way back in February - matrix-docker-ansible-deploy [starting the switch from nginx to Traefik](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/CHANGELOG.md#backward-compatibility-reverse-proxy-configuration-changes-and-initial-traefik-support) and then quickly [making Treafik the default reverse-proxy](https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/850078b7e37401ce91a0f9b686f60b945f6c3a96/CHANGELOG.md#traefik-is-the-default-reverse-proxy-now). As noted in the changelog entries, we envisioned a quick and complete elimination of `matrix-nginx-proxy`, but at the end of 2023, it hasn't happened yet. The playbook is already using Traefik as the front-most reverse-proxy, but nginx (via `matrix-nginx-proxy`) is still around - it has taken a step back and is only used internally for new setups. Work got to a stall due to: * complexity: untangling the overly large and messy `matrix-nginx-proxy` component is difficult * the current setup became "good enough" because nginx has become an internal implementation detail for those who have migrated to Traefik. Traefik is already the default public reverse-proxy and gives better possibilities to people wishing to run other web-exposed containers on their Matrix server via [Docker Compose](https://docs.docker.com/compose/), other Ansible playbooks like [mash-playbook](https://github.com/mother-of-all-self-hosting/mash-playbook) (more about this one, below) or any other way. diff --git a/docs/README.md b/docs/README.md index 0473b77e5..266fad593 100644 --- a/docs/README.md +++ b/docs/README.md @@ -9,7 +9,7 @@ SPDX-License-Identifier: AGPL-3.0-or-later # Table of Contents -## ⬇️ Installaton guides +## ⬇️ Installation guides There are two installation guides available for beginners and advanced users. diff --git a/docs/ansible.md b/docs/ansible.md index ff0398374..4a09af812 100644 --- a/docs/ansible.md +++ b/docs/ansible.md @@ -117,7 +117,7 @@ Then, to be asked for the password whenever running an `ansible-playbook` comman #### Resolve directory ownership issues -Because you're `root` in the container running Ansible and this likely differs fom the owner (your regular user account) of the playbook directory outside of the container, certain playbook features which use `git` locally may report warnings such as: +Because you're `root` in the container running Ansible and this likely differs from the owner (your regular user account) of the playbook directory outside of the container, certain playbook features which use `git` locally may report warnings such as: > fatal: unsafe repository ('/work' is owned by someone else) > To add an exception for this directory, call: diff --git a/docs/configuring-playbook-appservice-draupnir-for-all.md b/docs/configuring-playbook-appservice-draupnir-for-all.md index 0f2362f47..8827f759c 100644 --- a/docs/configuring-playbook-appservice-draupnir-for-all.md +++ b/docs/configuring-playbook-appservice-draupnir-for-all.md @@ -95,13 +95,13 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ## Usage -If you made it through all the steps above and your main control room was joined by a user called `@draupnir-main:example.com` you have succesfully installed Draupnir for All and can now start using it. +If you made it through all the steps above and your main control room was joined by a user called `@draupnir-main:example.com` you have successfully installed Draupnir for All and can now start using it. The installation of Draupnir for all in this playbook is very much Alpha quality. Usage-wise, Draupnir for all is almost identical to Draupnir bot mode. ### Granting Users the ability to use D4A -Draupnir for all includes several security measures like that it only allows users that are on its allow list to ask for a bot. To add a user to this list we have 2 primary options. Using the chat to tell Draupnir to do this for us or if you want to automatically do it by sending `m.policy.rule.user` events that target the subject you want to allow provisioning for with the `org.matrix.mjolnir.allow` recomendation. Using the chat is recomended. +Draupnir for all includes several security measures like that it only allows users that are on its allow list to ask for a bot. To add a user to this list we have 2 primary options. Using the chat to tell Draupnir to do this for us or if you want to automatically do it by sending `m.policy.rule.user` events that target the subject you want to allow provisioning for with the `org.matrix.mjolnir.allow` recommendation. Using the chat is recommended. The bot requires a powerlevel of 50 in the management room to control who is allowed to use the bot. The bot does currently not say anything if this is true or false. (This is considered a bug and is documented in issue [#297](https://github.com/the-draupnir-project/Draupnir/issues/297)) diff --git a/docs/configuring-playbook-bot-chatgpt.md b/docs/configuring-playbook-bot-chatgpt.md index 903fa658f..9b8b9a28b 100644 --- a/docs/configuring-playbook-bot-chatgpt.md +++ b/docs/configuring-playbook-bot-chatgpt.md @@ -57,7 +57,7 @@ matrix_bot_chatgpt_openai_api_key: 'API_KEY_HERE' matrix_bot_chatgpt_matrix_access_token: 'ACCESS_TOKEN_HERE' -# Configuring the system promt used, needed if the bot is used for special tasks. +# Configuring the system prompt used, needed if the bot is used for special tasks. # More information: https://github.com/mustvlad/ChatGPT-System-Prompts matrix_bot_chatgpt_matrix_bot_prompt_prefix: 'Instructions:\nYou are ChatGPT, a large language model trained by OpenAI.' ``` diff --git a/docs/configuring-playbook-bot-draupnir.md b/docs/configuring-playbook-bot-draupnir.md index de2dfb44b..d855c4059 100644 --- a/docs/configuring-playbook-bot-draupnir.md +++ b/docs/configuring-playbook-bot-draupnir.md @@ -242,7 +242,7 @@ For Draupnir to do its job, you need to [give it permissions](https://the-draupn We recommend **subscribing to a public [policy list](https://the-draupnir-project.github.io/draupnir-documentation/concepts/policy-lists)** using the [watch command](https://the-draupnir-project.github.io/draupnir-documentation/moderator/managing-policy-lists#using-draupnirs-watch-command-to-subscribe-to-policy-rooms). -Polcy lists are maintained in Matrix rooms. A popular policy list is maintained in the public `#community-moderation-effort-bl:neko.dev` room. +Policy lists are maintained in Matrix rooms. A popular policy list is maintained in the public `#community-moderation-effort-bl:neko.dev` room. You can tell Draupnir to subscribe to it by sending the following command to the Management Room: `!draupnir watch #community-moderation-effort-bl:neko.dev` diff --git a/docs/configuring-playbook-bot-matrix-registration-bot.md b/docs/configuring-playbook-bot-matrix-registration-bot.md index c171b733a..dc468ec04 100644 --- a/docs/configuring-playbook-bot-matrix-registration-bot.md +++ b/docs/configuring-playbook-bot-matrix-registration-bot.md @@ -77,7 +77,7 @@ Send `help` to the bot to see the available commands. You can also refer to the upstream [Usage documentation](https://github.com/moan0s/matrix-registration-bot#supported-commands). -If you have any questions, or if you need help setting it up, read the [troublshooting guide](https://github.com/moan0s/matrix-registration-bot/blob/main/docs/troubleshooting.md) or join [#matrix-registration-bot:hyteck.de](https://matrix.to/#/#matrix-registration-bot:hyteck.de). +If you have any questions, or if you need help setting it up, read the [troubleshooting guide](https://github.com/moan0s/matrix-registration-bot/blob/main/docs/troubleshooting.md) or join [#matrix-registration-bot:hyteck.de](https://matrix.to/#/#matrix-registration-bot:hyteck.de). 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: diff --git a/docs/configuring-playbook-bridge-hookshot.md b/docs/configuring-playbook-bridge-hookshot.md index 2b24f898a..f1816ab44 100644 --- a/docs/configuring-playbook-bridge-hookshot.md +++ b/docs/configuring-playbook-bridge-hookshot.md @@ -167,7 +167,7 @@ To `matrix_hookshot_container_labels_metrics_middleware_basic_auth_users`, set t #### Enable Grafana (optional) -Probably you wish to enable Grafana along with Prometheus for generating graphs of the metics. +Probably you wish to enable Grafana along with Prometheus for generating graphs of the metrics. To enable Grafana, see [this section](configuring-playbook-prometheus-grafana.md#adjusting-the-playbook-configuration-grafana) for instructions. diff --git a/docs/configuring-playbook-bridge-mautrix-wsproxy.md b/docs/configuring-playbook-bridge-mautrix-wsproxy.md index a9159f2d2..a0d95d68b 100644 --- a/docs/configuring-playbook-bridge-mautrix-wsproxy.md +++ b/docs/configuring-playbook-bridge-mautrix-wsproxy.md @@ -70,7 +70,7 @@ The shortcut commands with the [`just` program](just.md) are also available: `ju ## Usage -Follow the [mautrix-imessage documenation](https://docs.mau.fi/bridges/go/imessage/index.html) for running `android-sms` and/or `matrix-imessage` on your device(s). +Follow the [mautrix-imessage documentation](https://docs.mau.fi/bridges/go/imessage/index.html) for running `android-sms` and/or `matrix-imessage` on your device(s). ## Troubleshooting diff --git a/docs/configuring-playbook-element-call.md b/docs/configuring-playbook-element-call.md index cc88bec70..fed49ade9 100644 --- a/docs/configuring-playbook-element-call.md +++ b/docs/configuring-playbook-element-call.md @@ -30,7 +30,7 @@ These **clients will use their own embedded Element Call frontend**, so **self-h 💡 A reason you may wish to continue installing the Element Call frontend (despite Matrix clients not making use of it), is if you need to use it standalone - directly via a browser (without a Matrix client). Note that unless you [allow guest accounts to use Element Call](#allowing-guests-to-use-element-call-optional), you will still need a Matrix user account **on the same homeserver** to be able to use Element Call. -The playbook makes a distiction between enabling Element Call (`matrix_element_call_enabled`) and enabling the Matrix RTC Stack (`matrix_rtc_enabled`). Enabling Element Call automatically enables the Matrix RTC stack. Because installing the Element Call frontend is now unnecessary, **we recommend only installing the Matrix RTC stack, without the Element Call frontend**. +The playbook makes a distinction between enabling Element Call (`matrix_element_call_enabled`) and enabling the Matrix RTC Stack (`matrix_rtc_enabled`). Enabling Element Call automatically enables the Matrix RTC stack. Because installing the Element Call frontend is now unnecessary, **we recommend only installing the Matrix RTC stack, without the Element Call frontend**. | Description / Variable | Element Call frontend | [LiveKit Server](configuring-playbook-livekit-server.md) | [LiveKit JWT Service](configuring-playbook-livekit-jwt-service.md) | |------------------------|-----------------------|----------------|---------------------| diff --git a/docs/configuring-playbook-matrix-authentication-service.md b/docs/configuring-playbook-matrix-authentication-service.md index ba3c43b8c..9173bd399 100644 --- a/docs/configuring-playbook-matrix-authentication-service.md +++ b/docs/configuring-playbook-matrix-authentication-service.md @@ -41,7 +41,7 @@ Below, we'll try to **highlight some potential reasons for switching** to Matrix ## Prerequisites -- ⚠️ the [Synapse](configuring-playbook-synapse.md) homeserver implementation (which is the default for this playbook). Other homeserver implementations ([Dendrite](./configuring-playbook-dendrite.md), [Conduit](./configuring-playbook-conduit.md), etc.) do not support integrating wtih Matrix Authentication Service yet. +- ⚠️ the [Synapse](configuring-playbook-synapse.md) homeserver implementation (which is the default for this playbook). Other homeserver implementations ([Dendrite](./configuring-playbook-dendrite.md), [Conduit](./configuring-playbook-conduit.md), etc.) do not support integrating with Matrix Authentication Service yet. - ❌ **disabling all password providers** for Synapse (things like [shared-secret-auth](./configuring-playbook-shared-secret-auth.md), [rest-auth](./configuring-playbook-rest-auth.md), [LDAP auth](./configuring-playbook-ldap-auth.md), etc.) More details about this are available in the [Expectations](#expectations) section below. @@ -61,7 +61,7 @@ This section details what you can expect when switching to the Matrix Authentica - ⚠️ [Migrating an existing Synapse homeserver to Matrix Authentication Service](#migrating-an-existing-synapse-homeserver-to-matrix-authentication-service) is **possible**, but requires **some playbook-assisted manual work**. Migration is **reversible with no or minor issues if done quickly enough**, but as users start logging in (creating new login sessions) via the new MAS setup, disabling MAS and reverting back to the Synapse user database will cause these new sessions to break. -- ⚠️ Delegating user authentication to MAS causes **your Synapse server to be completely dependant on one more service** for its operations. MAS is quick & lightweight and should be stable enough already, but this is something to keep in mind when making the switch. +- ⚠️ Delegating user authentication to MAS causes **your Synapse server to be completely dependent on one more service** for its operations. MAS is quick & lightweight and should be stable enough already, but this is something to keep in mind when making the switch. - ⚠️ If you've got [OIDC configured in Synapse](./configuring-playbook-synapse.md#synapse--openid-connect-for-single-sign-on), you will need to migrate your OIDC configuration to MAS by adding an [Upstream OAuth2 configuration](#upstream-oauth2-configuration). @@ -85,7 +85,7 @@ For new homeservers (which don't have any users in their Synapse database yet), ### Existing homeserver -Other homeserver implementations ([Dendrite](./configuring-playbook-dendrite.md), [Conduit](./configuring-playbook-conduit.md), etc.) do not support integrating wtih Matrix Authentication Service yet. +Other homeserver implementations ([Dendrite](./configuring-playbook-dendrite.md), [Conduit](./configuring-playbook-conduit.md), etc.) do not support integrating with Matrix Authentication Service yet. For existing Synapse homeservers: diff --git a/docs/configuring-playbook-matrix-corporal.md b/docs/configuring-playbook-matrix-corporal.md index 34c80fe6b..8f3438292 100644 --- a/docs/configuring-playbook-matrix-corporal.md +++ b/docs/configuring-playbook-matrix-corporal.md @@ -13,7 +13,7 @@ SPDX-License-Identifier: AGPL-3.0-or-later The playbook can install and configure [matrix-corporal](https://github.com/devture/matrix-corporal) for you. -In short, it's a sort of automation and firewalling service, which is helpful if you're instaling Matrix services in a controlled corporate environment. +In short, it's a sort of automation and firewalling service, which is helpful if you're installing Matrix services in a controlled corporate environment. See the project's [documentation](https://github.com/devture/matrix-corporal/blob/main/README.md) to learn what it does and why it might be useful to you. diff --git a/docs/configuring-playbook-matrix-media-repo.md b/docs/configuring-playbook-matrix-media-repo.md index e660d434d..acadf8cf2 100644 --- a/docs/configuring-playbook-matrix-media-repo.md +++ b/docs/configuring-playbook-matrix-media-repo.md @@ -60,7 +60,7 @@ To `matrix_media_repo_container_labels_traefik_metrics_middleware_basic_auth_use #### Enable Grafana (optional) -Probably you wish to enable Grafana along with Prometheus for generating graphs of the metics. +Probably you wish to enable Grafana along with Prometheus for generating graphs of the metrics. To enable Grafana, see [this section](configuring-playbook-prometheus-grafana.md#adjusting-the-playbook-configuration-grafana) for instructions. diff --git a/docs/configuring-playbook-ntfy.md b/docs/configuring-playbook-ntfy.md index 866f4bc96..872385ca8 100644 --- a/docs/configuring-playbook-ntfy.md +++ b/docs/configuring-playbook-ntfy.md @@ -115,7 +115,7 @@ The shortcut commands with the [`just` program](just.md) are also available: `ju ## Usage -To receive push notifications with UnifiedPush from the ntfy server, you need to **install [the ntfy Android app](https://docs.ntfy.sh/subscribe/phone/)** which works as the Distrubutor, **log in to the account on the ntfy app** if you have enabled the access control, and then **configure a UnifiedPush-compatible Matrix client**. After setting up the ntfy Android app, the Matrix client listens to it, and push notitications are "distributed" from it. +To receive push notifications with UnifiedPush from the ntfy server, you need to **install [the ntfy Android app](https://docs.ntfy.sh/subscribe/phone/)** which works as the Distributor, **log in to the account on the ntfy app** if you have enabled the access control, and then **configure a UnifiedPush-compatible Matrix client**. After setting up the ntfy Android app, the Matrix client listens to it, and push notifications are "distributed" from it. For details about installing and configuring the ntfy Android app, take a look at [this section](https://github.com/mother-of-all-self-hosting/ansible-role-ntfy/blob/main/docs/configuring-ntfy.md#install-the-ntfy-androidios-app) on the role's documentation. diff --git a/docs/configuring-playbook-ssl-certificates.md b/docs/configuring-playbook-ssl-certificates.md index f6889f803..277d29f8b 100644 --- a/docs/configuring-playbook-ssl-certificates.md +++ b/docs/configuring-playbook-ssl-certificates.md @@ -15,7 +15,7 @@ By default, the playbook retrieves and automatically renews free SSL certificate **Notes**: - This guide is intended to be referred for configuring the integrated Traefik server with regard to SSL certificates retrieval. If you're using [your own webserver](configuring-playbook-own-webserver.md), consult its documentation about how to configure it. -- Let's Encrypt ends the expiration notification email service on June 4, 2025 (see: [the official announcement](https://letsencrypt.org/2025/01/22/ending-expiration-emails/)), and it recommends using a third party service for those who want to receive expiriation notifications. If you are looking for a self-hosting service, you may be interested in a monitoring tool such as [Update Kuma](https://github.com/louislam/uptime-kuma/). +- Let's Encrypt ends the expiration notification email service on June 4, 2025 (see: [the official announcement](https://letsencrypt.org/2025/01/22/ending-expiration-emails/)), and it recommends using a third party service for those who want to receive expiration notifications. If you are looking for a self-hosting service, you may be interested in a monitoring tool such as [Update Kuma](https://github.com/louislam/uptime-kuma/). The [Mother-of-All-Self-Hosting (MASH)](https://github.com/mother-of-all-self-hosting/mash-playbook) Ansible playbook can be used to install and manage an Uptime Kuma instance. See [this page](https://github.com/mother-of-all-self-hosting/mash-playbook/blob/main/docs/services/uptime-kuma.md) for the instruction to install it with the MASH playbook. If you are wondering how to use the MASH playbook for your Matrix server, refer [this page](https://github.com/mother-of-all-self-hosting/mash-playbook/blob/main/docs/setting-up-services-on-mdad-server.md). diff --git a/docs/configuring-playbook-synapse.md b/docs/configuring-playbook-synapse.md index 4a15ef701..dbb6ef0d6 100644 --- a/docs/configuring-playbook-synapse.md +++ b/docs/configuring-playbook-synapse.md @@ -53,7 +53,7 @@ You may also consider [tweaking the number of workers of each type](#controlling ##### Specialized workers -The playbook now supports a smarter **specialized load-balancing** inspired by [Tom Foster](https://github.com/tcpipuk)'s [Synapse homeserver guide](https://tcpipuk.github.io/synapse/index.html). Instead of routing requests to one or more [generic workers](#generic-workers) based only on the requestor's IP adddress, specialized load-balancing routes to **4 different types of specialized workers** based on **smarter criteria** — the access token (username) of the requestor and/or on the resource (room, etc.) being requested. +The playbook now supports a smarter **specialized load-balancing** inspired by [Tom Foster](https://github.com/tcpipuk)'s [Synapse homeserver guide](https://tcpipuk.github.io/synapse/index.html). Instead of routing requests to one or more [generic workers](#generic-workers) based only on the requester's IP address, specialized load-balancing routes to **4 different types of specialized workers** based on **smarter criteria** — the access token (username) of the requester and/or on the resource (room, etc.) being requested. The playbook supports these **4 types** of specialized workers: diff --git a/docs/faq.md b/docs/faq.md index 9f1ddc6e3..898a1c1f6 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -235,7 +235,7 @@ Running Matrix on a server with 1GB of memory is possible (especially if you dis **We recommend starting with a server having at least 2GB of memory** and even then using it sparingly. If you know for sure you'll be joining various large rooms, etc., then going for 4GB of memory or more is a good idea. -Besides the regular Matrix stuff, we also support things like video-conferencing using [Jitsi](configuring-playbook-jitsi.md) and other additional services which (when installed) may use up a lot of memory. Things do add up. Besides the Synapse Matrix server, Jitsi is especially notorious for consuming a lot of resources. If you plan on running Jitsi, we recommend a server with at least 2GB of memory (preferrably more). See our [Jitsi documentation page](configuring-playbook-jitsi.md) to learn how to optimize its memory/CPU usage. +Besides the regular Matrix stuff, we also support things like video-conferencing using [Jitsi](configuring-playbook-jitsi.md) and other additional services which (when installed) may use up a lot of memory. Things do add up. Besides the Synapse Matrix server, Jitsi is especially notorious for consuming a lot of resources. If you plan on running Jitsi, we recommend a server with at least 2GB of memory (preferably more). See our [Jitsi documentation page](configuring-playbook-jitsi.md) to learn how to optimize its memory/CPU usage. ### Can I run this in an LXC container? @@ -362,7 +362,7 @@ Configuration variables are defined in multiple places in this playbook and are You can discover the variables you can override in each role (`roles/*/*/defaults/main.yml`). -As described in [How is the effective configuration determined?](#how-is-the-effective-configuration-determined), these role-defaults may be overriden by values defined in `group_vars/matrix_servers`. +As described in [How is the effective configuration determined?](#how-is-the-effective-configuration-determined), these role-defaults may be overridden by values defined in `group_vars/matrix_servers`. Refer to both of these for inspiration. Still, as mentioned in [Configuring the playbook](configuring-playbook.md), you're only ever supposed to edit your own `inventory/host_vars/matrix.example.com/vars.yml` file and nothing else inside the playbook (unless you're meaning to contribute new features). diff --git a/docs/howto-srv-server-delegation.md b/docs/howto-srv-server-delegation.md index 9d03588c7..da6d0727a 100644 --- a/docs/howto-srv-server-delegation.md +++ b/docs/howto-srv-server-delegation.md @@ -42,7 +42,7 @@ This is because with SRV federation, some servers / tools (one of which being th ### Tell Traefik which certificate to serve for the federation endpoint -Now that the federation endpoint is not bound to a domain anymore we need to explicitely tell Traefik to use a wildcard certificate in addition to one containing the base name. +Now that the federation endpoint is not bound to a domain anymore we need to explicitly tell Traefik to use a wildcard certificate in addition to one containing the base name. This is because the Matrix specification expects the federation endpoint to be served using a certificate compatible with the base domain, however, the other resources on the endpoint still need a valid certificate to work. diff --git a/examples/reverse-proxies/nginx-proxy-manager/README.md b/examples/reverse-proxies/nginx-proxy-manager/README.md index dad498435..f7042e84e 100644 --- a/examples/reverse-proxies/nginx-proxy-manager/README.md +++ b/examples/reverse-proxies/nginx-proxy-manager/README.md @@ -23,7 +23,7 @@ If Matrix federation is enabled, then you will need to make changes to [NPM's Do You'll need to create two proxy hosts in NPM for Matrix web and federation traffic. -Open the 'Proxy Hosts' page in the NPM web interface and select `Add Proxy Host`, the first being for Matrix web traffic. Apply the proxys configuration like this: +Open the 'Proxy Hosts' page in the NPM web interface and select `Add Proxy Host`, the first being for Matrix web traffic. Apply the proxies configuration like this: ```md # Details @@ -44,7 +44,7 @@ Custom Nginx Configuration: client_max_body_size 50M; ``` -Again, under the 'Proxy Hosts' page select `Add Proxy Host`, this time for your federation traffic. Apply the proxys configuration like this: +Again, under the 'Proxy Hosts' page select `Add Proxy Host`, this time for your federation traffic. Apply the proxies configuration like this: ```md # Details diff --git a/group_vars/matrix_servers b/group_vars/matrix_servers index 0f56508b7..7ed301ade 100755 --- a/group_vars/matrix_servers +++ b/group_vars/matrix_servers @@ -5721,7 +5721,7 @@ matrix_registration_api_validate_certs: "{{ matrix_playbook_ssl_enabled }}" # Postgres is the default, except if not using internal Postgres server matrix_registration_database_engine: "{{ 'postgres' if postgres_enabled else 'sqlite' }}" matrix_registration_database_hostname: "{{ postgres_connection_hostname if postgres_enabled else '' }}" -matrix_registration_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mx.registr.db', rounds=655555) | to_uuid }}" +matrix_registration_database_password: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'mx.register.db', rounds=655555) | to_uuid }}" ###################################################################### # diff --git a/i18n/README.md b/i18n/README.md index 94cf013e4..b0934b3ef 100644 --- a/i18n/README.md +++ b/i18n/README.md @@ -20,7 +20,7 @@ Currently, we support translation of: Organization of this `i18n` directory is as follows: - [PUBLISHED_LANGUAGES](PUBLISHED_LANGUAGES): a list of languages that we publish translations for (in the [translations/](translations/) directory) -- [.gitignore](.gitignore): a list of files and directories to ignore in the `i18n` directory. We intentionaly ignore translated results (`translations/` directories) for languages taht are still in progress. We only [publish translations in a new language](#publish-translations-in-a-new-language) when the translation progresses beyond a certain threshold. +- [.gitignore](.gitignore): a list of files and directories to ignore in the `i18n` directory. We intentionally ignore translated results (`translations/` directories) for languages that are still in progress. We only [publish translations in a new language](#publish-translations-in-a-new-language) when the translation progresses beyond a certain threshold. - [justfile](justfile): a list of recipes for [just](https://github.com/casey/just) command runner - [requirements.txt](requirements.txt): a list of Python packages required to work with translations - [translation-templates/](translation-templates/): a list of English translation templates - strings extracted from Markdown files diff --git a/roles/custom/matrix-appservice-draupnir-for-all/defaults/main.yml b/roles/custom/matrix-appservice-draupnir-for-all/defaults/main.yml index b8b6de00b..89935ee2b 100644 --- a/roles/custom/matrix-appservice-draupnir-for-all/defaults/main.yml +++ b/roles/custom/matrix-appservice-draupnir-for-all/defaults/main.yml @@ -50,7 +50,7 @@ matrix_appservice_draupnir_for_all_systemd_wanted_services_list: [] # anyone in this room can use the bot - secure your room! # This should be a room alias - not a matrix.to URL. # Note: Draupnir is fairly verbose - expect a lot of messages from it. -# This room is diffrent for Appservice Mode compared to normal mode. +# This room is different for Appservice Mode compared to normal mode. # In Appservice mode it provides functions like user management. matrix_appservice_draupnir_for_all_config_adminRoom: "" # noqa var-naming diff --git a/roles/custom/matrix-base/defaults/main.yml b/roles/custom/matrix-base/defaults/main.yml index f30d416f0..bf3947983 100644 --- a/roles/custom/matrix-base/defaults/main.yml +++ b/roles/custom/matrix-base/defaults/main.yml @@ -217,7 +217,7 @@ matrix_homeserver_container_url: "http://{{ matrix_homeserver_container_client_a # Specifies where the homeserver's Client-Server API is on the container network (matrix_homeserver_container_network). # Where this is depends on whether there's a reverse-proxy in front of the homeserver, which homeserver it is, etc. -# This likely gets overriden elsewhere. +# This likely gets overridden elsewhere. matrix_homeserver_container_client_api_endpoint: "" # Specifies where the homeserver's Federation API is on the container network (matrix_homeserver_container_network). @@ -225,7 +225,7 @@ matrix_homeserver_container_federation_url: "http://{{ matrix_homeserver_contain # Specifies where the homeserver's Federation API is on the container network (matrix_homeserver_container_network). # Where this is depends on whether there's a reverse-proxy in front of the homeserver, which homeserver it is, etc. -# This likely gets overriden elsewhere. +# This likely gets overridden elsewhere. matrix_homeserver_container_federation_api_endpoint: "" # Specifies the public url of the Sync v3 (sliding-sync) API. diff --git a/roles/custom/matrix-base/tasks/validate_config.yml b/roles/custom/matrix-base/tasks/validate_config.yml index c372ee03b..f3f4eb166 100644 --- a/roles/custom/matrix-base/tasks/validate_config.yml +++ b/roles/custom/matrix-base/tasks/validate_config.yml @@ -104,7 +104,7 @@ msg: >- Your configuration enables both the old mautrix-instagram bridge and the new mautrix-meta-instagram bridge. By default, both bridges are configured to use the same bridge bot username (`@{{ matrix_mautrix_meta_instagram_appservice_username }}:{{ matrix_domain }}`) which is a conflict. - We recommend that you disable at least one of the bridges (preferrably the old mautrix-instagram bridge), or to resolve the conflict in another way. + We recommend that you disable at least one of the bridges (preferably the old mautrix-instagram bridge), or to resolve the conflict in another way. To resolve the conflict without disabling a bridge, consider adjusting one of `matrix_mautrix_instagram_appservice_bot_username` or `matrix_mautrix_meta_instagram_appservice_username` - they both have a value of {{ matrix_mautrix_meta_instagram_appservice_username }} right now. when: - matrix_mautrix_instagram_enabled | bool diff --git a/roles/custom/matrix-bot-chatgpt/tasks/validate_config.yml b/roles/custom/matrix-bot-chatgpt/tasks/validate_config.yml index d9c266dad..0c7a36ba6 100644 --- a/roles/custom/matrix-bot-chatgpt/tasks/validate_config.yml +++ b/roles/custom/matrix-bot-chatgpt/tasks/validate_config.yml @@ -20,7 +20,7 @@ - name: Fail if OpenAI configuration not up-to-date. ansible.builtin.fail: msg: >- - Your configuration contains a varible that is no longer used. + Your configuration contains a variable that is no longer used. Please change your configuration to remove the variable (`{{ item.name }}`). when: "item.name in vars" with_items: diff --git a/roles/custom/matrix-bot-draupnir/tasks/validate_config.yml b/roles/custom/matrix-bot-draupnir/tasks/validate_config.yml index 9f903f5ee..fd7ddca2b 100644 --- a/roles/custom/matrix-bot-draupnir/tasks/validate_config.yml +++ b/roles/custom/matrix-bot-draupnir/tasks/validate_config.yml @@ -63,7 +63,7 @@ ansible.builtin.fail: msg: >- Your configuration is trying to enable matrix_bot_draupnir_config_experimentalRustCrypto and matrix_bot_draupnir_pantalaimon_use at the same time. - These settings are mutually incompatible and therefore cant be used at the same time. + These settings are mutually incompatible and therefore can't be used at the same time. when: - matrix_bot_draupnir_pantalaimon_use - matrix_bot_draupnir_config_experimentalRustCrypto diff --git a/roles/custom/matrix-bridge-appservice-discord/templates/config.yaml.j2 b/roles/custom/matrix-bridge-appservice-discord/templates/config.yaml.j2 index a304a4f24..9d6974678 100644 --- a/roles/custom/matrix-bridge-appservice-discord/templates/config.yaml.j2 +++ b/roles/custom/matrix-bridge-appservice-discord/templates/config.yaml.j2 @@ -2,7 +2,7 @@ bridge: # Domain part of the bridge, e.g. matrix.org domain: {{ matrix_appservice_discord_bridge_domain|to_json }} - # This should be your publically facing URL because Discord may use it to + # This should be your publicly facing URL because Discord may use it to # fetch media from the media store. homeserverUrl: {{ matrix_appservice_discord_bridge_homeserverUrl|to_json }} # Interval at which to process users in the 'presence queue'. If you have diff --git a/roles/custom/matrix-bridge-appservice-irc/defaults/main.yml b/roles/custom/matrix-bridge-appservice-irc/defaults/main.yml index 3ce0a176d..7ea0ee4cc 100644 --- a/roles/custom/matrix-bridge-appservice-irc/defaults/main.yml +++ b/roles/custom/matrix-bridge-appservice-irc/defaults/main.yml @@ -358,7 +358,7 @@ matrix_appservice_irc_ircService_servers: [] # noqa var-naming # # not apply an idle timeout. This value is ignored if this IRC server is # # mirroring Matrix membership lists to IRC. Default: 172800 (48 hours) # idleTimeout: 10800 -# # The number of millseconds to wait between consecutive reconnections if a +# # The number of milliseconds to wait between consecutive reconnections if a # # client gets disconnected. Setting to 0 will cause the scheduling to be # # disabled, i.e. it will be scheduled immediately (with jitter. # # Otherwise, the scheduling interval will be used such that one client diff --git a/roles/custom/matrix-bridge-go-skype-bridge/templates/config.yaml.j2 b/roles/custom/matrix-bridge-go-skype-bridge/templates/config.yaml.j2 index 6e5ac7f52..2bd1c2c7d 100644 --- a/roles/custom/matrix-bridge-go-skype-bridge/templates/config.yaml.j2 +++ b/roles/custom/matrix-bridge-go-skype-bridge/templates/config.yaml.j2 @@ -224,7 +224,7 @@ logging: # The directory for log files. Will be created if not found. directory: ./logs # Available variables: .Date for the file date and .Index for different log files on the same day. - # empy/null = journal logging only + # empty/null = journal logging only file_name_format: # Date format for file names in the Go time format: https://golang.org/pkg/time/#pkg-constants file_date_format: "2006-01-02" diff --git a/roles/custom/matrix-bridge-mautrix-slack/tasks/validate_config.yml b/roles/custom/matrix-bridge-mautrix-slack/tasks/validate_config.yml index 8265ee865..d4b8edf32 100644 --- a/roles/custom/matrix-bridge-mautrix-slack/tasks/validate_config.yml +++ b/roles/custom/matrix-bridge-mautrix-slack/tasks/validate_config.yml @@ -22,7 +22,7 @@ when: matrix_appservice_slack_enabled | default(False) | bool and matrix_mautrix_slack_appservice_bot_username == matrix_appservice_slack_bot_name | default ('') ansible.builtin.fail: msg: | - The appservice-slack and mautrix-slack components are both enabled and use the same bot username ({{ matrix_mautrix_slack_appservice_bot_username }}), as per their default configuration, which causes a conflcit. + The appservice-slack and mautrix-slack components are both enabled and use the same bot username ({{ matrix_mautrix_slack_appservice_bot_username }}), as per their default configuration, which causes a conflict. To resolve the conflict, make one of these components use a different username. Consider either changing `matrix_mautrix_slack_appservice_bot_username` (the bot username for the mautrix-slack component) or `matrix_appservice_slack_bot_name` (the bot username for the appservice-slack component). We recommend that you change the username for the newly-added (and yet unused) component. diff --git a/roles/custom/matrix-conduwuit/templates/conduwuit.toml.j2 b/roles/custom/matrix-conduwuit/templates/conduwuit.toml.j2 index 0438a2d97..91ee6760f 100644 --- a/roles/custom/matrix-conduwuit/templates/conduwuit.toml.j2 +++ b/roles/custom/matrix-conduwuit/templates/conduwuit.toml.j2 @@ -586,7 +586,7 @@ trusted_servers = {{ matrix_conduwuit_trusted_servers | to_json }} # specifically on room joins. This option limits the exposure to a # compromised trusted server to room joins only. The join operation # requires gathering keys from many origin servers which can cause -# significant delays. Therefor this defaults to true to mitigate +# significant delays. Therefore this defaults to true to mitigate # unexpected delays out-of-the-box. The security-paranoid or those willing # to tolerate delays are advised to set this to false. Note that setting # query_trusted_key_servers_first to true causes this option to be @@ -597,7 +597,7 @@ trusted_servers = {{ matrix_conduwuit_trusted_servers | to_json }} # Only query trusted servers for keys and never the origin server. This is # intended for clusters or custom deployments using their trusted_servers # as forwarding-agents to cache and deduplicate requests. Notary servers -# do not act as forwarding-agents by default, therefor do not enable this +# do not act as forwarding-agents by default, therefore do not enable this # unless you know exactly what you are doing. # #only_query_trusted_key_servers = false diff --git a/roles/custom/matrix-continuwuity/templates/continuwuity.toml.j2 b/roles/custom/matrix-continuwuity/templates/continuwuity.toml.j2 index 46b78a2aa..75d2f1d38 100644 --- a/roles/custom/matrix-continuwuity/templates/continuwuity.toml.j2 +++ b/roles/custom/matrix-continuwuity/templates/continuwuity.toml.j2 @@ -586,7 +586,7 @@ trusted_servers = {{ matrix_continuwuity_trusted_servers | to_json }} # specifically on room joins. This option limits the exposure to a # compromised trusted server to room joins only. The join operation # requires gathering keys from many origin servers which can cause -# significant delays. Therefor this defaults to true to mitigate +# significant delays. Therefore this defaults to true to mitigate # unexpected delays out-of-the-box. The security-paranoid or those willing # to tolerate delays are advised to set this to false. Note that setting # query_trusted_key_servers_first to true causes this option to be @@ -597,7 +597,7 @@ trusted_servers = {{ matrix_continuwuity_trusted_servers | to_json }} # Only query trusted servers for keys and never the origin server. This is # intended for clusters or custom deployments using their trusted_servers # as forwarding-agents to cache and deduplicate requests. Notary servers -# do not act as forwarding-agents by default, therefor do not enable this +# do not act as forwarding-agents by default, therefore do not enable this # unless you know exactly what you are doing. # #only_query_trusted_key_servers = false diff --git a/roles/custom/matrix-coturn/defaults/main.yml b/roles/custom/matrix-coturn/defaults/main.yml index 84e1d42c2..d3616f1b5 100644 --- a/roles/custom/matrix-coturn/defaults/main.yml +++ b/roles/custom/matrix-coturn/defaults/main.yml @@ -34,7 +34,7 @@ matrix_coturn_docker_image_force_pull: "{{ matrix_coturn_docker_image.endswith(' # The Docker network that coturn would be put into. # # Because coturn relays traffic to unvalidated IP addresses, -# using a dedicated network, isolated from other Docker (and local) services is preferrable. +# using a dedicated network, isolated from other Docker (and local) services is preferable. # # Setting up deny/allow rules with `matrix_coturn_allowed_peer_ips`/`matrix_coturn_denied_peer_ips` is also # possible for achieving such isolation, but is more complicated due to the dynamic nature of Docker networking. diff --git a/roles/custom/matrix-dendrite/defaults/main.yml b/roles/custom/matrix-dendrite/defaults/main.yml index d4b1bab79..c84c98656 100644 --- a/roles/custom/matrix-dendrite/defaults/main.yml +++ b/roles/custom/matrix-dendrite/defaults/main.yml @@ -355,7 +355,7 @@ matrix_dendrite_user_api_auto_join_rooms: [] # name, number of active users and some information on your deployment config. matrix_dendrite_report_stats: false -# Contorls whether thumbnails for media content are generated dynamically +# Controls whether thumbnails for media content are generated dynamically matrix_dendrite_media_api_dynamic_thumbnails: false matrix_dendrite_media_api_max_thumbnail_generators: 10 diff --git a/roles/custom/matrix-dynamic-dns/defaults/main.yml b/roles/custom/matrix-dynamic-dns/defaults/main.yml index 2c5214edd..90505efec 100644 --- a/roles/custom/matrix-dynamic-dns/defaults/main.yml +++ b/roles/custom/matrix-dynamic-dns/defaults/main.yml @@ -36,7 +36,7 @@ matrix_dynamic_dns_container_additional_networks: "{{ matrix_dynamic_dns_contain matrix_dynamic_dns_container_additional_networks_auto: [] matrix_dynamic_dns_container_additional_networks_custom: [] -# List of extra arguments to pass to the ontainer mode +# List of extra arguments to pass to the container mode matrix_dynamic_dns_container_extra_arguments: [] # List of wanted services when running in mode diff --git a/roles/custom/matrix-ma1sd/defaults/main.yml b/roles/custom/matrix-ma1sd/defaults/main.yml index 05be4717e..3a9c738fa 100644 --- a/roles/custom/matrix-ma1sd/defaults/main.yml +++ b/roles/custom/matrix-ma1sd/defaults/main.yml @@ -150,7 +150,7 @@ matrix_ma1sd_database_name: 'matrix_ma1sd' matrix_ma1sd_database_connection_string: 'postgresql://{{ matrix_ma1sd_database_username }}:{{ matrix_ma1sd_database_password }}@{{ matrix_ma1sd_database_hostname }}:{{ matrix_ma1sd_database_port }}/{{ matrix_ma1sd_database_name }}' -# ma1sd has serveral supported identity stores. +# ma1sd has several supported identity stores. # One of them is storing identities directly in Synapse's database. # Learn more here: https://github.com/ma1uta/ma1sd/blob/master/docs/stores/synapse.md matrix_ma1sd_synapsesql_enabled: false diff --git a/roles/custom/matrix-media-repo/templates/grafana/media-repo.json b/roles/custom/matrix-media-repo/templates/grafana/media-repo.json index d3dca38c0..cfb5cb652 100644 --- a/roles/custom/matrix-media-repo/templates/grafana/media-repo.json +++ b/roles/custom/matrix-media-repo/templates/grafana/media-repo.json @@ -131,7 +131,7 @@ "refId": "B" } ], - "title": "HTTP Requsts", + "title": "HTTP Requests", "type": "timeseries" }, { diff --git a/roles/custom/matrix-prometheus-nginxlog-exporter/tasks/validate_config.yml b/roles/custom/matrix-prometheus-nginxlog-exporter/tasks/validate_config.yml index 67668dc7e..4137efc24 100644 --- a/roles/custom/matrix-prometheus-nginxlog-exporter/tasks/validate_config.yml +++ b/roles/custom/matrix-prometheus-nginxlog-exporter/tasks/validate_config.yml @@ -16,7 +16,7 @@ - {'old': 'matrix_prometheus_nginxlog_exporter_container_hostname', 'new': 'matrix_prometheus_nginxlog_exporter_identifier'} - {'old': 'matrix_prometheus_nginxlog_exporter_docker_image_name_prefix', 'new': 'matrix_prometheus_nginxlog_exporter_docker_image_registry_prefix'} -- name: Fail if docker image not availble for arch +- name: Fail if docker image not available for arch ansible.builtin.fail: msg: > 'prometheus-nginxlog-exporter' docker image is not available for your arch '{{ matrix_architecture }}'. diff --git a/roles/custom/matrix-synapse/defaults/main.yml b/roles/custom/matrix-synapse/defaults/main.yml index c1b2409ee..d291a448e 100644 --- a/roles/custom/matrix-synapse/defaults/main.yml +++ b/roles/custom/matrix-synapse/defaults/main.yml @@ -501,7 +501,7 @@ matrix_synapse_tls_federation_listener_enabled: true matrix_synapse_tls_certificate_path: "/data/{{ matrix_server_fqn_matrix }}.tls.crt" matrix_synapse_tls_private_key_path: "/data/{{ matrix_server_fqn_matrix }}.tls.key" -# Resource names used by the unsecure HTTP listener. Here only the Client API +# Resource names used by the insecure HTTP listener. Here only the Client API # is defined, see the homeserver config for a full list of valid resource # names. matrix_synapse_http_listener_resource_names: ["client"] @@ -835,7 +835,7 @@ matrix_synapse_workers_enabled: false # Specifies worker configuration that should be used when workers are enabled. # -# The posible values (as seen in `matrix_synapse_workers_presets`) are: +# The possible values (as seen in `matrix_synapse_workers_presets`) are: # - "little-federation-helper" - a very minimal worker configuration to improve federation performance # - "one-of-each" - one worker of each supported type + a generic worker # - "specialized-workers" - one worker of each supported type + specialized workers @@ -1458,7 +1458,7 @@ matrix_synapse_ext_encryption_disabler_deny_encryption_for_rooms_of: ["{{ matrix # Specifies whether the power levels event (setting) provided during room creation should be patched. # This makes it impossible for anybody (locally or over federation) from enabling room encryption # for the lifetime of rooms created while this setting is enabled (irreversible). -# Enabling this may have incompatiblity consequences with servers / clients. +# Enabling this may have incompatibility consequences with servers / clients. # Familiarize yourself with the caveats upstream: https://github.com/digitalentity/matrix_encryption_disabler matrix_synapse_ext_encryption_disabler_patch_power_levels: false matrix_synapse_ext_encryption_config: "{{ matrix_synapse_ext_encryption_config_yaml | from_yaml }}" diff --git a/roles/custom/matrix-synapse/templates/synapse/homeserver.yaml.j2 b/roles/custom/matrix-synapse/templates/synapse/homeserver.yaml.j2 index 738dbaeae..6eb6df116 100644 --- a/roles/custom/matrix-synapse/templates/synapse/homeserver.yaml.j2 +++ b/roles/custom/matrix-synapse/templates/synapse/homeserver.yaml.j2 @@ -305,7 +305,7 @@ listeners: compress: false {% endif %} - # Unsecure HTTP listener (Client API): for when Matrix traffic passes through a reverse proxy + # Insecure HTTP listener (Client API): for when Matrix traffic passes through a reverse proxy # that unwraps TLS. - port: {{ matrix_synapse_container_client_api_port|to_json }} tls: false @@ -318,7 +318,7 @@ listeners: compress: false {% if matrix_synapse_federation_port_enabled %} - # Unsecure HTTP listener (Federation API): for when Matrix traffic passes through a reverse proxy + # Insecure HTTP listener (Federation API): for when Matrix traffic passes through a reverse proxy # that unwraps TLS. - port: {{ matrix_synapse_container_federation_api_plain_port|to_json }} tls: false @@ -1709,7 +1709,7 @@ old_signing_keys: # Additional security can be provided by configuring a `verify key`, which # will make synapse check that the response is signed by that key. # -# This setting supercedes an older setting named `perspectives`. The old format +# This setting supersedes an older setting named `perspectives`. The old format # is still supported for backwards-compatibility, but it is deprecated. # # 'trusted_key_servers' defaults to matrix.org, but using it will generate a diff --git a/roles/custom/matrix-user-creator/tasks/main.yml b/roles/custom/matrix-user-creator/tasks/main.yml index 8f166bb1c..976f34067 100644 --- a/roles/custom/matrix-user-creator/tasks/main.yml +++ b/roles/custom/matrix-user-creator/tasks/main.yml @@ -7,7 +7,7 @@ - tags: # This role intentionally doesn't do work on a `setup-all` tag. - # If it did, the initial installation (`--tags=setup-all`) would also potentially polute the database with data, + # If it did, the initial installation (`--tags=setup-all`) would also potentially pollute the database with data, # which would make importing a database dump problematic. # # See the variable "matrix_user_creator_users_auto" on group_vars/matrix_servers for actual values of users which running these tags can create with this role by default. diff --git a/roles/custom/matrix_playbook_migration/defaults/main.yml b/roles/custom/matrix_playbook_migration/defaults/main.yml index 2cac16e45..78898231a 100644 --- a/roles/custom/matrix_playbook_migration/defaults/main.yml +++ b/roles/custom/matrix_playbook_migration/defaults/main.yml @@ -81,7 +81,7 @@ matrix_playbook_migration_matrix_nginx_proxy_leftover_variable_validation_checks matrix_playbook_migration_matrix_ssl_leftover_variable_checks_enabled: true # Controls whether this role will delete old files left over from `matrix-nginx-proxy`. -# Regardless of this value, if discovered, a `matrix-nginx-proxy.service` systemd serivce will be stopped and removed. +# Regardless of this value, if discovered, a `matrix-nginx-proxy.service` systemd service will be stopped and removed. matrix_playbook_migration_matrix_nginx_proxy_uninstallation_enabled: true # Controls whether this role will try to detect and clean up the /matrix/ssl files. diff --git a/roles/custom/matrix_playbook_migration/tasks/docker_daemon_options_file_cleanup.yml b/roles/custom/matrix_playbook_migration/tasks/docker_daemon_options_file_cleanup.yml index e7636161e..6a26c9e29 100644 --- a/roles/custom/matrix_playbook_migration/tasks/docker_daemon_options_file_cleanup.yml +++ b/roles/custom/matrix_playbook_migration/tasks/docker_daemon_options_file_cleanup.yml @@ -15,7 +15,7 @@ # Later, when they stopped setting these options, they were stuck with the configuration file that still retained them. # # Here, we make the file go away of no options are set. -# Idealy, this task would be part of the `ansible-role-docker` role, but it's not (yet). +# Ideally, this task would be part of the `ansible-role-docker` role, but it's not (yet). # See: https://github.com/geerlingguy/ansible-role-docker/pull/498 - name: Ensure the Docker daemon options file is deleted when no longer needed when: matrix_playbook_docker_installation_daemon_options.keys() | length == 0