From 3af7355d14c7f4e51ca34995098f390613a33a2f Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Thu, 7 Nov 2024 19:04:51 +0900 Subject: [PATCH 1/3] =?UTF-8?q?Fix=20capitalization:=20element=20=E2=86=92?= =?UTF-8?q?=20Element?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-bot-chatgpt.md | 2 +- examples/reverse-proxies/caddy2/README.md | 2 +- roles/custom/matrix-bot-go-neb/defaults/main.yml | 2 +- roles/custom/matrix-static-files/defaults/main.yml | 2 +- .../matrix_playbook_migration/tasks/validate_config.yml | 4 ++-- 5 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/configuring-playbook-bot-chatgpt.md b/docs/configuring-playbook-bot-chatgpt.md index a24157c46..26973d43e 100644 --- a/docs/configuring-playbook-bot-chatgpt.md +++ b/docs/configuring-playbook-bot-chatgpt.md @@ -25,7 +25,7 @@ ansible-playbook -i inventory/hosts setup.yml --extra-vars='username=bot.chatgpt Refer to the documentation on [how to obtain an access token](obtaining-access-tokens.md). -To make sure the bot can read encrypted messages, it will need an encryption key, just like any other new user. While obtaining the access token, follow the prompts to setup a backup key. More information can be found in the [element documentation](https://element.io/help#encryption6). +To make sure the bot can read encrypted messages, it will need an encryption key, just like any other new user. While obtaining the access token, follow the prompts to setup a backup key. More information can be found in the [Element documentation](https://element.io/help#encryption6). ## 3. Adjusting the playbook configuration diff --git a/examples/reverse-proxies/caddy2/README.md b/examples/reverse-proxies/caddy2/README.md index 2dc3d6b62..29693edc6 100644 --- a/examples/reverse-proxies/caddy2/README.md +++ b/examples/reverse-proxies/caddy2/README.md @@ -13,4 +13,4 @@ To get started, first follow the [front the integrated reverse-proxy webserver w You can either just use the [Caddyfile](Caddyfile) directly or append its content to your own Caddyfile. In both cases make sure to replace all the `example.com` domains with your own domain. -This example does not include additional services like element, but you should be able copy the first block and replace the `matrix` subdomain with the additional services subdomain. I have not tested this though. +This example does not include additional services like Element, but you should be able copy the first block and replace the `matrix` subdomain with the additional services subdomain. I have not tested this though. diff --git a/roles/custom/matrix-bot-go-neb/defaults/main.yml b/roles/custom/matrix-bot-go-neb/defaults/main.yml index 2473f86f2..359101bba 100644 --- a/roles/custom/matrix-bot-go-neb/defaults/main.yml +++ b/roles/custom/matrix-bot-go-neb/defaults/main.yml @@ -163,7 +163,7 @@ matrix_bot_go_neb_storage_database: "{{ # The access tokens that the bot uses to authenticate. # Generate one as described in # https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/master/docs/configuring-playbook-dimension.md#access-token -# via curl. With the element method, you might run into decryption problems (see https://github.com/matrix-org/go-neb#quick-start) +# via curl. With the Element method, you might run into decryption problems (see https://github.com/matrix-org/go-neb#quick-start) matrix_bot_go_neb_clients: [] # - UserID: "@goneb:{{ matrix_domain }}" # AccessToken: "MDASDASJDIASDJASDAFGFRGER" diff --git a/roles/custom/matrix-static-files/defaults/main.yml b/roles/custom/matrix-static-files/defaults/main.yml index 916b26a2b..60d1f555f 100644 --- a/roles/custom/matrix-static-files/defaults/main.yml +++ b/roles/custom/matrix-static-files/defaults/main.yml @@ -161,7 +161,7 @@ matrix_static_files_file_matrix_client_property_m_tile_server_entries_enabled: f # Controls the m.tile_server/map_style_url property in the /.well-known/matrix/client file matrix_static_files_file_matrix_client_property_m_tile_server_map_style_url: "" -# Controls whether element related entries (io.element.e2ee) should be added to the client well-known. +# Controls whether Element related entries (io.element.e2ee) should be added to the client well-known. # By default if any of the following change from their default this would be set to true: # `matrix_static_files_file_matrix_client_property_io_element_e2ee_default` # `matrix_static_files_file_matrix_client_property_io_element_e2ee_secure_backup_required` diff --git a/roles/custom/matrix_playbook_migration/tasks/validate_config.yml b/roles/custom/matrix_playbook_migration/tasks/validate_config.yml index 7d680d529..4c7193f52 100644 --- a/roles/custom/matrix_playbook_migration/tasks/validate_config.yml +++ b/roles/custom/matrix_playbook_migration/tasks/validate_config.yml @@ -272,8 +272,8 @@ - {'old': 'matrix_nginx_proxy_base_domain_homepage_enabled', 'new': 'matrix_static_files_file_index_html_enabled'} - {'old': 'matrix_nginx_proxy_base_domain_homepage_template', 'new': 'matrix_static_files_file_index_html_template'} - {'old': 'matrix_nginx_proxy_base_domain_create_directory', 'new': ''} - - {'old': 'matrix_nginx_proxy_proxy_riot_compat_redirect_enabled', 'new': ''} - - {'old': 'matrix_nginx_proxy_proxy_riot_compat_redirect_hostname', 'new': ''} + - {'old': 'matrix_nginx_proxy_proxy_riot_compat_redirect_enabled', 'new': ''} + - {'old': 'matrix_nginx_proxy_proxy_riot_compat_redirect_hostname', 'new': ''} - {'old': 'matrix_nginx_proxy_proxy_matrix_client_redirect_enabled', 'new': ''} - {'old': 'matrix_nginx_proxy_proxy_matrix_client_redirect_root_uri_to_domain', 'new': ''} - {'old': 'matrix_nginx_proxy_proxy_matrix_client_api_forwarded_location_synapse_client_api_enabled', 'new': 'matrix_synapse_container_labels_public_client_synapse_client_api_enabled'} From b61d8f478f5fcb003ca6c3150c50f03b4a89720e Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Fri, 8 Nov 2024 12:54:48 +0900 Subject: [PATCH 2/3] =?UTF-8?q?Fix=20capitalization:=20ids=20=E2=86=92=20I?= =?UTF-8?q?Ds?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-matrix-authentication-service.md | 2 +- examples/vars.yml | 2 +- roles/custom/matrix-base/defaults/main.yml | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/configuring-playbook-matrix-authentication-service.md b/docs/configuring-playbook-matrix-authentication-service.md index 73b6f1e85..adf97a554 100644 --- a/docs/configuring-playbook-matrix-authentication-service.md +++ b/docs/configuring-playbook-matrix-authentication-service.md @@ -365,7 +365,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 -# Adjust the mapping below to match your provider ids on the Synapse side and the MAS side. +# Adjust the mapping below to match your provider IDs on the Synapse side and the MAS side. # Don't forget that Synapse automatically adds an `oidc-` prefix to provider ids defined in its configuration. matrix_authentication_service_syn2mas_process_extra_arguments: - "--upstreamProviderMapping oidc-keycloak:01HFVBY12TMNTYTBV8W921M5FA" diff --git a/examples/vars.yml b/examples/vars.yml index b6f20c277..ff898d34b 100644 --- a/examples/vars.yml +++ b/examples/vars.yml @@ -1,6 +1,6 @@ --- # The bare domain name which represents your Matrix identity. -# Matrix user ids for your server will be of the form (`@user:example.com`). +# Matrix user IDs for your server will be of the form (`@user:example.com`). # # Note: this playbook does not touch the server referenced here. # Installation happens on another server ("matrix.example.com", see `matrix_server_fqn_matrix`). diff --git a/roles/custom/matrix-base/defaults/main.yml b/roles/custom/matrix-base/defaults/main.yml index 592837020..8fff9e053 100644 --- a/roles/custom/matrix-base/defaults/main.yml +++ b/roles/custom/matrix-base/defaults/main.yml @@ -1,7 +1,7 @@ --- # The bare domain name which represents your Matrix identity. -# Matrix user ids for your server will be of the form (`@user:example.com`). +# Matrix user IDs for your server will be of the form (`@user:example.com`). # # Note: this playbook does not touch the server referenced here. # Installation happens on another server ("matrix.example.com", see `matrix_server_fqn_matrix`). From 2fcd824d6bebaa1fe6daaccd5fdfde3e1f14529d Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Fri, 8 Nov 2024 20:36:35 +0900 Subject: [PATCH 3/3] =?UTF-8?q?Fix=20capitalization:=20riot=20=E2=86=92=20?= =?UTF-8?q?Riot?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Suguru Hirahara --- roles/custom/matrix-bridge-appservice-irc/defaults/main.yml | 2 +- .../matrix_playbook_migration/tasks/validate_config.yml | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/roles/custom/matrix-bridge-appservice-irc/defaults/main.yml b/roles/custom/matrix-bridge-appservice-irc/defaults/main.yml index 0e6ffbc09..3b220d829 100644 --- a/roles/custom/matrix-bridge-appservice-irc/defaults/main.yml +++ b/roles/custom/matrix-bridge-appservice-irc/defaults/main.yml @@ -77,7 +77,7 @@ matrix_appservice_irc_ircService_servers: [] # noqa var-naming # # networkId: "example" # # URL to an icon used as the network icon whenever this network appear in -# # a network list. (Like in the riot room directory, for instance.) +# # a network list. (Like in the Riot room directory, for instance.) # # icon: https://example.com/images/hash.png # # The port to connect to. Optional. diff --git a/roles/custom/matrix_playbook_migration/tasks/validate_config.yml b/roles/custom/matrix_playbook_migration/tasks/validate_config.yml index 4c7193f52..e9606032f 100644 --- a/roles/custom/matrix_playbook_migration/tasks/validate_config.yml +++ b/roles/custom/matrix_playbook_migration/tasks/validate_config.yml @@ -272,8 +272,8 @@ - {'old': 'matrix_nginx_proxy_base_domain_homepage_enabled', 'new': 'matrix_static_files_file_index_html_enabled'} - {'old': 'matrix_nginx_proxy_base_domain_homepage_template', 'new': 'matrix_static_files_file_index_html_template'} - {'old': 'matrix_nginx_proxy_base_domain_create_directory', 'new': ''} - - {'old': 'matrix_nginx_proxy_proxy_riot_compat_redirect_enabled', 'new': ''} - - {'old': 'matrix_nginx_proxy_proxy_riot_compat_redirect_hostname', 'new': ''} + - {'old': 'matrix_nginx_proxy_proxy_riot_compat_redirect_enabled', 'new': ''} + - {'old': 'matrix_nginx_proxy_proxy_riot_compat_redirect_hostname', 'new': ''} - {'old': 'matrix_nginx_proxy_proxy_matrix_client_redirect_enabled', 'new': ''} - {'old': 'matrix_nginx_proxy_proxy_matrix_client_redirect_root_uri_to_domain', 'new': ''} - {'old': 'matrix_nginx_proxy_proxy_matrix_client_api_forwarded_location_synapse_client_api_enabled', 'new': 'matrix_synapse_container_labels_public_client_synapse_client_api_enabled'}