Fix capitalization: element, ids, riotpull/3763/head
| @@ -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). | 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 | ## 3. Adjusting the playbook configuration | ||||
| @@ -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: | 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 | ```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. | # Don't forget that Synapse automatically adds an `oidc-` prefix to provider ids defined in its configuration. | ||||
| matrix_authentication_service_syn2mas_process_extra_arguments: | matrix_authentication_service_syn2mas_process_extra_arguments: | ||||
| - "--upstreamProviderMapping oidc-keycloak:01HFVBY12TMNTYTBV8W921M5FA" | - "--upstreamProviderMapping oidc-keycloak:01HFVBY12TMNTYTBV8W921M5FA" | ||||
| @@ -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. | 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. | 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. | |||||
| @@ -1,6 +1,6 @@ | |||||
| --- | --- | ||||
| # The bare domain name which represents your Matrix identity. | # 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. | # Note: this playbook does not touch the server referenced here. | ||||
| # Installation happens on another server ("matrix.example.com", see `matrix_server_fqn_matrix`). | # Installation happens on another server ("matrix.example.com", see `matrix_server_fqn_matrix`). | ||||
| @@ -1,7 +1,7 @@ | |||||
| --- | --- | ||||
| # The bare domain name which represents your Matrix identity. | # 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. | # Note: this playbook does not touch the server referenced here. | ||||
| # Installation happens on another server ("matrix.example.com", see `matrix_server_fqn_matrix`). | # Installation happens on another server ("matrix.example.com", see `matrix_server_fqn_matrix`). | ||||
| @@ -163,7 +163,7 @@ matrix_bot_go_neb_storage_database: "{{ | |||||
| # The access tokens that the bot uses to authenticate. | # The access tokens that the bot uses to authenticate. | ||||
| # Generate one as described in | # Generate one as described in | ||||
| # https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/master/docs/configuring-playbook-dimension.md#access-token | # 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: [] | matrix_bot_go_neb_clients: [] | ||||
| # - UserID: "@goneb:{{ matrix_domain }}" | # - UserID: "@goneb:{{ matrix_domain }}" | ||||
| # AccessToken: "MDASDASJDIASDJASDAFGFRGER" | # AccessToken: "MDASDASJDIASDJASDAFGFRGER" | ||||
| @@ -77,7 +77,7 @@ matrix_appservice_irc_ircService_servers: [] # noqa var-naming | |||||
| # # networkId: "example" | # # networkId: "example" | ||||
| # # URL to an icon used as the network icon whenever this network appear in | # # 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 | # # icon: https://example.com/images/hash.png | ||||
| # # The port to connect to. Optional. | # # The port to connect to. Optional. | ||||
| @@ -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 | # 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: "" | 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: | # 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_default` | ||||
| # `matrix_static_files_file_matrix_client_property_io_element_e2ee_secure_backup_required` | # `matrix_static_files_file_matrix_client_property_io_element_e2ee_secure_backup_required` | ||||
| @@ -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_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_homepage_template', 'new': 'matrix_static_files_file_index_html_template'} | ||||
| - {'old': 'matrix_nginx_proxy_base_domain_create_directory', 'new': '<no longer necessary; see matrix_static_files_file_index_html_enabled>'} | - {'old': 'matrix_nginx_proxy_base_domain_create_directory', 'new': '<no longer necessary; see matrix_static_files_file_index_html_enabled>'} | ||||
| - {'old': 'matrix_nginx_proxy_proxy_riot_compat_redirect_enabled', 'new': '<redirecting the riot domain to an element domain is no longer supported - you can implement it yourself using matrix_client_element_container_labels_additional_labels>'} | |||||
| - {'old': 'matrix_nginx_proxy_proxy_riot_compat_redirect_hostname', 'new': '<redirecting the riot domain to an element domain is no longer supported - you can implement it yourself using matrix_client_element_container_labels_additional_labels>'} | |||||
| - {'old': 'matrix_nginx_proxy_proxy_riot_compat_redirect_enabled', 'new': '<redirecting the Riot domain to an Element domain is no longer supported - you can implement it yourself using matrix_client_element_container_labels_additional_labels>'} | |||||
| - {'old': 'matrix_nginx_proxy_proxy_riot_compat_redirect_hostname', 'new': '<redirecting the Riot domain to an Element domain is no longer supported - you can implement it yourself using matrix_client_element_container_labels_additional_labels>'} | |||||
| - {'old': 'matrix_nginx_proxy_proxy_matrix_client_redirect_enabled', 'new': '<superseded by matrix_synapse_container_labels_public_client_root_redirection_enabled or other equivalent variables based on the homeserver implementation you use>'} | - {'old': 'matrix_nginx_proxy_proxy_matrix_client_redirect_enabled', 'new': '<superseded by matrix_synapse_container_labels_public_client_root_redirection_enabled or other equivalent variables based on the homeserver implementation you use>'} | ||||
| - {'old': 'matrix_nginx_proxy_proxy_matrix_client_redirect_root_uri_to_domain', 'new': '<superseded by matrix_synapse_container_labels_public_client_root_redirection_url or other equivalent variables based on the homeserver implementation you use>'} | - {'old': 'matrix_nginx_proxy_proxy_matrix_client_redirect_root_uri_to_domain', 'new': '<superseded by matrix_synapse_container_labels_public_client_root_redirection_url or other equivalent variables based on the homeserver implementation you use>'} | ||||
| - {'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'} | - {'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'} | ||||