| @@ -6,14 +6,29 @@ If you're just installing Matrix services for the first time, please continue wi | |||||
| **Note**: This playbook now supports running [Dimension](https://dimension.t2bot.io) in both a federated and [unfederated](https://github.com/turt2live/matrix-dimension/blob/master/docs/unfederated.md) environments. This is handled automatically based on the value of `matrix_synapse_federation_enabled`. Enabling Dimension, means that the `openid` API endpoints will be exposed on the Matrix Federation port (usually `8448`), even if [federation](configuring-playbook-federation.md) is disabled. It's something to be aware of, especially in terms of firewall whitelisting (make sure port `8448` is accessible). | **Note**: This playbook now supports running [Dimension](https://dimension.t2bot.io) in both a federated and [unfederated](https://github.com/turt2live/matrix-dimension/blob/master/docs/unfederated.md) environments. This is handled automatically based on the value of `matrix_synapse_federation_enabled`. Enabling Dimension, means that the `openid` API endpoints will be exposed on the Matrix Federation port (usually `8448`), even if [federation](configuring-playbook-federation.md) is disabled. It's something to be aware of, especially in terms of firewall whitelisting (make sure port `8448` is accessible). | ||||
| ## Prerequisites | |||||
| ## Decide on a domain and path | |||||
| The `dimension.<your-domain>` DNS record must be created. See [Configuring your DNS server](configuring-dns.md) on how to set up DNS record correctly. | |||||
| By default, Dimension is configured to use its own dedicated domain (`dimension.DOMAIN`) and requires you to [adjust your DNS records](#adjusting-dns-records). | |||||
| You can override the domain and path like this: | |||||
| ```yaml | |||||
| # Switch to another hostname compared to the default (`dimension.{{ matrix_domain }}`) | |||||
| matrix_dimension_hostname: "integrations.{{ matrix_domain }}" | |||||
| ``` | |||||
| While there is a `matrix_dimension_path_prefix` variable for changing the path where Dimension is served, overriding it is not possible right now due to [this Dimension issue](https://github.com/turt2live/matrix-dimension/issues/510). You must serve Dimension at a dedicated subdomain until this issue is solved. | |||||
| ## Adjusting DNS records | |||||
| Once you've decided on the domain and path, **you may need to adjust your DNS** records to point the Dimension domain to the Matrix server. | |||||
| ## Enable | ## Enable | ||||
| [Dimension integrations manager](https://dimension.t2bot.io) installation is disabled by default. You can enable it in your configuration file (`inventory/host_vars/matrix.<your-domain>/vars.yml`): | |||||
| To enable Dimension, add this to your configuration file (`inventory/host_vars/matrix.<your-domain>/vars.yml`): | |||||
| ```yaml | ```yaml | ||||
| matrix_dimension_enabled: true | matrix_dimension_enabled: true | ||||
| @@ -54,7 +69,7 @@ For more information on how to acquire an access token, visit [https://t2bot.io/ | |||||
| ## Installation | ## Installation | ||||
| After these variables have been set, please run the following command to re-run setup and to restart Dimension: | |||||
| After these variables have been set and you have potentially [adjusted your DNS records](#adjusting-dns-records), please run the following command to re-run setup and to restart Dimension: | |||||
| ``` | ``` | ||||
| ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start | ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start | ||||
| @@ -2154,12 +2154,32 @@ matrix_dimension_enabled: false | |||||
| matrix_dimension_container_image_self_build: "{{ matrix_architecture != 'amd64' }}" | matrix_dimension_container_image_self_build: "{{ matrix_architecture != 'amd64' }}" | ||||
| # Normally, matrix-nginx-proxy is enabled and nginx can reach Dimension over the container network. | |||||
| # If matrix-nginx-proxy is not enabled, or you otherwise have a need for it, you can expose | |||||
| # the Dimension HTTP port to the local host. | |||||
| matrix_dimension_scheme: "{{ 'https' if matrix_playbook_ssl_enabled else 'http' }}" | |||||
| matrix_dimension_hostname: "{{ matrix_server_fqn_dimension }}" | |||||
| matrix_dimension_container_network: "{{ matrix_nginx_proxy_container_network if matrix_playbook_reverse_proxy_type == 'playbook-managed-nginx' else 'matrix-dimension' }}" | |||||
| matrix_dimension_container_additional_networks: | | |||||
| {{ | |||||
| ( | |||||
| ([matrix_playbook_reverse_proxyable_services_additional_network] if matrix_playbook_reverse_proxyable_services_additional_network else []) | |||||
| + | |||||
| ([matrix_homeserver_container_network] if matrix_homeserver_container_network != matrix_dimension_container_network else []) | |||||
| + | |||||
| ([devture_postgres_container_network] if devture_postgres_enabled and devture_postgres_container_network != matrix_dimension_container_network else []) | |||||
| ) | unique | |||||
| }} | |||||
| matrix_dimension_container_http_host_bind_port: "{{ (matrix_playbook_service_host_bind_interface_prefix ~ '8184') if matrix_playbook_service_host_bind_interface_prefix else '' }}" | matrix_dimension_container_http_host_bind_port: "{{ (matrix_playbook_service_host_bind_interface_prefix ~ '8184') if matrix_playbook_service_host_bind_interface_prefix else '' }}" | ||||
| matrix_dimension_container_labels_traefik_enabled: "{{ matrix_playbook_traefik_labels_enabled }}" | |||||
| matrix_dimension_container_labels_traefik_docker_network: "{{ matrix_playbook_reverse_proxyable_services_additional_network }}" | |||||
| matrix_dimension_container_labels_traefik_entrypoints: "{{ devture_traefik_entrypoint_primary }}" | |||||
| matrix_dimension_homeserver_clientServerUrl: "{{ matrix_homeserver_container_url }}" | |||||
| matrix_dimension_homeserver_federationUrl: "{{ matrix_homeserver_container_federation_url }}" | matrix_dimension_homeserver_federationUrl: "{{ matrix_homeserver_container_federation_url }}" | ||||
| matrix_dimension_homeserver_mediaUrl: "https://{{ matrix_server_fqn_matrix }}" | |||||
| matrix_dimension_systemd_required_services_list: | | matrix_dimension_systemd_required_services_list: | | ||||
| {{ | {{ | ||||
| @@ -2443,7 +2463,7 @@ matrix_nginx_proxy_proxy_element_enabled: "{{ matrix_client_element_enabled and | |||||
| matrix_nginx_proxy_proxy_hydrogen_enabled: "{{ matrix_client_hydrogen_enabled and matrix_playbook_reverse_proxy_type in ['playbook-managed-nginx', 'other-nginx-non-container'] }}" | matrix_nginx_proxy_proxy_hydrogen_enabled: "{{ matrix_client_hydrogen_enabled and matrix_playbook_reverse_proxy_type in ['playbook-managed-nginx', 'other-nginx-non-container'] }}" | ||||
| matrix_nginx_proxy_proxy_cinny_enabled: "{{ matrix_client_cinny_enabled and matrix_playbook_reverse_proxy_type in ['playbook-managed-nginx', 'other-nginx-non-container'] }}" | matrix_nginx_proxy_proxy_cinny_enabled: "{{ matrix_client_cinny_enabled and matrix_playbook_reverse_proxy_type in ['playbook-managed-nginx', 'other-nginx-non-container'] }}" | ||||
| matrix_nginx_proxy_proxy_buscarron_enabled: "{{ matrix_bot_buscarron_enabled and matrix_playbook_reverse_proxy_type in ['playbook-managed-nginx', 'other-nginx-non-container'] }}" | matrix_nginx_proxy_proxy_buscarron_enabled: "{{ matrix_bot_buscarron_enabled and matrix_playbook_reverse_proxy_type in ['playbook-managed-nginx', 'other-nginx-non-container'] }}" | ||||
| matrix_nginx_proxy_proxy_dimension_enabled: "{{ matrix_dimension_enabled }}" | |||||
| matrix_nginx_proxy_proxy_dimension_enabled: "{{ matrix_dimension_enabled and matrix_playbook_reverse_proxy_type in ['playbook-managed-nginx', 'other-nginx-non-container'] }}" | |||||
| matrix_nginx_proxy_proxy_rageshake_enabled: "{{ matrix_rageshake_enabled and matrix_playbook_reverse_proxy_type in ['playbook-managed-nginx', 'other-nginx-non-container'] }}" | matrix_nginx_proxy_proxy_rageshake_enabled: "{{ matrix_rageshake_enabled and matrix_playbook_reverse_proxy_type in ['playbook-managed-nginx', 'other-nginx-non-container'] }}" | ||||
| matrix_nginx_proxy_proxy_etherpad_enabled: "{{ matrix_etherpad_enabled and matrix_etherpad_mode == 'standalone' }}" | matrix_nginx_proxy_proxy_etherpad_enabled: "{{ matrix_etherpad_enabled and matrix_etherpad_mode == 'standalone' }}" | ||||
| matrix_nginx_proxy_proxy_bot_go_neb_enabled: "{{ matrix_bot_go_neb_enabled }}" | matrix_nginx_proxy_proxy_bot_go_neb_enabled: "{{ matrix_bot_go_neb_enabled }}" | ||||
| @@ -2460,7 +2480,6 @@ matrix_nginx_proxy_container_labels_traefik_docker_network: "{{ matrix_playbook_ | |||||
| matrix_nginx_proxy_container_labels_traefik_entrypoints: "{{ devture_traefik_entrypoint_primary }}" | matrix_nginx_proxy_container_labels_traefik_entrypoints: "{{ devture_traefik_entrypoint_primary }}" | ||||
| matrix_nginx_proxy_container_labels_traefik_proxy_matrix_enabled: true | matrix_nginx_proxy_container_labels_traefik_proxy_matrix_enabled: true | ||||
| matrix_nginx_proxy_container_labels_traefik_proxy_dimension_enabled: "{{ matrix_dimension_enabled }}" | |||||
| matrix_nginx_proxy_container_labels_traefik_proxy_etherpad_enabled: "{{ matrix_etherpad_enabled and matrix_etherpad_mode == 'standalone' }}" | matrix_nginx_proxy_container_labels_traefik_proxy_etherpad_enabled: "{{ matrix_etherpad_enabled and matrix_etherpad_mode == 'standalone' }}" | ||||
| matrix_nginx_proxy_container_labels_traefik_proxy_bot_go_neb_enabled: "{{ matrix_bot_go_neb_enabled }}" | matrix_nginx_proxy_container_labels_traefik_proxy_bot_go_neb_enabled: "{{ matrix_bot_go_neb_enabled }}" | ||||
| matrix_nginx_proxy_container_labels_traefik_proxy_jitsi_enabled: "{{ matrix_jitsi_enabled }}" | matrix_nginx_proxy_container_labels_traefik_proxy_jitsi_enabled: "{{ matrix_jitsi_enabled }}" | ||||
| @@ -3,6 +3,15 @@ | |||||
| matrix_dimension_enabled: false | matrix_dimension_enabled: false | ||||
| matrix_dimension_scheme: https | |||||
| # The hostname at which Dimension is served. | |||||
| matrix_dimension_hostname: '' | |||||
| # The path at which Dimension is exposed. | |||||
| # This value must either be `/` or not end with a slash (e.g. `/dimension`). | |||||
| matrix_dimension_path_prefix: / | |||||
| # You are required to specify an access token for Dimension to work. | # You are required to specify an access token for Dimension to work. | ||||
| # For information on how to acquire an access token, visit https://t2bot.io/docs/access_tokens | # For information on how to acquire an access token, visit https://t2bot.io/docs/access_tokens | ||||
| matrix_dimension_access_token: "" | matrix_dimension_access_token: "" | ||||
| @@ -35,21 +44,129 @@ matrix_dimension_systemd_wanted_services_list: [] | |||||
| matrix_dimension_user_uid: '1000' | matrix_dimension_user_uid: '1000' | ||||
| matrix_dimension_user_gid: '1000' | matrix_dimension_user_gid: '1000' | ||||
| # The base container network. It will be auto-created by this role if it doesn't exist already. | |||||
| matrix_dimension_container_network: matrix-dimension | |||||
| # A list of additional container networks that the container would be connected to. | |||||
| # The role does not create these networks, so make sure they already exist. | |||||
| # Use this to expose this container to another reverse proxy, which runs in a different container network. | |||||
| matrix_dimension_container_additional_networks: [] | |||||
| # Controls whether the matrix-dimension container exposes its HTTP port (tcp/8184 in the container). | # Controls whether the matrix-dimension container exposes its HTTP port (tcp/8184 in the container). | ||||
| # | # | ||||
| # Takes an "<ip>:<port>" or "<port>" value (e.g. "127.0.0.1:8184"), or empty string to not expose. | # Takes an "<ip>:<port>" or "<port>" value (e.g. "127.0.0.1:8184"), or empty string to not expose. | ||||
| matrix_dimension_container_http_host_bind_port: '' | matrix_dimension_container_http_host_bind_port: '' | ||||
| # matrix_dimension_container_labels_traefik_enabled controls whether labels to assist a Traefik reverse-proxy will be attached to the container. | |||||
| # See `../templates/labels.j2` for details. | |||||
| # | |||||
| # To inject your own other container labels, see `matrix_dimension_container_labels_additional_labels`. | |||||
| matrix_dimension_container_labels_traefik_enabled: true | |||||
| matrix_dimension_container_labels_traefik_docker_network: "{{ matrix_dimension_container_network }}" | |||||
| matrix_dimension_container_labels_traefik_hostname: "{{ matrix_dimension_hostname }}" | |||||
| # The path prefix must either be `/` or not end with a slash (e.g. `/dimension`). | |||||
| matrix_dimension_container_labels_traefik_path_prefix: "{{ matrix_dimension_path_prefix }}" | |||||
| matrix_dimension_container_labels_traefik_rule: "Host(`{{ matrix_dimension_container_labels_traefik_hostname }}`){% if matrix_dimension_container_labels_traefik_path_prefix != '/' %} && PathPrefix(`{{ matrix_dimension_container_labels_traefik_path_prefix }}`){% endif %}" | |||||
| matrix_dimension_container_labels_traefik_priority: 0 | |||||
| matrix_dimension_container_labels_traefik_entrypoints: web-secure | |||||
| matrix_dimension_container_labels_traefik_tls: "{{ matrix_dimension_container_labels_traefik_entrypoints != 'web' }}" | |||||
| matrix_dimension_container_labels_traefik_tls_certResolver: default # noqa var-naming | |||||
| # Controls which additional headers to attach to all HTTP responses. | |||||
| # To add your own headers, use `matrix_dimension_container_labels_traefik_additional_response_headers_custom` | |||||
| matrix_dimension_container_labels_traefik_additional_response_headers: "{{ matrix_dimension_container_labels_traefik_additional_response_headers_auto | combine(matrix_dimension_container_labels_traefik_additional_response_headers_custom) }}" | |||||
| matrix_dimension_container_labels_traefik_additional_response_headers_auto: | | |||||
| {{ | |||||
| {} | |||||
| | combine ({'X-XSS-Protection': matrix_dimension_http_header_xss_protection} if matrix_dimension_http_header_xss_protection else {}) | |||||
| | combine ({'X-Frame-Options': matrix_dimension_http_header_frame_options} if matrix_dimension_http_header_frame_options else {}) | |||||
| | combine ({'X-Content-Type-Options': matrix_dimension_http_header_content_type_options} if matrix_dimension_http_header_content_type_options else {}) | |||||
| | combine ({'Content-Security-Policy': matrix_dimension_http_header_content_security_policy} if matrix_dimension_http_header_content_security_policy else {}) | |||||
| | combine ({'Permission-Policy': matrix_dimension_http_header_content_permission_policy} if matrix_dimension_http_header_content_permission_policy else {}) | |||||
| | combine ({'Strict-Transport-Security': matrix_dimension_http_header_strict_transport_security} if matrix_dimension_http_header_strict_transport_security and matrix_dimension_container_labels_traefik_tls else {}) | |||||
| }} | |||||
| matrix_dimension_container_labels_traefik_additional_response_headers_custom: {} | |||||
| # matrix_dimension_container_labels_additional_labels contains a multiline string with additional labels to add to the container label file. | |||||
| # See `../templates/labels.j2` for details. | |||||
| # | |||||
| # Example: | |||||
| # matrix_dimension_container_labels_additional_labels: | | |||||
| # my.label=1 | |||||
| # another.label="here" | |||||
| matrix_dimension_container_labels_additional_labels: '' | |||||
| # A list of extra arguments to pass to the container | # A list of extra arguments to pass to the container | ||||
| matrix_dimension_container_extra_arguments: [] | matrix_dimension_container_extra_arguments: [] | ||||
| matrix_dimension_integrations_ui_url: "https://{{ matrix_server_fqn_dimension }}/element" | |||||
| matrix_dimension_integrations_rest_url: "https://{{ matrix_server_fqn_dimension }}/api/v1/scalar" | |||||
| matrix_dimension_integrations_widgets_urls: ["https://{{ matrix_server_fqn_dimension }}/widgets"] | |||||
| matrix_dimension_integrations_jitsi_widget_url: "https://{{ matrix_server_fqn_dimension }}/widgets/jitsi" | |||||
| # Public facing base URL of the Dimension service. | |||||
| # It should not end with a slash. | |||||
| matrix_dimension_base_url: "{{ matrix_dimension_scheme }}://{{ matrix_dimension_hostname }}{{ '' if matrix_dimension_path_prefix == '/' else matrix_dimension_path_prefix }}" | |||||
| matrix_dimension_integrations_ui_url: "{{ matrix_dimension_base_url }}/element" | |||||
| matrix_dimension_integrations_rest_url: "{{ matrix_dimension_base_url }}/api/v1/scalar" | |||||
| matrix_dimension_integrations_widgets_urls: ["{{ matrix_dimension_base_url }}/widgets"] | |||||
| matrix_dimension_integrations_jitsi_widget_url: "{{ matrix_dimension_base_url }}/widgets/jitsi" | |||||
| matrix_dimension_homeserver_clientServerUrl: '' # noqa var-naming | |||||
| matrix_dimension_homeserver_federationUrl: '' # noqa var-naming | |||||
| matrix_dimension_homeserver_mediaUrl: '' # noqa var-naming | |||||
| matrix_dimension_homeserver_federationUrl: "" # noqa var-naming | |||||
| # Controls the dimension.publicUrl configuration option | |||||
| matrix_dimension_dimension_publicUrl: "{{ matrix_dimension_base_url }}" # noqa var-naming | |||||
| # Specifies the value of the `X-XSS-Protection` header | |||||
| # Stops pages from loading when they detect reflected cross-site scripting (XSS) attacks. | |||||
| # | |||||
| # Learn more about it is here: | |||||
| # - https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection | |||||
| # - https://portswigger.net/web-security/cross-site-scripting/reflected | |||||
| matrix_dimension_http_header_xss_protection: "1; mode=block" | |||||
| # Specifies the value of the `X-Frame-Options` header which controls whether framing can happen. | |||||
| # See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options | |||||
| matrix_dimension_http_header_frame_options: '' | |||||
| # Specifies the value of the `X-Content-Type-Options` header. | |||||
| # See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-Options | |||||
| matrix_dimension_http_header_content_type_options: nosniff | |||||
| # Specifies the value of the `Content-Security-Policy` header. | |||||
| # See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy | |||||
| matrix_dimension_http_header_content_security_policy: '' | |||||
| # Specifies the value of the `Permission-Policy` header. | |||||
| # See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Permission-Policy | |||||
| matrix_dimension_http_header_content_permission_policy: "{{ 'interest-cohort=()' if matrix_dimension_floc_optout_enabled else '' }}" | |||||
| # Specifies the value of the `Strict-Transport-Security` header. | |||||
| # See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security | |||||
| matrix_dimension_http_header_strict_transport_security: "max-age=31536000; includeSubDomains{{ '; preload' if matrix_dimension_hsts_preload_enabled else '' }}" | |||||
| # Controls whether to send a "Permissions-Policy interest-cohort=();" header along with all responses | |||||
| # | |||||
| # Learn more about what it is here: | |||||
| # - https://www.eff.org/deeplinks/2021/03/googles-floc-terrible-idea | |||||
| # - https://paramdeo.com/blog/opting-your-website-out-of-googles-floc-network | |||||
| # - https://amifloced.org/ | |||||
| # | |||||
| # Of course, a better solution is to just stop using browsers (like Chrome), which participate in such tracking practices. | |||||
| # See: `matrix_dimension_content_permission_policy` | |||||
| matrix_dimension_floc_optout_enabled: true | |||||
| # Controls if HSTS preloading is enabled | |||||
| # | |||||
| # In its strongest and recommended form, the [HSTS policy](https://www.chromium.org/hsts) includes all subdomains, and | |||||
| # indicates a willingness to be "preloaded" into browsers: | |||||
| # `Strict-Transport-Security: max-age=31536000; includeSubDomains; preload` | |||||
| # For more information visit: | |||||
| # - https://en.wikipedia.org/wiki/HTTP_Strict_Transport_Security | |||||
| # - https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security | |||||
| # - https://hstspreload.org/#opt-in | |||||
| # See: `matrix_dimension_http_header_strict_transport_security` | |||||
| matrix_dimension_hsts_preload_enabled: false | |||||
| # Database-related configuration fields. | # Database-related configuration fields. | ||||
| # | # | ||||
| @@ -85,6 +85,14 @@ | |||||
| owner: "{{ matrix_user_username }}" | owner: "{{ matrix_user_username }}" | ||||
| group: "{{ matrix_dimension_user_gid }}" | group: "{{ matrix_dimension_user_gid }}" | ||||
| - name: Ensure Dimension labels installed | |||||
| ansible.builtin.template: | |||||
| src: "{{ role_path }}/templates/labels.j2" | |||||
| dest: "{{ matrix_dimension_base_path }}/labels" | |||||
| mode: 0640 | |||||
| owner: "{{ matrix_user_username }}" | |||||
| group: "{{ matrix_user_groupname }}" | |||||
| - name: Ensure Dimension image is pulled | - name: Ensure Dimension image is pulled | ||||
| community.docker.docker_image: | community.docker.docker_image: | ||||
| name: "{{ matrix_dimension_docker_image }}" | name: "{{ matrix_dimension_docker_image }}" | ||||
| @@ -120,6 +128,11 @@ | |||||
| pull: true | pull: true | ||||
| when: "matrix_dimension_container_image_self_build | bool" | when: "matrix_dimension_container_image_self_build | bool" | ||||
| - name: Ensure Dimension container network is created | |||||
| community.general.docker_network: | |||||
| name: "{{ matrix_dimension_container_network }}" | |||||
| driver: bridge | |||||
| - name: Ensure matrix-dimension.service installed | - name: Ensure matrix-dimension.service installed | ||||
| ansible.builtin.template: | ansible.builtin.template: | ||||
| src: "{{ role_path }}/templates/systemd/matrix-dimension.service.j2" | src: "{{ role_path }}/templates/systemd/matrix-dimension.service.j2" | ||||
| @@ -6,7 +6,12 @@ | |||||
| You need to define a required configuration setting (`{{ item.name }}`). | You need to define a required configuration setting (`{{ item.name }}`). | ||||
| when: "item.when | bool and vars[item.name] == ''" | when: "item.when | bool and vars[item.name] == ''" | ||||
| with_items: | with_items: | ||||
| - {'name': 'matrix_dimension_hostname', when: true} | |||||
| - {'name': 'matrix_dimension_container_network', when: true} | |||||
| - {'name': 'matrix_dimension_access_token', when: true} | - {'name': 'matrix_dimension_access_token', when: true} | ||||
| - {'name': 'matrix_dimension_homeserver_clientServerUrl', when: true} | |||||
| - {'name': 'matrix_dimension_homeserver_federationUrl', when: true} | |||||
| - {'name': 'matrix_dimension_homeserver_mediaUrl', when: true} | |||||
| - {'name': 'matrix_dimension_database_hostname', when: "{{ matrix_dimension_database_engine == 'postgres' }}"} | - {'name': 'matrix_dimension_database_hostname', when: "{{ matrix_dimension_database_engine == 'postgres' }}"} | ||||
| - name: (Deprecation) Catch and report renamed Dimension variables | - name: (Deprecation) Catch and report renamed Dimension variables | ||||
| @@ -17,3 +22,31 @@ | |||||
| when: "item.old in vars" | when: "item.old in vars" | ||||
| with_items: | with_items: | ||||
| - {'old': 'matrix_dimension_container_expose_port', 'new': '<superseded by matrix_dimension_container_http_host_bind_port>'} | - {'old': 'matrix_dimension_container_expose_port', 'new': '<superseded by matrix_dimension_container_http_host_bind_port>'} | ||||
| - when: matrix_dimension_container_labels_traefik_enabled | bool | |||||
| block: | |||||
| - name: Fail if required Dimension Traefik settings not defined | |||||
| ansible.builtin.fail: | |||||
| msg: >- | |||||
| You need to define a required configuration setting (`{{ item }}`). | |||||
| when: "vars[item] == ''" | |||||
| with_items: | |||||
| - matrix_dimension_container_labels_traefik_hostname | |||||
| - matrix_dimension_container_labels_traefik_path_prefix | |||||
| # We ensure it doesn't end with a slash, because we handle both (slash and no-slash). | |||||
| # Knowing that `matrix_dimension_container_labels_traefik_path_prefix` does not end with a slash | |||||
| # ensures we know how to set these routes up without having to do "does it end with a slash" checks elsewhere. | |||||
| - name: Fail if matrix_dimension_container_labels_traefik_path_prefix ends with a slash | |||||
| ansible.builtin.fail: | |||||
| msg: >- | |||||
| matrix_dimension_container_labels_traefik_path_prefix (`{{ matrix_dimension_container_labels_traefik_path_prefix }}`) must either be `/` or not end with a slash (e.g. `/dimension`). | |||||
| when: "matrix_dimension_container_labels_traefik_path_prefix != '/' and matrix_dimension_container_labels_traefik_path_prefix[-1] == '/'" | |||||
| - name: Fail if matrix_dimension_container_labels_traefik_path_prefix is not / | |||||
| ansible.builtin.fail: | |||||
| msg: >- | |||||
| matrix_dimension_container_labels_traefik_path_prefix (`{{ matrix_dimension_container_labels_traefik_path_prefix }}`) must currently be set to `/`. | |||||
| Other values are not supported. | |||||
| See: https://github.com/turt2live/matrix-dimension/issues/510 | |||||
| when: "matrix_dimension_container_labels_traefik_path_prefix != '/' and matrix_dimension_container_labels_traefik_path_prefix[-1] == '/'" | |||||
| @@ -9,30 +9,30 @@ web: | |||||
| homeserver: | homeserver: | ||||
| # The domain name of the homeserver. This is used in many places, such as with go-neb | # The domain name of the homeserver. This is used in many places, such as with go-neb | ||||
| # setups, to identify the homeserver. | # setups, to identify the homeserver. | ||||
| name: "{{ matrix_domain }}" | |||||
| name: {{ matrix_domain | to_json }} | |||||
| # The URL that Dimension, go-neb, and other services provisioned by Dimension should | # The URL that Dimension, go-neb, and other services provisioned by Dimension should | ||||
| # use to access the homeserver with. | # use to access the homeserver with. | ||||
| clientServerUrl: "{{ matrix_homeserver_container_url }}" | |||||
| clientServerUrl: {{ matrix_dimension_homeserver_clientServerUrl | to_json }} | |||||
| # The URL that Dimension should use when trying to communicate with federated APIs on | # The URL that Dimension should use when trying to communicate with federated APIs on | ||||
| # the homeserver. If not supplied or left empty Dimension will try to resolve the address | # the homeserver. If not supplied or left empty Dimension will try to resolve the address | ||||
| # through the normal federation process. | # through the normal federation process. | ||||
| federationUrl: "{{ matrix_dimension_homeserver_federationUrl }}" | |||||
| federationUrl: {{ matrix_dimension_homeserver_federationUrl | to_json }} | |||||
| # The URL that Dimension will redirect media requests to for downloading media such as | # The URL that Dimension will redirect media requests to for downloading media such as | ||||
| # stickers. If not supplied or left empty Dimension will use the clientServerUrl. | # stickers. If not supplied or left empty Dimension will use the clientServerUrl. | ||||
| mediaUrl: "https://{{ matrix_server_fqn_matrix }}" | |||||
| mediaUrl: {{ matrix_dimension_homeserver_mediaUrl | to_json }} | |||||
| # The access token Dimension should use for miscellaneous access to the homeserver. This | # The access token Dimension should use for miscellaneous access to the homeserver. This | ||||
| # should be for a user on the configured homeserver: any user will do, however it is | # should be for a user on the configured homeserver: any user will do, however it is | ||||
| # recommended to use a dedicated user (such as @dimension:t2bot.io). For information on | # recommended to use a dedicated user (such as @dimension:t2bot.io). For information on | ||||
| # how to acquire an access token, visit https://t2bot.io/docs/access_tokens | # how to acquire an access token, visit https://t2bot.io/docs/access_tokens | ||||
| accessToken: "{{ matrix_dimension_access_token }}" | |||||
| accessToken: {{ matrix_dimension_access_token | to_json }} | |||||
| # These users can modify the integrations this Dimension supports. | # These users can modify the integrations this Dimension supports. | ||||
| # To access the admin interface, open Dimension in Element and click the settings icon. | # To access the admin interface, open Dimension in Element and click the settings icon. | ||||
| admins: {{ matrix_dimension_admins|to_json }} | |||||
| admins: {{ matrix_dimension_admins | to_json }} | |||||
| # IPs and CIDR ranges listed here will be blocked from being widgets. | # IPs and CIDR ranges listed here will be blocked from being widgets. | ||||
| # Note: Widgets may still be embedded with restricted content, although not through Dimension directly. | # Note: Widgets may still be embedded with restricted content, although not through Dimension directly. | ||||
| @@ -72,4 +72,4 @@ goneb: | |||||
| dimension: | dimension: | ||||
| # This is where Dimension is accessible from clients. Be sure to set this | # This is where Dimension is accessible from clients. Be sure to set this | ||||
| # to your own Dimension instance. | # to your own Dimension instance. | ||||
| publicUrl: "https://{{ matrix_server_fqn_dimension }}" | |||||
| publicUrl: {{ matrix_dimension_dimension_publicUrl | to_json }} | |||||
| @@ -0,0 +1,45 @@ | |||||
| {% if matrix_dimension_container_labels_traefik_enabled %} | |||||
| traefik.enable=true | |||||
| {% if matrix_dimension_container_labels_traefik_docker_network %} | |||||
| traefik.docker.network={{ matrix_dimension_container_labels_traefik_docker_network }} | |||||
| {% endif %} | |||||
| {% set middlewares = [] %} | |||||
| {% if matrix_dimension_container_labels_traefik_path_prefix != '/' %} | |||||
| traefik.http.middlewares.matrix-dimension-slashless-redirect.redirectregex.regex=({{ matrix_dimension_container_labels_traefik_path_prefix | quote }})$ | |||||
| traefik.http.middlewares.matrix-dimension-slashless-redirect.redirectregex.replacement=${1}/ | |||||
| {% set middlewares = middlewares + ['matrix-dimension-slashless-redirect'] %} | |||||
| {% endif %} | |||||
| {% if matrix_dimension_container_labels_traefik_path_prefix != '/' %} | |||||
| traefik.http.middlewares.matrix-dimension-strip-prefix.stripprefix.prefixes={{ matrix_dimension_container_labels_traefik_path_prefix }} | |||||
| {% set middlewares = middlewares + ['matrix-dimension-strip-prefix'] %} | |||||
| {% endif %} | |||||
| {% if matrix_dimension_container_labels_traefik_additional_response_headers.keys() | length > 0 %} | |||||
| {% for name, value in matrix_dimension_container_labels_traefik_additional_response_headers.items() %} | |||||
| traefik.http.middlewares.matrix-dimension-add-headers.headers.customresponseheaders.{{ name }}={{ value }} | |||||
| {% endfor %} | |||||
| {% set middlewares = middlewares + ['matrix-dimension-add-headers'] %} | |||||
| {% endif %} | |||||
| traefik.http.routers.matrix-dimension.rule={{ matrix_dimension_container_labels_traefik_rule }} | |||||
| {% if matrix_dimension_container_labels_traefik_priority | int > 0 %} | |||||
| traefik.http.routers.matrix-dimension.priority={{ matrix_dimension_container_labels_traefik_priority }} | |||||
| {% endif %} | |||||
| traefik.http.routers.matrix-dimension.service=matrix-dimension | |||||
| {% if middlewares | length > 0 %} | |||||
| traefik.http.routers.matrix-dimension.middlewares={{ middlewares | join(',') }} | |||||
| {% endif %} | |||||
| traefik.http.routers.matrix-dimension.entrypoints={{ matrix_dimension_container_labels_traefik_entrypoints }} | |||||
| traefik.http.routers.matrix-dimension.tls={{ matrix_dimension_container_labels_traefik_tls | to_json }} | |||||
| {% if matrix_dimension_container_labels_traefik_tls %} | |||||
| traefik.http.routers.matrix-dimension.tls.certResolver={{ matrix_dimension_container_labels_traefik_tls_certResolver }} | |||||
| {% endif %} | |||||
| traefik.http.services.matrix-dimension.loadbalancer.server.port=8184 | |||||
| {% endif %} | |||||
| {{ matrix_dimension_container_labels_additional_labels }} | |||||
| @@ -21,25 +21,35 @@ ExecStartPre=-{{ devture_systemd_docker_base_host_command_sh }} -c '{{ devture_s | |||||
| ExecStartPre=-{{ matrix_host_command_chown }} {{ matrix_dimension_user_uid }}:{{ matrix_dimension_user_gid }} {{ matrix_dimension_sqlite_database_path_local }} | ExecStartPre=-{{ matrix_host_command_chown }} {{ matrix_dimension_user_uid }}:{{ matrix_dimension_user_gid }} {{ matrix_dimension_sqlite_database_path_local }} | ||||
| {% endif %} | {% endif %} | ||||
| ExecStart={{ devture_systemd_docker_base_host_command_docker }} run --rm --name matrix-dimension \ | |||||
| ExecStartPre={{ devture_systemd_docker_base_host_command_docker }} create \ | |||||
| --rm \ | |||||
| --name=matrix-dimension \ | |||||
| --log-driver=none \ | --log-driver=none \ | ||||
| --user={{ matrix_dimension_user_uid }}:{{ matrix_dimension_user_gid }} \ | --user={{ matrix_dimension_user_uid }}:{{ matrix_dimension_user_gid }} \ | ||||
| --cap-drop=ALL \ | --cap-drop=ALL \ | ||||
| --network={{ matrix_docker_network }} \ | |||||
| --network={{ matrix_dimension_container_network }} \ | |||||
| {% if matrix_dimension_widgets_allow_self_signed_ssl_certificates %} | {% if matrix_dimension_widgets_allow_self_signed_ssl_certificates %} | ||||
| -e NODE_TLS_REJECT_UNAUTHORIZED=0 \ | -e NODE_TLS_REJECT_UNAUTHORIZED=0 \ | ||||
| {% endif %} | {% endif %} | ||||
| {% if matrix_dimension_container_http_host_bind_port %} | {% if matrix_dimension_container_http_host_bind_port %} | ||||
| -p {{ matrix_dimension_container_http_host_bind_port }}:8184 \ | -p {{ matrix_dimension_container_http_host_bind_port }}:8184 \ | ||||
| {% endif %} | {% endif %} | ||||
| --label-file={{ matrix_dimension_base_path }}/labels \ | |||||
| --mount type=bind,src={{ matrix_dimension_base_path }},dst=/data \ | --mount type=bind,src={{ matrix_dimension_base_path }},dst=/data \ | ||||
| {% for arg in matrix_dimension_container_extra_arguments %} | {% for arg in matrix_dimension_container_extra_arguments %} | ||||
| {{ arg }} \ | {{ arg }} \ | ||||
| {% endfor %} | {% endfor %} | ||||
| {{ matrix_dimension_docker_image }} | {{ matrix_dimension_docker_image }} | ||||
| {% for network in matrix_dimension_container_additional_networks %} | |||||
| ExecStartPre={{ devture_systemd_docker_base_host_command_docker }} network connect {{ network }} matrix-dimension | |||||
| {% endfor %} | |||||
| ExecStart={{ devture_systemd_docker_base_host_command_docker }} start --attach matrix-dimension | |||||
| ExecStop=-{{ devture_systemd_docker_base_host_command_sh }} -c '{{ devture_systemd_docker_base_host_command_docker }} kill matrix-dimension 2>/dev/null || true' | ExecStop=-{{ devture_systemd_docker_base_host_command_sh }} -c '{{ devture_systemd_docker_base_host_command_docker }} kill matrix-dimension 2>/dev/null || true' | ||||
| ExecStop=-{{ devture_systemd_docker_base_host_command_sh }} -c '{{ devture_systemd_docker_base_host_command_docker }} rm matrix-dimension 2>/dev/null || true' | ExecStop=-{{ devture_systemd_docker_base_host_command_sh }} -c '{{ devture_systemd_docker_base_host_command_docker }} rm matrix-dimension 2>/dev/null || true' | ||||
| Restart=always | Restart=always | ||||
| RestartSec=30 | RestartSec=30 | ||||
| SyslogIdentifier=matrix-dimension | SyslogIdentifier=matrix-dimension | ||||
| @@ -61,11 +61,6 @@ matrix_nginx_proxy_container_labels_traefik_proxy_matrix_rule: "Host(`{{ matrix_ | |||||
| matrix_nginx_proxy_container_labels_traefik_proxy_matrix_federation_entrypoint: "{{ matrix_federation_traefik_entrypoint }}" | matrix_nginx_proxy_container_labels_traefik_proxy_matrix_federation_entrypoint: "{{ matrix_federation_traefik_entrypoint }}" | ||||
| matrix_nginx_proxy_container_labels_traefik_proxy_matrix_federation_entrypoints: "{{ matrix_nginx_proxy_container_labels_traefik_proxy_matrix_federation_entrypoint }}" | matrix_nginx_proxy_container_labels_traefik_proxy_matrix_federation_entrypoints: "{{ matrix_nginx_proxy_container_labels_traefik_proxy_matrix_federation_entrypoint }}" | ||||
| matrix_nginx_proxy_container_labels_traefik_proxy_dimension_enabled: false | |||||
| matrix_nginx_proxy_container_labels_traefik_proxy_dimension_hostname: "{{ matrix_server_fqn_dimension }}" | |||||
| matrix_nginx_proxy_container_labels_traefik_proxy_dimension_tls: "{{ matrix_nginx_proxy_container_labels_traefik_entrypoints != 'web' }}" | |||||
| matrix_nginx_proxy_container_labels_traefik_proxy_dimension_rule: "Host(`{{ matrix_nginx_proxy_container_labels_traefik_proxy_dimension_hostname }}`)" | |||||
| matrix_nginx_proxy_container_labels_traefik_proxy_etherpad_enabled: false | matrix_nginx_proxy_container_labels_traefik_proxy_etherpad_enabled: false | ||||
| matrix_nginx_proxy_container_labels_traefik_proxy_etherpad_hostname: "{{ matrix_server_fqn_etherpad }}" | matrix_nginx_proxy_container_labels_traefik_proxy_etherpad_hostname: "{{ matrix_server_fqn_etherpad }}" | ||||
| matrix_nginx_proxy_container_labels_traefik_proxy_etherpad_tls: "{{ matrix_nginx_proxy_container_labels_traefik_entrypoints != 'web' }}" | matrix_nginx_proxy_container_labels_traefik_proxy_etherpad_tls: "{{ matrix_nginx_proxy_container_labels_traefik_entrypoints != 'web' }}" | ||||
| @@ -39,18 +39,6 @@ traefik.http.routers.matrix-nginx-proxy-matrix-federation.entrypoints={{ matrix_ | |||||
| {% endif %} | {% endif %} | ||||
| {% if matrix_nginx_proxy_container_labels_traefik_proxy_dimension_enabled %} | |||||
| # Dimension | |||||
| traefik.http.routers.matrix-nginx-proxy-dimension.rule={{ matrix_nginx_proxy_container_labels_traefik_proxy_dimension_rule }} | |||||
| traefik.http.routers.matrix-nginx-proxy-dimension.service=matrix-nginx-proxy-web | |||||
| traefik.http.routers.matrix-nginx-proxy-dimension.tls={{ matrix_nginx_proxy_container_labels_traefik_proxy_dimension_tls | to_json }} | |||||
| {% if matrix_nginx_proxy_container_labels_traefik_proxy_dimension_tls %} | |||||
| traefik.http.routers.matrix-nginx-proxy-dimension.tls.certResolver={{ matrix_nginx_proxy_container_labels_traefik_tls_certResolver }} | |||||
| {% endif %} | |||||
| traefik.http.routers.matrix-nginx-proxy-dimension.entrypoints={{ matrix_nginx_proxy_container_labels_traefik_entrypoints }} | |||||
| {% endif %} | |||||
| {% if matrix_nginx_proxy_container_labels_traefik_proxy_etherpad_enabled %} | {% if matrix_nginx_proxy_container_labels_traefik_proxy_etherpad_enabled %} | ||||
| # Etherpad | # Etherpad | ||||
| traefik.http.routers.matrix-nginx-proxy-etherpad.rule={{ matrix_nginx_proxy_container_labels_traefik_proxy_etherpad_rule }} | traefik.http.routers.matrix-nginx-proxy-etherpad.rule={{ matrix_nginx_proxy_container_labels_traefik_proxy_etherpad_rule }} | ||||