mirror of
https://github.com/spantaleev/matrix-docker-ansible-deploy.git
synced 2026-02-08 08:03:08 +00:00
5cc69ca7eb
This adds a new routing mechanism for sync workers that resolves access tokens to usernames via Synapse's whoami endpoint, enabling true user-level sticky routing regardless of which device or token is used. Previously, sticky routing relied on parsing the username from native Synapse tokens (`syt_<base64 username>_...`), which only works with native Synapse auth and provides device-level stickiness at best. This new approach works with any auth system (native Synapse, MAS, etc.) because Synapse handles token validation internally. Implementation uses nginx's auth_request module with an njs script because: - The whoami lookup requires an async HTTP subrequest (ngx.fetch) - js_set handlers must return synchronously and don't support async operations - auth_request allows the async lookup to complete, then captures the result via response headers into nginx variables The njs script: - Extracts access tokens from Authorization header or query parameter - Calls Synapse's whoami endpoint to resolve token -> username - Caches results in a shared memory zone to minimize latency - Returns the username via a `X-User-Identifier` header The username is then used by nginx's upstream hash directive for consistent worker selection. This leverages nginx's built-in health checking and failover.
76 lines
3.7 KiB
YAML
76 lines
3.7 KiB
YAML
# SPDX-FileCopyrightText: 2022 - 2024 Slavi Pantaleev
|
|
# SPDX-FileCopyrightText: 2024 David Mehren
|
|
#
|
|
# SPDX-License-Identifier: AGPL-3.0-or-later
|
|
|
|
---
|
|
|
|
- name: Ensure matrix-synapse-reverse-proxy-companion paths exist
|
|
ansible.builtin.file:
|
|
path: "{{ item.path }}"
|
|
state: directory
|
|
mode: 0750
|
|
owner: "{{ matrix_user_name }}"
|
|
group: "{{ matrix_group_name }}"
|
|
with_items:
|
|
- {path: "{{ matrix_synapse_reverse_proxy_companion_base_path }}", when: true}
|
|
- {path: "{{ matrix_synapse_reverse_proxy_companion_confd_path }}", when: true}
|
|
- {path: "{{ matrix_synapse_reverse_proxy_companion_njs_path }}", when: "{{ matrix_synapse_reverse_proxy_companion_njs_enabled }}"}
|
|
when: item.when | bool
|
|
|
|
- name: Ensure matrix-synapse-reverse-proxy-companion is configured
|
|
ansible.builtin.template:
|
|
src: "{{ item.src }}"
|
|
dest: "{{ item.dest }}"
|
|
owner: "{{ matrix_user_name }}"
|
|
group: "{{ matrix_group_name }}"
|
|
mode: 0644
|
|
with_items:
|
|
- src: "{{ role_path }}/templates/nginx/nginx.conf.j2"
|
|
dest: "{{ matrix_synapse_reverse_proxy_companion_base_path }}/nginx.conf"
|
|
- src: "{{ role_path }}/templates/nginx/conf.d/nginx-http.conf.j2"
|
|
dest: "{{ matrix_synapse_reverse_proxy_companion_confd_path }}/nginx-http.conf"
|
|
- src: "{{ role_path }}/templates/nginx/conf.d/matrix-synapse-reverse-proxy-companion.conf.j2"
|
|
dest: "{{ matrix_synapse_reverse_proxy_companion_confd_path }}/matrix-synapse-reverse-proxy-companion.conf"
|
|
- src: "{{ role_path }}/templates/labels.j2"
|
|
dest: "{{ matrix_synapse_reverse_proxy_companion_base_path }}/labels"
|
|
|
|
- name: Ensure matrix-synapse-reverse-proxy-companion whoami sync worker router njs script is deployed
|
|
ansible.builtin.template:
|
|
src: "{{ role_path }}/templates/nginx/njs/whoami_sync_worker_router.js.j2"
|
|
dest: "{{ matrix_synapse_reverse_proxy_companion_njs_path }}/whoami_sync_worker_router.js"
|
|
owner: "{{ matrix_user_name }}"
|
|
group: "{{ matrix_group_name }}"
|
|
mode: 0644
|
|
when: matrix_synapse_reverse_proxy_companion_whoami_sync_worker_router_enabled | bool
|
|
|
|
- name: Ensure matrix-synapse-reverse-proxy-companion njs path is removed when njs is disabled
|
|
ansible.builtin.file:
|
|
path: "{{ matrix_synapse_reverse_proxy_companion_njs_path }}"
|
|
state: absent
|
|
when: not matrix_synapse_reverse_proxy_companion_njs_enabled
|
|
|
|
- name: Ensure matrix-synapse-reverse-proxy-companion nginx container image is pulled
|
|
community.docker.docker_image:
|
|
name: "{{ matrix_synapse_reverse_proxy_companion_container_image }}"
|
|
source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}"
|
|
force_source: "{{ matrix_synapse_reverse_proxy_companion_container_image_force_pull if ansible_version.major > 2 or ansible_version.minor >= 8 else omit }}"
|
|
force: "{{ omit if ansible_version.major > 2 or ansible_version.minor >= 8 else matrix_synapse_reverse_proxy_companion_container_image_force_pull }}"
|
|
register: result
|
|
retries: "{{ devture_playbook_help_container_retries_count }}"
|
|
delay: "{{ devture_playbook_help_container_retries_delay }}"
|
|
until: result is not failed
|
|
|
|
- name: Ensure matrix-synapse-reverse-proxy-companion container network is created
|
|
community.general.docker_network:
|
|
enable_ipv6: "{{ devture_systemd_docker_base_ipv6_enabled }}"
|
|
name: "{{ matrix_synapse_reverse_proxy_companion_container_network }}"
|
|
driver: bridge
|
|
driver_options: "{{ devture_systemd_docker_base_container_networks_driver_options }}"
|
|
|
|
- name: Ensure matrix-synapse-reverse-proxy-companion.service installed
|
|
ansible.builtin.template:
|
|
src: "{{ role_path }}/templates/systemd/matrix-synapse-reverse-proxy-companion.service.j2"
|
|
dest: "{{ devture_systemd_docker_base_systemd_path }}/matrix-synapse-reverse-proxy-companion.service"
|
|
mode: 0644
|