diff --git a/docs/configuring-dns.md b/docs/configuring-dns.md index b4416917a..016aa99a1 100644 --- a/docs/configuring-dns.md +++ b/docs/configuring-dns.md @@ -75,7 +75,7 @@ The `etherpad.` subdomain may be necessary, because this playbook c The `hydrogen.` subdomain may be necessary, because this playbook could install the [Hydrogen](https://github.com/element-hq/hydrogen-web) web client. The installation of Hydrogen is disabled by default, it is not a core required component. To learn how to install it, see our [configuring Hydrogen guide](configuring-playbook-client-hydrogen.md). If you do not wish to set up Hydrogen, feel free to skip the `hydrogen.` DNS record. -The `cinny.` subdomain may be necessary, because this playbook could install the [Cinny](https://github.com/ajbura/cinny) web client. The installation of cinny is disabled by default, it is not a core required component. To learn how to install it, see our [configuring cinny guide](configuring-playbook-client-cinny.md). If you do not wish to set up cinny, feel free to skip the `cinny.` DNS record. +The `cinny.` subdomain may be necessary, because this playbook could install the [Cinny](https://github.com/ajbura/cinny) web client. The installation of Cinny is disabled by default, it is not a core required component. To learn how to install it, see our [configuring Cinny guide](configuring-playbook-client-cinny.md). If you do not wish to set up Cinny, feel free to skip the `cinny.` DNS record. The `wsproxy.` subdomain may be necessary, because this playbook could install the [wsproxy](https://github.com/mautrix/wsproxy) web client. The installation of wsproxy is disabled by default, it is not a core required component. To learn how to install it, see our [configuring wsproxy guide](configuring-playbook-bridge-mautrix-wsproxy.md). If you do not wish to set up wsproxy, feel free to skip the `wsproxy.` DNS record. diff --git a/docs/configuring-playbook-cactus-comments.md b/docs/configuring-playbook-cactus-comments.md index 8b3cfdd1a..5fa4f36a3 100644 --- a/docs/configuring-playbook-cactus-comments.md +++ b/docs/configuring-playbook-cactus-comments.md @@ -21,7 +21,7 @@ Add the following block to your `vars.yaml` and make sure to exchange the tokens ```yaml ################# -## Cactus Chat ## +## Cactus Comments ## ################# # This enables the backend (appservice) diff --git a/docs/configuring-playbook-client-cinny.md b/docs/configuring-playbook-client-cinny.md index 73a8bbeee..da2175311 100644 --- a/docs/configuring-playbook-client-cinny.md +++ b/docs/configuring-playbook-client-cinny.md @@ -1,17 +1,17 @@ # Configuring Cinny (optional) This playbook can install the [cinny](https://github.com/ajbura/cinny) Matrix web client for you. -cinny is a web client focusing primarily on simple, elegant and secure interface. -cinny can be installed alongside or instead of Element. +Cinny is a web client focusing primarily on simple, elegant and secure interface. +Cinny can be installed alongside or instead of Element. -If you'd like cinny to be installed, add the following to your configuration file (`inventory/host_vars/matrix./vars.yml`): +If you'd like Cinny to be installed, add the following to your configuration file (`inventory/host_vars/matrix./vars.yml`): ```yaml matrix_client_cinny_enabled: true ``` -You will also need to add a DNS record so that cinny can be accessed. -By default cinny will use https://cinny.DOMAIN so you will need to create an CNAME record +You will also need to add a DNS record so that Cinny can be accessed. +By default Cinny will use https://cinny.DOMAIN so you will need to create an CNAME record for `cinny`. See [Configuring DNS](configuring-dns.md). If you would like to use a different domain, add the following to your configuration file (changing it to use your preferred domain): diff --git a/docs/configuring-playbook-conduit.md b/docs/configuring-playbook-conduit.md index 79964dcd9..632d2e150 100644 --- a/docs/configuring-playbook-conduit.md +++ b/docs/configuring-playbook-conduit.md @@ -29,11 +29,11 @@ However, since Conduit is difficult (see [famedly/conduit#276](https://gitlab.co ## Configuring bridges / appservices -Automatic appservice setup is currently unsupported when using conduit. After setting up the service as usual you may notice that it is unable to start. +Automatic appservice setup is currently unsupported when using Conduit. After setting up the service as usual you may notice that it is unable to start. You will have to manually register appservices using the the [register-appservice](https://gitlab.com/famedly/conduit/-/blob/next/APPSERVICES.md) command. -Find the `registration.yaml` in the `/matrix` directory, for example `/matrix/mautrix-signal/bridge/registration.yaml`, then pass the content to conduit: +Find the `registration.yaml` in the `/matrix` directory, for example `/matrix/mautrix-signal/bridge/registration.yaml`, then pass the content to Conduit: @conduit:your.server.name: register-appservice diff --git a/group_vars/matrix_servers b/group_vars/matrix_servers index 4a3c67c28..3108ba107 100755 --- a/group_vars/matrix_servers +++ b/group_vars/matrix_servers @@ -228,7 +228,7 @@ matrix_addons_homeserver_container_network: "{{ matrix_playbook_reverse_proxy_co matrix_addons_homeserver_client_api_url: "{{ ('http://' + matrix_playbook_reverse_proxy_hostname + ':' + matrix_playbook_internal_matrix_client_api_traefik_entrypoint_port | string) if matrix_playbook_internal_matrix_client_api_traefik_entrypoint_enabled else matrix_homeserver_container_url }}" matrix_addons_homeserver_systemd_services_list: "{{ ([traefik_identifier + '.service'] if matrix_playbook_reverse_proxy_type == 'playbook-managed-traefik' else []) if matrix_playbook_internal_matrix_client_api_traefik_entrypoint_enabled else matrix_homeserver_systemd_services_list }}" -# Starting from version `0.6.0` conduit natively supports some sync v3 (sliding-sync) features. +# Starting from version `0.6.0` Conduit natively supports some sync v3 (sliding-sync) features. matrix_homeserver_sliding_sync_url: "{{ matrix_sliding_sync_base_url if matrix_sliding_sync_enabled else (matrix_homeserver_url if matrix_homeserver_implementation in ['conduit'] else '') }}" ######################################################################## diff --git a/roles/custom/matrix-bridge-mautrix-discord/defaults/main.yml b/roles/custom/matrix-bridge-mautrix-discord/defaults/main.yml index eece1fab9..6e691c163 100644 --- a/roles/custom/matrix-bridge-mautrix-discord/defaults/main.yml +++ b/roles/custom/matrix-bridge-mautrix-discord/defaults/main.yml @@ -153,6 +153,6 @@ matrix_mautrix_discord_bridge_encryption_allow: "{{ matrix_bridges_encryption_en matrix_mautrix_discord_bridge_encryption_default: "{{ matrix_bridges_encryption_default }}" matrix_mautrix_discord_bridge_encryption_key_sharing_allow: "{{ matrix_mautrix_discord_bridge_encryption_allow }}" -# On conduit versions before 0.5.0 this option prevented users from joining spaces created by the bridge. +# On Conduit versions before 0.5.0 this option prevented users from joining spaces created by the bridge. # Setting this to false fixed the issue. matrix_mautrix_discord_bridge_restricted_rooms: true diff --git a/roles/custom/matrix-client-cinny/defaults/main.yml b/roles/custom/matrix-client-cinny/defaults/main.yml index 1a067e14b..302ed47e5 100644 --- a/roles/custom/matrix-client-cinny/defaults/main.yml +++ b/roles/custom/matrix-client-cinny/defaults/main.yml @@ -141,7 +141,7 @@ matrix_client_cinny_self_check_validate_certificates: true # config.json matrix_client_cinny_default_hs_url: "" -# Default cinny configuration template which covers the generic use case. +# Default Cinny configuration template which covers the generic use case. # You can customize it by controlling the various variables inside it. # # For a more advanced customization, you can extend the default (see `matrix_client_cinny_configuration_extension_json`) @@ -151,7 +151,7 @@ matrix_client_cinny_default_hs_url: "" # This is unlike what it does when looking up YAML template files (no automatic parsing there). matrix_client_cinny_configuration_default: "{{ lookup('template', 'templates/config.json.j2') }}" -# Your custom JSON configuration for cinny should go to `matrix_client_cinny_configuration_extension_json`. +# Your custom JSON configuration for Cinny should go to `matrix_client_cinny_configuration_extension_json`. # This configuration extends the default starting configuration (`matrix_client_cinny_configuration_default`). # # You can override individual variables from the default configuration, or introduce new ones. @@ -162,6 +162,6 @@ matrix_client_cinny_configuration_extension_json: '{}' matrix_client_cinny_configuration_extension: "{{ matrix_client_cinny_configuration_extension_json | from_json if matrix_client_cinny_configuration_extension_json | from_json is mapping else {} }}" -# Holds the final cinny configuration (a combination of the default and its extension). +# Holds the final Cinny configuration (a combination of the default and its extension). # You most likely don't need to touch this variable. Instead, see `matrix_client_cinny_configuration_default`. matrix_client_cinny_configuration: "{{ matrix_client_cinny_configuration_default | combine(matrix_client_cinny_configuration_extension, recursive=True) }}"