self-hosted/matrix-docker-ansible-deploy
1
0
Fork 0
mirror of https://github.com/spantaleev/matrix-docker-ansible-deploy.git synced 2025-08-04 21:43:06 +02:00
Code Issues Releases Activity
Files
renovate/ghcr.io-element-hq-element-call-0.x
matrix-docker-ansible-deploy/roles/custom/matrix-synapse-reverse-proxy-companion/templates/labels.j2

225 lines
14 KiB
Plaintext
Raw Permalink Normal View History

Add license information to files for matrix-synapse-reverse-proxy-companion Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-03-03 00:18:04 +09:00
{#
SPDX-FileCopyrightText: 2024 Slavi Pantaleev
Internal Admin API and Draupnir Hjack Command Config (#3389) * Enable Internal Admin API Access separately from Public access. * Add Config variable for Draupnir Hijack command And also make the internal admin API be automatically activated when this capability is used. * Apply suggestions from code review Co-authored-by: Slavi Pantaleev <slavi@devture.com> * Further Refine Internal Admin API * Add Non Worker Labels for Internal Admin API * Variable Rename * Add validation rules for Internal Synapse admin API * Add Draupnir Admin API required config validation. * Override `matrix_synapse_reverse_proxy_companion_container_labels_internal_client_synapse_admin_api_traefik_entrypoints` via group vars * Wire `matrix_bot_draupnir_admin_api_enabled` to `matrix_bot_draupnir_config_admin_enableMakeRoomAdminCommand` in Draupnir's `defaults/main.yml` * Remove unnecessary `matrix_bot_draupnir_admin_api_enabled` override from `group_vars/matrix_servers` The same value is now (more appropriately) defined in Draupnir's `defaults/main.yml` file anyway. * Add additional condition (`matrix_bot_draupnir_enabled`) for enabling `matrix_synapse_container_labels_internal_client_synapse_admin_api_enabled` * Use a separate task for validating `matrix_bot_draupnir_admin_api_enabled` when `matrix_bot_draupnir_config_admin_enableMakeRoomAdminCommand` The other task deals with checking for null and not-blank and can't handle booleans properly. --------- Co-authored-by: Slavi Pantaleev <slavi@devture.com>
2025-03-15 08:14:55 +01:00
SPDX-FileCopyrightText: 2024 - 2025 Catalan Lover <catalanlover@protonmail.com>
Add license information to files for matrix-synapse-reverse-proxy-companion Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-03-03 00:18:04 +09:00
SPDX-License-Identifier: AGPL-3.0-or-later
#}
Handle /_matrix Client-Server and Federation APIs directly at matrix-synapse-reverse-proxy-companion
2024-01-03 17:05:59 +02:00
{% if matrix_synapse_reverse_proxy_companion_container_labels_traefik_enabled %}
traefik.enable=true
{% if matrix_synapse_reverse_proxy_companion_container_labels_traefik_docker_network %}
traefik.docker.network={{ matrix_synapse_reverse_proxy_companion_container_labels_traefik_docker_network }}
{% endif %}
traefik.http.services.matrix-synapse-reverse-proxy-companion-client-api.loadbalancer.server.port=8008
traefik.http.services.matrix-synapse-reverse-proxy-companion-federation-api.loadbalancer.server.port=8048
Rename label-related variables for homeservers We'd be adding integration with an internal Traefik entrypoint (`matrix_playbook_internal_matrix_client_api_traefik_entrypoint`), so renaming helps disambiguate things. There's no need for deperecation tasks, because the old names have only been part of this `bye-bye-nginx-proxy` branch and not used by anyone publicly.
2024-01-14 10:29:38 +02:00
{% if matrix_synapse_reverse_proxy_companion_container_labels_public_client_api_enabled %}
Make Traefik labels files look better This moves the comments from being just in Jinja, to actually ending up in the generated `labels` file, which makes inspection of the final result easier. Also, some new lines were added here and there to make labels more legible. The generated file may still include weird new-lines due to various `if` statements yielding content or not, but that's not so ugly anymore - now that we have proper start/end sections that are visible in the final `labels` file.
2024-01-15 10:41:15 +02:00
############################################################
# #
# Public Client-API (/_matrix) #
# #
############################################################
Handle /_matrix Client-Server and Federation APIs directly at matrix-synapse-reverse-proxy-companion
2024-01-03 17:05:59 +02:00
Enable (Traefik compression middleware)-assisted compression for synapse-reverse-proxy-companion This likely breaks QR code login for Synapse-worker setups. See https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/3749
2024-11-14 16:30:09 +02:00
{% set client_api_middlewares = [] %}
{% if matrix_synapse_reverse_proxy_companion_container_labels_traefik_compression_middleware_enabled %}
{% set client_api_middlewares = client_api_middlewares + [matrix_synapse_reverse_proxy_companion_container_labels_traefik_compression_middleware_name] %}
{% endif %}
Add support for the internal Traefik entrypoint to synapse-reverse-proxy-companion
2024-01-14 10:48:26 +02:00
traefik.http.routers.matrix-synapse-reverse-proxy-companion-public-client-api.rule={{ matrix_synapse_reverse_proxy_companion_container_labels_public_client_api_traefik_rule }}
Handle /_matrix Client-Server and Federation APIs directly at matrix-synapse-reverse-proxy-companion
2024-01-03 17:05:59 +02:00
Enable (Traefik compression middleware)-assisted compression for synapse-reverse-proxy-companion This likely breaks QR code login for Synapse-worker setups. See https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/3749
2024-11-14 16:30:09 +02:00
{% if client_api_middlewares | length > 0 %}
traefik.http.routers.matrix-synapse-reverse-proxy-companion-public-client-api.middlewares={{ client_api_middlewares | join(',') }}
{% endif %}
Rename label-related variables for homeservers We'd be adding integration with an internal Traefik entrypoint (`matrix_playbook_internal_matrix_client_api_traefik_entrypoint`), so renaming helps disambiguate things. There's no need for deperecation tasks, because the old names have only been part of this `bye-bye-nginx-proxy` branch and not used by anyone publicly.
2024-01-14 10:29:38 +02:00
{% if matrix_synapse_reverse_proxy_companion_container_labels_public_client_api_traefik_priority | int > 0 %}
Add support for the internal Traefik entrypoint to synapse-reverse-proxy-companion
2024-01-14 10:48:26 +02:00
traefik.http.routers.matrix-synapse-reverse-proxy-companion-public-client-api.priority={{ matrix_synapse_reverse_proxy_companion_container_labels_public_client_api_traefik_priority }}
Handle /_matrix Client-Server and Federation APIs directly at matrix-synapse-reverse-proxy-companion
2024-01-03 17:05:59 +02:00
{% endif %}
Add support for the internal Traefik entrypoint to synapse-reverse-proxy-companion
2024-01-14 10:48:26 +02:00
traefik.http.routers.matrix-synapse-reverse-proxy-companion-public-client-api.service=matrix-synapse-reverse-proxy-companion-client-api
traefik.http.routers.matrix-synapse-reverse-proxy-companion-public-client-api.entrypoints={{ matrix_synapse_reverse_proxy_companion_container_labels_public_client_api_traefik_entrypoints }}
traefik.http.routers.matrix-synapse-reverse-proxy-companion-public-client-api.tls={{ matrix_synapse_reverse_proxy_companion_container_labels_public_client_api_traefik_tls | to_json }}
Handle /_matrix Client-Server and Federation APIs directly at matrix-synapse-reverse-proxy-companion
2024-01-03 17:05:59 +02:00
Rename label-related variables for homeservers We'd be adding integration with an internal Traefik entrypoint (`matrix_playbook_internal_matrix_client_api_traefik_entrypoint`), so renaming helps disambiguate things. There's no need for deperecation tasks, because the old names have only been part of this `bye-bye-nginx-proxy` branch and not used by anyone publicly.
2024-01-14 10:29:38 +02:00
{% if matrix_synapse_reverse_proxy_companion_container_labels_public_client_api_traefik_tls %}
Add support for the internal Traefik entrypoint to synapse-reverse-proxy-companion
2024-01-14 10:48:26 +02:00
traefik.http.routers.matrix-synapse-reverse-proxy-companion-public-client-api.tls.certResolver={{ matrix_synapse_reverse_proxy_companion_container_labels_public_client_api_traefik_tls_certResolver }}
Handle /_matrix Client-Server and Federation APIs directly at matrix-synapse-reverse-proxy-companion
2024-01-03 17:05:59 +02:00
{% endif %}
Make Traefik labels files look better This moves the comments from being just in Jinja, to actually ending up in the generated `labels` file, which makes inspection of the final result easier. Also, some new lines were added here and there to make labels more legible. The generated file may still include weird new-lines due to various `if` statements yielding content or not, but that's not so ugly anymore - now that we have proper start/end sections that are visible in the final `labels` file.
2024-01-15 10:41:15 +02:00
############################################################
# #
# /Public Client-API (/_matrix) #
# #
############################################################
Handle /_matrix Client-Server and Federation APIs directly at matrix-synapse-reverse-proxy-companion
2024-01-03 17:05:59 +02:00
{% endif %}
Add support for the internal Traefik entrypoint to synapse-reverse-proxy-companion
2024-01-14 10:48:26 +02:00
{% if matrix_synapse_reverse_proxy_companion_container_labels_internal_client_api_enabled %}
Make Traefik labels files look better This moves the comments from being just in Jinja, to actually ending up in the generated `labels` file, which makes inspection of the final result easier. Also, some new lines were added here and there to make labels more legible. The generated file may still include weird new-lines due to various `if` statements yielding content or not, but that's not so ugly anymore - now that we have proper start/end sections that are visible in the final `labels` file.
2024-01-15 10:41:15 +02:00
############################################################
# #
# Internal Client-API (/_matrix) #
# #
############################################################
Add support for the internal Traefik entrypoint to synapse-reverse-proxy-companion
2024-01-14 10:48:26 +02:00
traefik.http.routers.matrix-synapse-reverse-proxy-companion-internal-client-api.rule={{ matrix_synapse_reverse_proxy_companion_container_labels_internal_client_api_traefik_rule }}
{% if matrix_synapse_reverse_proxy_companion_container_labels_internal_client_api_traefik_priority | int > 0 %}
traefik.http.routers.matrix-synapse-reverse-proxy-companion-internal-client-api.priority={{ matrix_synapse_reverse_proxy_companion_container_labels_internal_client_api_traefik_priority }}
{% endif %}
traefik.http.routers.matrix-synapse-reverse-proxy-companion-internal-client-api.service=matrix-synapse-reverse-proxy-companion-client-api
traefik.http.routers.matrix-synapse-reverse-proxy-companion-internal-client-api.entrypoints={{ matrix_synapse_reverse_proxy_companion_container_labels_internal_client_api_traefik_entrypoints }}
Make Traefik labels files look better This moves the comments from being just in Jinja, to actually ending up in the generated `labels` file, which makes inspection of the final result easier. Also, some new lines were added here and there to make labels more legible. The generated file may still include weird new-lines due to various `if` statements yielding content or not, but that's not so ugly anymore - now that we have proper start/end sections that are visible in the final `labels` file.
2024-01-15 10:41:15 +02:00
############################################################
# #
# /Internal Client-API (/_matrix) #
# #
############################################################
Add support for the internal Traefik entrypoint to synapse-reverse-proxy-companion
2024-01-14 10:48:26 +02:00
{% endif %}
Rename label-related variables for homeservers We'd be adding integration with an internal Traefik entrypoint (`matrix_playbook_internal_matrix_client_api_traefik_entrypoint`), so renaming helps disambiguate things. There's no need for deperecation tasks, because the old names have only been part of this `bye-bye-nginx-proxy` branch and not used by anyone publicly.
2024-01-14 10:29:38 +02:00
{% if matrix_synapse_reverse_proxy_companion_container_labels_public_client_synapse_client_api_enabled %}
Make Traefik labels files look better This moves the comments from being just in Jinja, to actually ending up in the generated `labels` file, which makes inspection of the final result easier. Also, some new lines were added here and there to make labels more legible. The generated file may still include weird new-lines due to various `if` statements yielding content or not, but that's not so ugly anymore - now that we have proper start/end sections that are visible in the final `labels` file.
2024-01-15 10:41:15 +02:00
############################################################
# #
Update a few incorrect comments
2024-12-25 16:42:19 +02:00
# Public Synapse Client API (/_synapse/client) #
Make Traefik labels files look better This moves the comments from being just in Jinja, to actually ending up in the generated `labels` file, which makes inspection of the final result easier. Also, some new lines were added here and there to make labels more legible. The generated file may still include weird new-lines due to various `if` statements yielding content or not, but that's not so ugly anymore - now that we have proper start/end sections that are visible in the final `labels` file.
2024-01-15 10:41:15 +02:00
# #
############################################################
Expose /_synapse/* APIs via matrix-synapse-reverse-proxy-companion This also updates validation tasks and documentation, pointing to variables in the matrix-synapse role which don't currently exist yet (e.g. `matrix_synapse_container_labels_client_synapse_admin_api_enabled`). These variables will be added soon, as Traefik labels are added to the `matrix-synapse` role. At that point, the `matrix-synapse-reverse-proxy-companion` role will be updated to also use them.
2024-01-04 11:37:17 +02:00
Enable (Traefik compression middleware)-assisted compression for synapse-reverse-proxy-companion This likely breaks QR code login for Synapse-worker setups. See https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/3749
2024-11-14 16:30:09 +02:00
{% set synapse_client_api_middlewares = [] %}
{% if matrix_synapse_reverse_proxy_companion_container_labels_traefik_compression_middleware_enabled %}
{% set synapse_client_api_middlewares = synapse_client_api_middlewares + [matrix_synapse_reverse_proxy_companion_container_labels_traefik_compression_middleware_name] %}
{% endif %}
Add support for the internal Traefik entrypoint to synapse-reverse-proxy-companion
2024-01-14 10:48:26 +02:00
traefik.http.routers.matrix-synapse-reverse-proxy-companion-public-client-synapse-client-api.rule={{ matrix_synapse_reverse_proxy_companion_container_labels_public_client_synapse_client_api_traefik_rule }}
Expose /_synapse/* APIs via matrix-synapse-reverse-proxy-companion This also updates validation tasks and documentation, pointing to variables in the matrix-synapse role which don't currently exist yet (e.g. `matrix_synapse_container_labels_client_synapse_admin_api_enabled`). These variables will be added soon, as Traefik labels are added to the `matrix-synapse` role. At that point, the `matrix-synapse-reverse-proxy-companion` role will be updated to also use them.
2024-01-04 11:37:17 +02:00
Enable (Traefik compression middleware)-assisted compression for synapse-reverse-proxy-companion This likely breaks QR code login for Synapse-worker setups. See https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/3749
2024-11-14 16:30:09 +02:00
{% if synapse_client_api_middlewares | length > 0 %}
traefik.http.routers.matrix-synapse-reverse-proxy-companion-public-client-synapse-client-api.middlewares={{ synapse_client_api_middlewares | join(',') }}
{% endif %}
Rename label-related variables for homeservers We'd be adding integration with an internal Traefik entrypoint (`matrix_playbook_internal_matrix_client_api_traefik_entrypoint`), so renaming helps disambiguate things. There's no need for deperecation tasks, because the old names have only been part of this `bye-bye-nginx-proxy` branch and not used by anyone publicly.
2024-01-14 10:29:38 +02:00
{% if matrix_synapse_reverse_proxy_companion_container_labels_public_client_synapse_client_api_traefik_priority | int > 0 %}
Add support for the internal Traefik entrypoint to synapse-reverse-proxy-companion
2024-01-14 10:48:26 +02:00
traefik.http.routers.matrix-synapse-reverse-proxy-companion-public-client-synapse-client-api.priority={{ matrix_synapse_reverse_proxy_companion_container_labels_public_client_synapse_client_api_traefik_priority }}
Expose /_synapse/* APIs via matrix-synapse-reverse-proxy-companion This also updates validation tasks and documentation, pointing to variables in the matrix-synapse role which don't currently exist yet (e.g. `matrix_synapse_container_labels_client_synapse_admin_api_enabled`). These variables will be added soon, as Traefik labels are added to the `matrix-synapse` role. At that point, the `matrix-synapse-reverse-proxy-companion` role will be updated to also use them.
2024-01-04 11:37:17 +02:00
{% endif %}
Add support for the internal Traefik entrypoint to synapse-reverse-proxy-companion
2024-01-14 10:48:26 +02:00
traefik.http.routers.matrix-synapse-reverse-proxy-companion-public-client-synapse-client-api.service=matrix-synapse-reverse-proxy-companion-client-api
traefik.http.routers.matrix-synapse-reverse-proxy-companion-public-client-synapse-client-api.entrypoints={{ matrix_synapse_reverse_proxy_companion_container_labels_public_client_synapse_client_api_traefik_entrypoints }}
traefik.http.routers.matrix-synapse-reverse-proxy-companion-public-client-synapse-client-api.tls={{ matrix_synapse_reverse_proxy_companion_container_labels_public_client_synapse_client_api_traefik_tls | to_json }}
Expose /_synapse/* APIs via matrix-synapse-reverse-proxy-companion This also updates validation tasks and documentation, pointing to variables in the matrix-synapse role which don't currently exist yet (e.g. `matrix_synapse_container_labels_client_synapse_admin_api_enabled`). These variables will be added soon, as Traefik labels are added to the `matrix-synapse` role. At that point, the `matrix-synapse-reverse-proxy-companion` role will be updated to also use them.
2024-01-04 11:37:17 +02:00
Rename label-related variables for homeservers We'd be adding integration with an internal Traefik entrypoint (`matrix_playbook_internal_matrix_client_api_traefik_entrypoint`), so renaming helps disambiguate things. There's no need for deperecation tasks, because the old names have only been part of this `bye-bye-nginx-proxy` branch and not used by anyone publicly.
2024-01-14 10:29:38 +02:00
{% if matrix_synapse_reverse_proxy_companion_container_labels_public_client_synapse_client_api_traefik_tls %}
Add support for the internal Traefik entrypoint to synapse-reverse-proxy-companion
2024-01-14 10:48:26 +02:00
traefik.http.routers.matrix-synapse-reverse-proxy-companion-public-client-synapse-client-api.tls.certResolver={{ matrix_synapse_reverse_proxy_companion_container_labels_public_client_synapse_client_api_traefik_tls_certResolver }}
Expose /_synapse/* APIs via matrix-synapse-reverse-proxy-companion This also updates validation tasks and documentation, pointing to variables in the matrix-synapse role which don't currently exist yet (e.g. `matrix_synapse_container_labels_client_synapse_admin_api_enabled`). These variables will be added soon, as Traefik labels are added to the `matrix-synapse` role. At that point, the `matrix-synapse-reverse-proxy-companion` role will be updated to also use them.
2024-01-04 11:37:17 +02:00
{% endif %}
Make Traefik labels files look better This moves the comments from being just in Jinja, to actually ending up in the generated `labels` file, which makes inspection of the final result easier. Also, some new lines were added here and there to make labels more legible. The generated file may still include weird new-lines due to various `if` statements yielding content or not, but that's not so ugly anymore - now that we have proper start/end sections that are visible in the final `labels` file.
2024-01-15 10:41:15 +02:00
############################################################
# #
Update a few incorrect comments
2024-12-25 16:42:19 +02:00
# /Public Synapse Client API (/_synapse/client) #
Make Traefik labels files look better This moves the comments from being just in Jinja, to actually ending up in the generated `labels` file, which makes inspection of the final result easier. Also, some new lines were added here and there to make labels more legible. The generated file may still include weird new-lines due to various `if` statements yielding content or not, but that's not so ugly anymore - now that we have proper start/end sections that are visible in the final `labels` file.
2024-01-15 10:41:15 +02:00
# #
############################################################
Expose /_synapse/* APIs via matrix-synapse-reverse-proxy-companion This also updates validation tasks and documentation, pointing to variables in the matrix-synapse role which don't currently exist yet (e.g. `matrix_synapse_container_labels_client_synapse_admin_api_enabled`). These variables will be added soon, as Traefik labels are added to the `matrix-synapse` role. At that point, the `matrix-synapse-reverse-proxy-companion` role will be updated to also use them.
2024-01-04 11:37:17 +02:00
{% endif %}
Rename label-related variables for homeservers We'd be adding integration with an internal Traefik entrypoint (`matrix_playbook_internal_matrix_client_api_traefik_entrypoint`), so renaming helps disambiguate things. There's no need for deperecation tasks, because the old names have only been part of this `bye-bye-nginx-proxy` branch and not used by anyone publicly.
2024-01-14 10:29:38 +02:00
{% if matrix_synapse_reverse_proxy_companion_container_labels_public_client_synapse_admin_api_enabled %}
Make Traefik labels files look better This moves the comments from being just in Jinja, to actually ending up in the generated `labels` file, which makes inspection of the final result easier. Also, some new lines were added here and there to make labels more legible. The generated file may still include weird new-lines due to various `if` statements yielding content or not, but that's not so ugly anymore - now that we have proper start/end sections that are visible in the final `labels` file.
2024-01-15 10:41:15 +02:00
############################################################
# #
# Public Synapse Admin API (/_synapse/admin) #
# #
############################################################
Expose /_synapse/* APIs via matrix-synapse-reverse-proxy-companion This also updates validation tasks and documentation, pointing to variables in the matrix-synapse role which don't currently exist yet (e.g. `matrix_synapse_container_labels_client_synapse_admin_api_enabled`). These variables will be added soon, as Traefik labels are added to the `matrix-synapse` role. At that point, the `matrix-synapse-reverse-proxy-companion` role will be updated to also use them.
2024-01-04 11:37:17 +02:00
Enable (Traefik compression middleware)-assisted compression for synapse-reverse-proxy-companion This likely breaks QR code login for Synapse-worker setups. See https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/3749
2024-11-14 16:30:09 +02:00
{% set synapse_admin_api_middlewares = [] %}
{% if matrix_synapse_reverse_proxy_companion_container_labels_traefik_compression_middleware_enabled %}
{% set synapse_admin_api_middlewares = synapse_admin_api_middlewares + [matrix_synapse_reverse_proxy_companion_container_labels_traefik_compression_middleware_name] %}
{% endif %}
Add support for the internal Traefik entrypoint to synapse-reverse-proxy-companion
2024-01-14 10:48:26 +02:00
traefik.http.routers.matrix-synapse-reverse-proxy-companion-public-client-synapse-admin-api.rule={{ matrix_synapse_reverse_proxy_companion_container_labels_public_client_synapse_admin_api_traefik_rule }}
Expose /_synapse/* APIs via matrix-synapse-reverse-proxy-companion This also updates validation tasks and documentation, pointing to variables in the matrix-synapse role which don't currently exist yet (e.g. `matrix_synapse_container_labels_client_synapse_admin_api_enabled`). These variables will be added soon, as Traefik labels are added to the `matrix-synapse` role. At that point, the `matrix-synapse-reverse-proxy-companion` role will be updated to also use them.
2024-01-04 11:37:17 +02:00
Enable (Traefik compression middleware)-assisted compression for synapse-reverse-proxy-companion This likely breaks QR code login for Synapse-worker setups. See https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/3749
2024-11-14 16:30:09 +02:00
{% if synapse_admin_api_middlewares | length > 0 %}
traefik.http.routers.matrix-synapse-reverse-proxy-companion-public-client-synapse-admin-api.middlewares={{ synapse_admin_api_middlewares | join(',') }}
{% endif %}
Rename label-related variables for homeservers We'd be adding integration with an internal Traefik entrypoint (`matrix_playbook_internal_matrix_client_api_traefik_entrypoint`), so renaming helps disambiguate things. There's no need for deperecation tasks, because the old names have only been part of this `bye-bye-nginx-proxy` branch and not used by anyone publicly.
2024-01-14 10:29:38 +02:00
{% if matrix_synapse_reverse_proxy_companion_container_labels_public_client_synapse_admin_api_traefik_priority | int > 0 %}
Add support for the internal Traefik entrypoint to synapse-reverse-proxy-companion
2024-01-14 10:48:26 +02:00
traefik.http.routers.matrix-synapse-reverse-proxy-companion-public-client-synapse-admin-api.priority={{ matrix_synapse_reverse_proxy_companion_container_labels_public_client_synapse_admin_api_traefik_priority }}
Expose /_synapse/* APIs via matrix-synapse-reverse-proxy-companion This also updates validation tasks and documentation, pointing to variables in the matrix-synapse role which don't currently exist yet (e.g. `matrix_synapse_container_labels_client_synapse_admin_api_enabled`). These variables will be added soon, as Traefik labels are added to the `matrix-synapse` role. At that point, the `matrix-synapse-reverse-proxy-companion` role will be updated to also use them.
2024-01-04 11:37:17 +02:00
{% endif %}
Add support for the internal Traefik entrypoint to synapse-reverse-proxy-companion
2024-01-14 10:48:26 +02:00
traefik.http.routers.matrix-synapse-reverse-proxy-companion-public-client-synapse-admin-api.service=matrix-synapse-reverse-proxy-companion-client-api
traefik.http.routers.matrix-synapse-reverse-proxy-companion-public-client-synapse-admin-api.entrypoints={{ matrix_synapse_reverse_proxy_companion_container_labels_public_client_synapse_admin_api_traefik_entrypoints }}
traefik.http.routers.matrix-synapse-reverse-proxy-companion-public-client-synapse-admin-api.tls={{ matrix_synapse_reverse_proxy_companion_container_labels_public_client_synapse_admin_api_traefik_tls | to_json }}
Expose /_synapse/* APIs via matrix-synapse-reverse-proxy-companion This also updates validation tasks and documentation, pointing to variables in the matrix-synapse role which don't currently exist yet (e.g. `matrix_synapse_container_labels_client_synapse_admin_api_enabled`). These variables will be added soon, as Traefik labels are added to the `matrix-synapse` role. At that point, the `matrix-synapse-reverse-proxy-companion` role will be updated to also use them.
2024-01-04 11:37:17 +02:00
Rename label-related variables for homeservers We'd be adding integration with an internal Traefik entrypoint (`matrix_playbook_internal_matrix_client_api_traefik_entrypoint`), so renaming helps disambiguate things. There's no need for deperecation tasks, because the old names have only been part of this `bye-bye-nginx-proxy` branch and not used by anyone publicly.
2024-01-14 10:29:38 +02:00
{% if matrix_synapse_reverse_proxy_companion_container_labels_public_client_synapse_admin_api_traefik_tls %}
Add support for the internal Traefik entrypoint to synapse-reverse-proxy-companion
2024-01-14 10:48:26 +02:00
traefik.http.routers.matrix-synapse-reverse-proxy-companion-public-client-synapse-admin-api.tls.certResolver={{ matrix_synapse_reverse_proxy_companion_container_labels_public_client_synapse_admin_api_traefik_tls_certResolver }}
Expose /_synapse/* APIs via matrix-synapse-reverse-proxy-companion This also updates validation tasks and documentation, pointing to variables in the matrix-synapse role which don't currently exist yet (e.g. `matrix_synapse_container_labels_client_synapse_admin_api_enabled`). These variables will be added soon, as Traefik labels are added to the `matrix-synapse` role. At that point, the `matrix-synapse-reverse-proxy-companion` role will be updated to also use them.
2024-01-04 11:37:17 +02:00
{% endif %}
Make Traefik labels files look better This moves the comments from being just in Jinja, to actually ending up in the generated `labels` file, which makes inspection of the final result easier. Also, some new lines were added here and there to make labels more legible. The generated file may still include weird new-lines due to various `if` statements yielding content or not, but that's not so ugly anymore - now that we have proper start/end sections that are visible in the final `labels` file.
2024-01-15 10:41:15 +02:00
############################################################
# #
# /Public Synapse Admin API (/_synapse/admin) #
# #
############################################################
Expose /_synapse/* APIs via matrix-synapse-reverse-proxy-companion This also updates validation tasks and documentation, pointing to variables in the matrix-synapse role which don't currently exist yet (e.g. `matrix_synapse_container_labels_client_synapse_admin_api_enabled`). These variables will be added soon, as Traefik labels are added to the `matrix-synapse` role. At that point, the `matrix-synapse-reverse-proxy-companion` role will be updated to also use them.
2024-01-04 11:37:17 +02:00
{% endif %}
Internal Admin API and Draupnir Hjack Command Config (#3389) * Enable Internal Admin API Access separately from Public access. * Add Config variable for Draupnir Hijack command And also make the internal admin API be automatically activated when this capability is used. * Apply suggestions from code review Co-authored-by: Slavi Pantaleev <slavi@devture.com> * Further Refine Internal Admin API * Add Non Worker Labels for Internal Admin API * Variable Rename * Add validation rules for Internal Synapse admin API * Add Draupnir Admin API required config validation. * Override `matrix_synapse_reverse_proxy_companion_container_labels_internal_client_synapse_admin_api_traefik_entrypoints` via group vars * Wire `matrix_bot_draupnir_admin_api_enabled` to `matrix_bot_draupnir_config_admin_enableMakeRoomAdminCommand` in Draupnir's `defaults/main.yml` * Remove unnecessary `matrix_bot_draupnir_admin_api_enabled` override from `group_vars/matrix_servers` The same value is now (more appropriately) defined in Draupnir's `defaults/main.yml` file anyway. * Add additional condition (`matrix_bot_draupnir_enabled`) for enabling `matrix_synapse_container_labels_internal_client_synapse_admin_api_enabled` * Use a separate task for validating `matrix_bot_draupnir_admin_api_enabled` when `matrix_bot_draupnir_config_admin_enableMakeRoomAdminCommand` The other task deals with checking for null and not-blank and can't handle booleans properly. --------- Co-authored-by: Slavi Pantaleev <slavi@devture.com>
2025-03-15 08:14:55 +01:00
{% if matrix_synapse_reverse_proxy_companion_container_labels_internal_client_synapse_admin_api_enabled %}
############################################################
# #
# Internal Synapse Admin API (/_synapse/admin) #
# #
############################################################
Fix rogue missing `_client_synapse` in internal admin api
2025-03-15 10:05:31 +01:00
traefik.http.routers.matrix-synapse-reverse-proxy-companion-internal-client-synapse-admin-api.rule={{ matrix_synapse_reverse_proxy_companion_container_labels_internal_client_synapse_admin_api_traefik_rule }}
Internal Admin API and Draupnir Hjack Command Config (#3389) * Enable Internal Admin API Access separately from Public access. * Add Config variable for Draupnir Hijack command And also make the internal admin API be automatically activated when this capability is used. * Apply suggestions from code review Co-authored-by: Slavi Pantaleev <slavi@devture.com> * Further Refine Internal Admin API * Add Non Worker Labels for Internal Admin API * Variable Rename * Add validation rules for Internal Synapse admin API * Add Draupnir Admin API required config validation. * Override `matrix_synapse_reverse_proxy_companion_container_labels_internal_client_synapse_admin_api_traefik_entrypoints` via group vars * Wire `matrix_bot_draupnir_admin_api_enabled` to `matrix_bot_draupnir_config_admin_enableMakeRoomAdminCommand` in Draupnir's `defaults/main.yml` * Remove unnecessary `matrix_bot_draupnir_admin_api_enabled` override from `group_vars/matrix_servers` The same value is now (more appropriately) defined in Draupnir's `defaults/main.yml` file anyway. * Add additional condition (`matrix_bot_draupnir_enabled`) for enabling `matrix_synapse_container_labels_internal_client_synapse_admin_api_enabled` * Use a separate task for validating `matrix_bot_draupnir_admin_api_enabled` when `matrix_bot_draupnir_config_admin_enableMakeRoomAdminCommand` The other task deals with checking for null and not-blank and can't handle booleans properly. --------- Co-authored-by: Slavi Pantaleev <slavi@devture.com>
2025-03-15 08:14:55 +01:00
{% if matrix_synapse_reverse_proxy_companion_container_labels_internal_client_synapse_admin_api_traefik_priority | int > 0 %}
traefik.http.routers.matrix-synapse-reverse-proxy-companion-public-client-synapse-admin-api.priority={{ matrix_synapse_reverse_proxy_companion_container_labels_internal_client_synapse_admin_api_traefik_priority }}
{% endif %}
traefik.http.routers.matrix-synapse-reverse-proxy-companion-internal-client-synapse-admin-api.service=matrix-synapse-reverse-proxy-companion-client-api
traefik.http.routers.matrix-synapse-reverse-proxy-companion-internal-client-synapse-admin-api.entrypoints={{ matrix_synapse_reverse_proxy_companion_container_labels_internal_client_synapse_admin_api_traefik_entrypoints }}
############################################################
# #
# /Internal Synapse Admin API (/_synapse/admin) #
# #
############################################################
{% endif %}
Expose /_synapse/* APIs via matrix-synapse-reverse-proxy-companion This also updates validation tasks and documentation, pointing to variables in the matrix-synapse role which don't currently exist yet (e.g. `matrix_synapse_container_labels_client_synapse_admin_api_enabled`). These variables will be added soon, as Traefik labels are added to the `matrix-synapse` role. At that point, the `matrix-synapse-reverse-proxy-companion` role will be updated to also use them.
2024-01-04 11:37:17 +02:00
Rename label-related variables for homeservers We'd be adding integration with an internal Traefik entrypoint (`matrix_playbook_internal_matrix_client_api_traefik_entrypoint`), so renaming helps disambiguate things. There's no need for deperecation tasks, because the old names have only been part of this `bye-bye-nginx-proxy` branch and not used by anyone publicly.
2024-01-14 10:29:38 +02:00
{% if matrix_synapse_reverse_proxy_companion_container_labels_public_federation_api_enabled %}
Make Traefik labels files look better This moves the comments from being just in Jinja, to actually ending up in the generated `labels` file, which makes inspection of the final result easier. Also, some new lines were added here and there to make labels more legible. The generated file may still include weird new-lines due to various `if` statements yielding content or not, but that's not so ugly anymore - now that we have proper start/end sections that are visible in the final `labels` file.
2024-01-15 10:41:15 +02:00
############################################################
# #
# Public Federation-API (/_matrix) #
# #
############################################################
Handle /_matrix Client-Server and Federation APIs directly at matrix-synapse-reverse-proxy-companion
2024-01-03 17:05:59 +02:00
Enable (Traefik compression middleware)-assisted compression for synapse-reverse-proxy-companion This likely breaks QR code login for Synapse-worker setups. See https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/3749
2024-11-14 16:30:09 +02:00
{% set federation_api_middlewares = [] %}
{% if matrix_synapse_reverse_proxy_companion_container_labels_traefik_compression_middleware_enabled %}
{% set federation_api_middlewares = federation_api_middlewares + [matrix_synapse_reverse_proxy_companion_container_labels_traefik_compression_middleware_name] %}
{% endif %}
Add support for the internal Traefik entrypoint to synapse-reverse-proxy-companion
2024-01-14 10:48:26 +02:00
traefik.http.routers.matrix-synapse-reverse-proxy-companion-public-federation-api.rule={{ matrix_synapse_reverse_proxy_companion_container_labels_public_federation_api_traefik_rule }}
Handle /_matrix Client-Server and Federation APIs directly at matrix-synapse-reverse-proxy-companion
2024-01-03 17:05:59 +02:00
Enable (Traefik compression middleware)-assisted compression for synapse-reverse-proxy-companion This likely breaks QR code login for Synapse-worker setups. See https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/3749
2024-11-14 16:30:09 +02:00
{% if federation_api_middlewares | length > 0 %}
traefik.http.routers.matrix-synapse-reverse-proxy-companion-public-federation-api.middlewares={{ federation_api_middlewares | join(',') }}
{% endif %}
Rename label-related variables for homeservers We'd be adding integration with an internal Traefik entrypoint (`matrix_playbook_internal_matrix_client_api_traefik_entrypoint`), so renaming helps disambiguate things. There's no need for deperecation tasks, because the old names have only been part of this `bye-bye-nginx-proxy` branch and not used by anyone publicly.
2024-01-14 10:29:38 +02:00
{% if matrix_synapse_reverse_proxy_companion_container_labels_public_federation_api_traefik_priority | int > 0 %}
Add support for the internal Traefik entrypoint to synapse-reverse-proxy-companion
2024-01-14 10:48:26 +02:00
traefik.http.routers.matrix-synapse-reverse-proxy-companion-public-federation-api.priority={{ matrix_synapse_reverse_proxy_companion_container_labels_public_federation_api_traefik_priority }}
Handle /_matrix Client-Server and Federation APIs directly at matrix-synapse-reverse-proxy-companion
2024-01-03 17:05:59 +02:00
{% endif %}
Add support for the internal Traefik entrypoint to synapse-reverse-proxy-companion
2024-01-14 10:48:26 +02:00
traefik.http.routers.matrix-synapse-reverse-proxy-companion-public-federation-api.service=matrix-synapse-reverse-proxy-companion-federation-api
traefik.http.routers.matrix-synapse-reverse-proxy-companion-public-federation-api.entrypoints={{ matrix_synapse_reverse_proxy_companion_container_labels_public_federation_api_traefik_entrypoints }}
traefik.http.routers.matrix-synapse-reverse-proxy-companion-public-federation-api.tls={{ matrix_synapse_reverse_proxy_companion_container_labels_public_federation_api_traefik_tls | to_json }}
Handle /_matrix Client-Server and Federation APIs directly at matrix-synapse-reverse-proxy-companion
2024-01-03 17:05:59 +02:00
Rename label-related variables for homeservers We'd be adding integration with an internal Traefik entrypoint (`matrix_playbook_internal_matrix_client_api_traefik_entrypoint`), so renaming helps disambiguate things. There's no need for deperecation tasks, because the old names have only been part of this `bye-bye-nginx-proxy` branch and not used by anyone publicly.
2024-01-14 10:29:38 +02:00
{% if matrix_synapse_reverse_proxy_companion_container_labels_public_federation_api_traefik_tls %}
Add support for the internal Traefik entrypoint to synapse-reverse-proxy-companion
2024-01-14 10:48:26 +02:00
traefik.http.routers.matrix-synapse-reverse-proxy-companion-public-federation-api.tls.certResolver={{ matrix_synapse_reverse_proxy_companion_container_labels_public_federation_api_traefik_tls_certResolver }}
Handle /_matrix Client-Server and Federation APIs directly at matrix-synapse-reverse-proxy-companion
2024-01-03 17:05:59 +02:00
{% endif %}
Make Traefik labels files look better This moves the comments from being just in Jinja, to actually ending up in the generated `labels` file, which makes inspection of the final result easier. Also, some new lines were added here and there to make labels more legible. The generated file may still include weird new-lines due to various `if` statements yielding content or not, but that's not so ugly anymore - now that we have proper start/end sections that are visible in the final `labels` file.
2024-01-15 10:41:15 +02:00
############################################################
# #
# /Public Federation-API (/_matrix) #
# #
############################################################
Handle /_matrix Client-Server and Federation APIs directly at matrix-synapse-reverse-proxy-companion
2024-01-03 17:05:59 +02:00
{% endif %}
Make Traefik labels files look better This moves the comments from being just in Jinja, to actually ending up in the generated `labels` file, which makes inspection of the final result easier. Also, some new lines were added here and there to make labels more legible. The generated file may still include weird new-lines due to various `if` statements yielding content or not, but that's not so ugly anymore - now that we have proper start/end sections that are visible in the final `labels` file.
2024-01-15 10:41:15 +02:00
Handle /_matrix Client-Server and Federation APIs directly at matrix-synapse-reverse-proxy-companion
2024-01-03 17:05:59 +02:00
{% endif %}
{{ matrix_synapse_reverse_proxy_companion_container_labels_additional_labels }}
Reference in New Issue Copy Permalink