2022-02-05 20:32:54 +00:00
---
2022-11-23 14:56:39 +00:00
2019-02-28 09:51:09 +00:00
# The bare domain name which represents your Matrix identity.
2024-11-08 03:54:48 +00:00
# Matrix user IDs for your server will be of the form (`@user:example.com`).
2019-02-28 09:51:09 +00:00
#
2019-01-12 15:53:00 +00:00
# Note: this playbook does not touch the server referenced here.
2024-10-17 16:04:56 +00:00
# Installation happens on another server ("matrix.example.com", see `matrix_server_fqn_matrix`).
2019-02-28 09:51:09 +00:00
#
# Example value: example.com
matrix_domain : ~
2019-01-12 15:53:00 +00:00
2024-10-18 14:28:00 +00:00
# The optional Matrix admin MXID, used in bridges' configs to set bridge admin user
2022-06-27 11:38:21 +00:00
# Example value: "@someone:{{ matrix_domain }}"
2022-06-27 07:34:04 +00:00
matrix_admin : ''
2023-04-05 11:59:48 +00:00
# Global var to enable/disable encryption across all bridges with encryption support
matrix_bridges_encryption_enabled : false
2024-03-24 02:58:03 +00:00
# Global var to make encryption default/optional across all bridges with encryption support
matrix_bridges_encryption_default : "{{ matrix_bridges_encryption_enabled }}"
2023-07-21 10:22:05 +00:00
# Global var to enable/disable relay mode across all bridges with relay mode support
matrix_bridges_relay_enabled : false
2024-01-05 04:13:12 +00:00
# A container network where all addon services (bridges, bots, etc.) would live.
matrix_addons_container_network : matrix-addons
2024-01-02 13:56:56 +00:00
2024-01-05 04:13:12 +00:00
# The container network that the homeserver lives on and addon services (bridges, bots, etc.) should be connected to
matrix_addons_homeserver_container_network : "{{ matrix_homeserver_container_network }}"
2024-01-02 13:56:56 +00:00
2024-01-05 04:13:12 +00:00
# The URL where addon services (bridges, bots, etc.) can reach the homeserver.
2024-01-13 16:07:00 +00:00
# By default, this is configured to go directly to the homeserver, but the playbook may
# override it to go through an intermediary service.
2024-01-05 04:13:12 +00:00
matrix_addons_homeserver_client_api_url : "{{ matrix_homeserver_container_url }}"
2024-01-02 13:56:56 +00:00
2024-01-05 04:13:12 +00:00
# The systemd services (representing the homeserver) that addon services (bridges, bots, etc.) should depend on
matrix_addons_homeserver_systemd_services_list : "{{ matrix_homeserver_systemd_services_list }}"
2024-01-02 13:56:56 +00:00
2024-01-13 15:43:23 +00:00
# A container network where all monitoring services would live.
matrix_monitoring_container_network : matrix-monitoring
2022-11-23 14:56:39 +00:00
# matrix_homeserver_enabled controls whether to enable the homeserver systemd service, etc.
#
# Unless you're wrapping this playbook in another one
# where you optionally wish to disable homeserver integration, you don't need to use this.
#
# Note: disabling this does not mean that a homeserver won't get installed.
# Whether homeserver software is installed depends on other (`matrix_HOMESERVER_enabled`) variables - see `group_vars/matrix_servers`.
matrix_homeserver_enabled : true
2021-12-17 17:00:17 +00:00
# This will contain the homeserver implementation that is in use.
2022-08-04 19:35:41 +00:00
# Valid values: synapse, dendrite, conduit
2021-12-23 14:28:34 +00:00
#
# By default, we use Synapse, because it's the only full-featured Matrix server at the moment.
#
# This value automatically influences other variables (`matrix_synapse_enabled`, `matrix_dendrite_enabled`, etc.).
# The homeserver implementation of an existing server cannot be changed without data loss.
matrix_homeserver_implementation : synapse
2021-12-17 17:00:17 +00:00
2022-01-07 14:00:42 +00:00
# This contains a secret, which is used for generating various other secrets later on.
matrix_homeserver_generic_secret_key : ''
2019-02-28 09:51:09 +00:00
# This is where your data lives and what we set up.
2020-07-17 08:31:20 +00:00
# This and the Element FQN (see below) are expected to be on the same server.
2019-02-28 09:51:09 +00:00
matrix_server_fqn_matrix : "matrix.{{ matrix_domain }}"
2019-01-12 15:53:00 +00:00
2021-06-28 12:30:48 +00:00
# This is where you access federation API.
matrix_server_fqn_matrix_federation : '{{ matrix_server_fqn_matrix }}'
Add "Web" to Element and SchildiChat web application (#3755)
* Replace "Element" with "Element Web"
- If Element indicates the web application, then it is changed to Element Web.
- If it indicates clients branded with Element such as Element desktop, web, mobile clients, then it is changed to Element clients.
- If it is combined with location sharing functionality, it is not changed.
with other some changes, including:
- Change "app.element.io" anchor link to "https://github.com/element-hq/element-web" on README.md, following other documentation files
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Replace "SchildiChat" with "SchildiChat Web"
- If SchildiChat indicates the web application, then it is changed to SchildiChat Web.
- If it indicates clients branded with SchildiChat such as SchildiChat desktop, web, mobile clients, then it is changed to SchildiChat clients.
- If it is combined with location sharing functionality, it is not changed.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Rename configuring-playbook-client-schildichat.md to configuring-playbook-client-schildichat-web.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Rename configuring-playbook-client-element.md to configuring-playbook-client-element-web.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
---------
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
Co-authored-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-07 14:31:26 +00:00
# This is where you access the Element Web from (if enabled via matrix_client_element_enabled; enabled by default).
2019-02-28 09:51:09 +00:00
# This and the Matrix FQN (see above) are expected to be on the same server.
2020-07-17 08:31:20 +00:00
matrix_server_fqn_element : "element.{{ matrix_domain }}"
2019-01-12 15:53:00 +00:00
2021-05-15 09:23:36 +00:00
# This is where you access the Hydrogen web client from (if enabled via matrix_client_hydrogen_enabled; disabled by default).
matrix_server_fqn_hydrogen : "hydrogen.{{ matrix_domain }}"
2022-01-05 16:33:21 +00:00
# This is where you access the Cinny web client from (if enabled via matrix_client_cinny_enabled; disabled by default).
matrix_server_fqn_cinny : "cinny.{{ matrix_domain }}"
Add "Web" to Element and SchildiChat web application (#3755)
* Replace "Element" with "Element Web"
- If Element indicates the web application, then it is changed to Element Web.
- If it indicates clients branded with Element such as Element desktop, web, mobile clients, then it is changed to Element clients.
- If it is combined with location sharing functionality, it is not changed.
with other some changes, including:
- Change "app.element.io" anchor link to "https://github.com/element-hq/element-web" on README.md, following other documentation files
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Replace "SchildiChat" with "SchildiChat Web"
- If SchildiChat indicates the web application, then it is changed to SchildiChat Web.
- If it indicates clients branded with SchildiChat such as SchildiChat desktop, web, mobile clients, then it is changed to SchildiChat clients.
- If it is combined with location sharing functionality, it is not changed.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Rename configuring-playbook-client-schildichat.md to configuring-playbook-client-schildichat-web.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Rename configuring-playbook-client-element.md to configuring-playbook-client-element-web.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
---------
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
Co-authored-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-07 14:31:26 +00:00
# This is where you access the SchildiChat Web from (if enabled via matrix_client_schildichat_enabled; disabled by default).
2023-08-30 16:23:52 +00:00
matrix_server_fqn_schildichat : "schildichat.{{ matrix_domain }}"
2024-10-26 16:28:37 +00:00
# This is where you access the Buscarron bot from (if enabled via matrix_bot_buscarron_enabled; disabled by default).
2022-04-23 13:19:24 +00:00
matrix_server_fqn_buscarron : "buscarron.{{ matrix_domain }}"
2019-03-07 05:22:08 +00:00
# This is where you access the Dimension.
matrix_server_fqn_dimension : "dimension.{{ matrix_domain }}"
2024-10-14 16:05:33 +00:00
# This is where you access the Etherpad (if enabled via etherpad_enabled; disabled by default).
2022-11-04 09:36:10 +00:00
matrix_server_fqn_etherpad : "etherpad.{{ matrix_domain }}"
2021-03-11 18:23:01 +00:00
# For use with Go-NEB! (github callback url for example)
matrix_server_fqn_bot_go_neb : "goneb.{{ matrix_domain }}"
2020-03-23 15:19:15 +00:00
# This is where you access Jitsi.
matrix_server_fqn_jitsi : "jitsi.{{ matrix_domain }}"
2021-01-29 09:30:04 +00:00
# This is where you access Grafana.
matrix_server_fqn_grafana : "stats.{{ matrix_domain }}"
2021-03-20 11:31:34 +00:00
# This is where you access the Sygnal push gateway.
matrix_server_fqn_sygnal : "sygnal.{{ matrix_domain }}"
2023-08-23 12:05:32 +00:00
# This is where you access the mautrix wsproxy push gateway.
matrix_server_fqn_mautrix_wsproxy : "wsproxy.{{ matrix_domain }}"
2022-06-21 13:31:21 +00:00
# This is where you access the ntfy push notification service.
matrix_server_fqn_ntfy : "ntfy.{{ matrix_domain }}"
2023-02-20 21:34:16 +00:00
# This is where you access rageshake.
matrix_server_fqn_rageshake : "rageshake.{{ matrix_domain }}"
2020-06-09 05:29:03 +00:00
matrix_federation_public_port : 8448
2023-02-06 11:08:11 +00:00
# The name of the Traefik entrypoint for handling Matrix Federation
2024-01-14 07:23:36 +00:00
# Also see the `matrix_playbook_public_matrix_federation_api_traefik_entrypoint_*` variables.
2024-01-15 07:39:36 +00:00
matrix_federation_traefik_entrypoint_name : matrix-federation
# Controls whether the federation entrypoint supports TLS.
# TLS is force-enabled here, because the spec (https://spec.matrix.org/v1.9/server-server-api/#tls) says that the federation API must use HTTPS.
# This may be changed at the playbook level for setups explicitly disabling TLS.
# `matrix_playbook_ssl_enabled` has no influence over this.
matrix_federation_traefik_entrypoint_tls : true
2023-02-06 11:08:11 +00:00
2020-12-17 09:33:18 +00:00
# The architecture that your server runs.
# Recognized values by us are 'amd64', 'arm32' and 'arm64'.
# Not all architectures support all services, so your experience (on non-amd64) may vary.
# See docs/alternative-architectures.md
2022-11-22 07:09:11 +00:00
matrix_architecture : "{{ 'amd64' if ansible_architecture == 'x86_64' else ('arm64' if ansible_architecture == 'aarch64' else ('arm32' if ansible_architecture.startswith('armv') else '')) }}"
2020-12-17 09:33:18 +00:00
2020-12-17 09:37:30 +00:00
# The architecture for Debian packages.
# See: https://wiki.debian.org/SupportedArchitectures
# We just remap from our `matrix_architecture` values to what Debian and possibly other distros call things.
matrix_debian_arch : "{{ 'armhf' if matrix_architecture == 'arm32' else matrix_architecture }}"
2022-03-10 09:28:25 +00:00
matrix_container_global_registry_prefix : "docker.io/"
2019-01-12 15:53:00 +00:00
matrix_user_username : "matrix"
2020-05-01 17:59:32 +00:00
matrix_user_groupname : "matrix"
2019-01-12 15:53:00 +00:00
2020-07-06 08:05:34 +00:00
# By default, the playbook creates the user (`matrix_user_username`)
2024-10-15 17:24:34 +00:00
# and group (`matrix_user_groupname`) with a random ID.
# To use a specific user/group ID, override these variables.
2020-07-06 08:05:34 +00:00
matrix_user_uid : ~
matrix_user_gid : ~
2019-01-12 15:53:00 +00:00
matrix_base_data_path : "/matrix"
2019-01-14 13:28:37 +00:00
matrix_base_data_path_mode : "750"
2019-01-12 15:53:00 +00:00
2022-11-27 07:47:02 +00:00
matrix_bin_path : "{{ matrix_base_data_path }}/bin"
2020-05-27 16:53:52 +00:00
matrix_host_command_sleep : "/usr/bin/env sleep"
matrix_host_command_chown : "/usr/bin/env chown"
matrix_host_command_fusermount : "/usr/bin/env fusermount"
2020-05-27 20:18:24 +00:00
matrix_host_command_openssl : "/usr/bin/env openssl"
2020-04-05 06:42:52 +00:00
2024-05-25 13:14:26 +00:00
matrix_homeserver_url : "{{ ('https' if matrix_playbook_ssl_enabled else 'http') }}://{{ matrix_server_fqn_matrix }}"
2019-01-16 16:05:48 +00:00
2024-01-02 13:56:56 +00:00
# Specifies on which container network the homeserver is.
2024-01-05 14:46:30 +00:00
matrix_homeserver_container_network : "matrix-homeserver"
2024-01-02 13:56:56 +00:00
2024-01-14 09:51:30 +00:00
# Specifies whether the homeserver will federate at all.
# Disable this to completely isolate your server from the rest of the Matrix network.
matrix_homeserver_federation_enabled : true
2024-01-02 13:56:56 +00:00
# Specifies which systemd services are responsible for the homeserver
matrix_homeserver_systemd_services_list : [ ]
# Specifies where the homeserver's Client-Server API is on the container network (matrix_homeserver_container_network).
2024-01-13 16:07:00 +00:00
# Most services that need to reach the homeserver do not use `matrix_homeserver_container_url`, but
# rather `matrix_addons_homeserver_client_api_url`.
2024-01-02 13:56:56 +00:00
matrix_homeserver_container_url : "http://{{ matrix_homeserver_container_client_api_endpoint }}"
# Specifies where the homeserver's Client-Server API is on the container network (matrix_homeserver_container_network).
2021-12-23 16:13:44 +00:00
# Where this is depends on whether there's a reverse-proxy in front of the homeserver, which homeserver it is, etc.
2021-01-25 11:55:08 +00:00
# This likely gets overriden elsewhere.
2024-01-02 13:56:56 +00:00
matrix_homeserver_container_client_api_endpoint : ""
# Specifies where the homeserver's Federation API is on the container network (matrix_homeserver_container_network).
matrix_homeserver_container_federation_url : "http://{{ matrix_homeserver_container_federation_api_endpoint }}"
2021-01-25 11:55:08 +00:00
2024-01-02 13:56:56 +00:00
# Specifies where the homeserver's Federation API is on the container network (matrix_homeserver_container_network).
2021-12-23 16:13:44 +00:00
# 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.
2024-01-02 13:56:56 +00:00
matrix_homeserver_container_federation_api_endpoint : ""
2021-12-23 16:13:44 +00:00
2023-08-11 08:13:49 +00:00
# Specifies the public url of the Sync v3 (sliding-sync) API.
# This will be used to set the `org.matrix.msc3575.proxy` property in `/.well-known/matrix/client`.
# Once the API is stabilized, this will no longer be required.
# See MSC3575: https://github.com/matrix-org/matrix-spec-proposals/blob/kegan/sync-v3/proposals/3575-sync.md
matrix_homeserver_sliding_sync_url : ""
2019-01-16 16:05:48 +00:00
matrix_identity_server_url : ~
2019-01-12 15:53:00 +00:00
2019-12-10 04:23:56 +00:00
matrix_integration_manager_rest_url : ~
matrix_integration_manager_ui_url : ~
2022-11-22 19:36:49 +00:00
matrix_homeserver_container_extra_arguments_auto : [ ]
matrix_homeserver_app_service_config_files_auto : [ ]
2024-01-02 13:56:56 +00:00
# Controls whether various services should expose metrics publicly.
# If Prometheus is operating on the same machine, exposing metrics publicly is not necessary.
matrix_metrics_exposure_enabled : false
matrix_metrics_exposure_hostname : "{{ matrix_server_fqn_matrix }}"
matrix_metrics_exposure_path_prefix : /metrics
matrix_metrics_exposure_http_basic_auth_enabled : false
# See https://doc.traefik.io/traefik/middlewares/http/basicauth/#users
matrix_metrics_exposure_http_basic_auth_users : ''
2023-02-10 13:50:35 +00:00
# Specifies the type of reverse-proxy used by the playbook.
#
# Changing this has an effect on whether a reverse-proxy is installed at all and what its type is,
# as well as how all other services are configured.
#
# Valid options and a description of their behavior:
#
2023-02-11 06:44:11 +00:00
# - `playbook-managed-traefik`
2023-03-06 07:51:14 +00:00
# - the playbook will run a managed Traefik instance (matrix-traefik)
2024-09-27 07:14:29 +00:00
# - Traefik will do SSL termination, unless you disable it (e.g. `traefik_config_entrypoint_web_secure_enabled: false`)
# - if SSL termination is enabled (as it is by default), you need to populate: `traefik_config_certificatesResolvers_acme_email`
2023-02-10 13:50:35 +00:00
#
# - `other-traefik-container`
2023-02-10 17:36:06 +00:00
# - this playbook will not install Traefik
# - nevertheless, the playbook expects that you would install Traefik yourself via other means
# - you should make sure your Traefik configuration is compatible with what the playbook would have configured (web, web-secure, matrix-federation entrypoints, etc.)
# - you need to set `matrix_playbook_reverse_proxyable_services_additional_network` to the name of your Traefik network
2024-09-27 07:14:29 +00:00
# - Traefik certs dumper will be enabled by default (`traefik_certs_dumper_enabled`). You need to point it to your Traefik's SSL certificates (`traefik_certs_dumper_ssl_dir_path`)
2023-02-10 13:50:35 +00:00
#
# - `none`
# - no reverse-proxy will be installed
# - no port exposure will be done for any of the container services
# - it's up to you to expose the ports you want, etc.
2024-01-14 16:42:14 +00:00
# - this is unlikely to work well (if at all)
2023-02-26 14:14:05 +00:00
matrix_playbook_reverse_proxy_type : ''
2023-02-10 13:50:35 +00:00
2024-01-14 08:23:55 +00:00
# Specifies the network that the reverse-proxy is operating at
matrix_playbook_reverse_proxy_container_network : 'traefik'
# Specifies the hostname that the reverse-proxy is available at
matrix_playbook_reverse_proxy_hostname : 'matrix-traefik'
# Controls the additional network that reverse-proxyable services will be connected to.
matrix_playbook_reverse_proxyable_services_additional_network : "{{ matrix_playbook_reverse_proxy_container_network }}"
2024-01-14 16:42:14 +00:00
# Controls if various services think if SSL is enabled or not.
# Disabling this does not actually disable Treafik's web-secure entrypoint and TLS termination settings.
2024-09-27 07:14:29 +00:00
# For that, you'd need to use another variable (`traefik_config_entrypoint_web_secure_enabled`).
2024-01-15 07:39:36 +00:00
# This variable merely serves as an indicator if SSL is used or not.
2024-01-14 16:42:14 +00:00
matrix_playbook_ssl_enabled : true
2024-01-15 14:14:12 +00:00
# Controls on which network interface services are exposed.
# You can use this to tell all services to expose themselves on the loopback interface, on a local network IP or or publicly.
# Possibly not all services support exposure via this variable.
# We recommend not using it.
#
# Example value: `127.0.0.1:` (note the trailing `:`).
matrix_playbook_service_host_bind_interface_prefix : ""
2023-02-10 13:50:35 +00:00
2024-01-14 07:23:36 +00:00
# Controls whether to enable an additional Traefik entrypoint for the purpose of serving Matrix Federation.
# By default, federation is served on a special port (8448), so a separate entrypoint is necessary.
# Group variables may influence whether this is enabled based on the port number and on the default entrypoints of the Traefik reverse-proxy.
matrix_playbook_public_matrix_federation_api_traefik_entrypoint_enabled : true
2024-01-15 07:39:36 +00:00
matrix_playbook_public_matrix_federation_api_traefik_entrypoint_name : "{{ matrix_federation_traefik_entrypoint_name }}"
2024-01-14 07:23:36 +00:00
matrix_playbook_public_matrix_federation_api_traefik_entrypoint_port : "{{ matrix_federation_public_port }}"
matrix_playbook_public_matrix_federation_api_traefik_entrypoint_host_bind_port : "{{ matrix_federation_public_port }}"
2024-07-06 08:00:59 +00:00
matrix_playbook_public_matrix_federation_api_traefik_entrypoint_host_bind_port_udp : "{{ matrix_playbook_public_matrix_federation_api_traefik_entrypoint_config_http3_advertisedPort if matrix_playbook_public_matrix_federation_api_traefik_entrypoint_config_http3_enabled else '' }}"
matrix_playbook_public_matrix_federation_api_traefik_entrypoint_config : "{{ (matrix_playbook_public_matrix_federation_api_traefik_entrypoint_config_default | combine (matrix_playbook_public_matrix_federation_api_traefik_entrypoint_config_auto)) | combine(matrix_playbook_public_matrix_federation_api_traefik_entrypoint_config_custom, recursive=True) }}"
matrix_playbook_public_matrix_federation_api_traefik_entrypoint_config_http3_enabled : true
2024-07-06 08:15:34 +00:00
matrix_playbook_public_matrix_federation_api_traefik_entrypoint_config_http3_advertisedPort : "{{ matrix_playbook_public_matrix_federation_api_traefik_entrypoint_port }}" # noqa var-naming
2024-07-06 08:00:59 +00:00
matrix_playbook_public_matrix_federation_api_traefik_entrypoint_config_default : |
{{
({'http3': {'advertisedPort': matrix_playbook_public_matrix_federation_api_traefik_entrypoint_config_http3_advertisedPort | int}})
if matrix_playbook_public_matrix_federation_api_traefik_entrypoint_config_http3_enabled
else {}
}}
2024-01-14 07:23:36 +00:00
matrix_playbook_public_matrix_federation_api_traefik_entrypoint_config_auto : {}
matrix_playbook_public_matrix_federation_api_traefik_entrypoint_config_custom : {}
matrix_playbook_public_matrix_federation_api_traefik_entrypoint_definition :
name : "{{ matrix_playbook_public_matrix_federation_api_traefik_entrypoint_name }}"
port : "{{ matrix_playbook_public_matrix_federation_api_traefik_entrypoint_port }}"
host_bind_port : "{{ matrix_playbook_public_matrix_federation_api_traefik_entrypoint_host_bind_port }}"
2024-07-06 08:00:59 +00:00
host_bind_port_udp : "{{ matrix_playbook_public_matrix_federation_api_traefik_entrypoint_host_bind_port_udp }}"
2024-01-14 07:23:36 +00:00
config : "{{ matrix_playbook_public_matrix_federation_api_traefik_entrypoint_config }}"
2024-01-14 08:23:55 +00:00
# Controls whether to enable an additional Traefik entrypoint for the purpose of serving the homeserver's Client-Server API internally.
#
# Homeserver software and other core components which are part of the homeserver's Client-Server API
# may wish to register their routes with this additional entrypoint and provide their services on it for internal (no-public-network and non-TLS) use.
#
# This entrypoint provides local addons (e.g. bridges, bots, etc.) with the ability to easily & quickly communicate with the homeserver and/or related software.
2024-10-17 13:17:56 +00:00
# Such services can reach the homeserver over the public internet (e.g. https://matrix.example.com), but this is slow due to networking and SSL-termination.
2024-01-14 08:23:55 +00:00
# Talking directly to the homeserver (e.g. `http://matrix-synapse:8008`) is another option, but does not allow other homeserver-related software
# (e.g. identity servers like ma1sd, media repository servers like matrix-media-repo, firewalls like matrix-corporal)
# to register itself for certain homeserver routes.
#
# For example: when matrix-media-repo is enabled, it wishes to handle `/_matrix/media` both publicly and internally.
# Bots/bridges that try to upload media should not hit `/_matrix/media` on the homeserver directly, but actually go through matrix-media-repo.
#
# This entrypoint gives us a layer of indirection, so that all these homeserver-related services can register themselves on this entrypoint
# the same way they register themselves for the public (e.g. `web-secure`) entrypoint.
#
# Routers enabled on this entrypoint should use Traefik rules which do NOT do Host-matching (Host/HostRegexp),
# because addon services (e.g. bridges, bots) cannot properly pass a `Host` HTTP header when making
2024-09-27 07:15:49 +00:00
# requests to the endpoint's address (e.g. `http://matrix-traefik:8008/`).
2024-01-14 08:23:55 +00:00
# This entrypoint only aims to handle a single "virtual host" - one dealing with the homeserver's Client-Server API.
2024-01-18 10:12:41 +00:00
matrix_playbook_internal_matrix_client_api_traefik_entrypoint_enabled : "{{ matrix_playbook_reverse_proxy_type in ['playbook-managed-traefik', 'other-traefik-container'] }}"
2024-01-14 08:23:55 +00:00
matrix_playbook_internal_matrix_client_api_traefik_entrypoint_name : matrix-internal-matrix-client-api
matrix_playbook_internal_matrix_client_api_traefik_entrypoint_port : 8008
matrix_playbook_internal_matrix_client_api_traefik_entrypoint_host_bind_port : ''
matrix_playbook_internal_matrix_client_api_traefik_entrypoint_config : "{{ matrix_playbook_internal_matrix_client_api_traefik_entrypoint_config_auto | combine(matrix_playbook_internal_matrix_client_api_traefik_entrypoint_config_custom, recursive=True) }}"
matrix_playbook_internal_matrix_client_api_traefik_entrypoint_config_auto : {}
matrix_playbook_internal_matrix_client_api_traefik_entrypoint_config_custom : {}
matrix_playbook_internal_matrix_client_api_traefik_entrypoint_definition :
name : "{{ matrix_playbook_internal_matrix_client_api_traefik_entrypoint_name }}"
port : "{{ matrix_playbook_internal_matrix_client_api_traefik_entrypoint_port }}"
host_bind_port : "{{ matrix_playbook_internal_matrix_client_api_traefik_entrypoint_host_bind_port }}"
config : "{{ matrix_playbook_internal_matrix_client_api_traefik_entrypoint_config }}"
2019-01-12 15:53:00 +00:00
# Variables to Control which parts of our roles run.
2019-07-08 05:55:08 +00:00
run_postgres_import : true
run_postgres_upgrade : true
run_postgres_import_sqlite_db : true
2019-07-08 06:38:24 +00:00
run_postgres_vacuum : true
2019-07-08 05:55:08 +00:00
run_synapse_register_user : true
run_synapse_update_user_password : true
run_synapse_import_media_store : true
2020-08-21 10:52:16 +00:00
run_synapse_rust_synapse_compress_state : true
2021-12-18 12:40:34 +00:00
run_dendrite_register_user : true
2019-01-12 15:53:00 +00:00
run_setup : true
2019-07-08 05:55:08 +00:00
run_self_check : true
2019-01-12 15:53:00 +00:00
run_start : true
2022-10-31 22:44:47 +00:00
run_stop : true