mirror of
https://github.com/spantaleev/matrix-docker-ansible-deploy.git
synced 2026-01-30 19:55:20 +00:00
b1ff71266b
- Upgrade from 1.0.1 to 4.0.0 - Add ircService.mediaProxy configuration for authenticated Matrix media - Add Traefik integration for media proxy endpoint - Generate signing key for authenticated media Closes #3512 Co-authored-by: Jade Ellis <jade@ellis.link> Co-authored-by: Slavi Pantaleev <slavi@devture.com>
71 lines
4.5 KiB
YAML
71 lines
4.5 KiB
YAML
# SPDX-FileCopyrightText: 2019 - 2025 Slavi Pantaleev
|
|
# SPDX-FileCopyrightText: 2022 MDAD project contributors
|
|
# SPDX-FileCopyrightText: 2025 Suguru Hirahara
|
|
#
|
|
# SPDX-License-Identifier: AGPL-3.0-or-later
|
|
|
|
---
|
|
|
|
- name: Fail if required appservice-irc settings not defined
|
|
ansible.builtin.fail:
|
|
msg: >-
|
|
You need to define a required configuration setting (`{{ item.name }}`).
|
|
when: "item.when | bool and lookup('vars', item.name, default='') | string | length == 0"
|
|
with_items:
|
|
- {'name': 'matrix_appservice_irc_appservice_token', when: true}
|
|
- {'name': 'matrix_appservice_irc_homeserver_url', when: true}
|
|
- {'name': 'matrix_appservice_irc_homeserver_token', when: true}
|
|
- {'name': 'matrix_appservice_irc_database_hostname', when: "{{ matrix_appservice_irc_database_engine == 'postgres' }}"}
|
|
- {'name': 'matrix_appservice_irc_container_network', when: true}
|
|
|
|
# Our base configuration (`matrix_appservice_irc_configuration_yaml`) is not enough to
|
|
# let the playbook run without errors.
|
|
#
|
|
# Unless the final configuration (`matrix_appservice_irc_configuration`) contains an `ircService` definition,
|
|
# we'd fail generating the registration.yaml file with a non-helpful error.
|
|
#
|
|
# This is a safety check to ensure we fail earlier and in a nicer way.
|
|
- name: Fail if no additional configuration provided
|
|
ansible.builtin.fail:
|
|
msg: >-
|
|
Your Appservice IRC configuration is incomplete (lacking an `ircService.servers` configuration).
|
|
You need to define one or more servers by either using `matrix_appservice_irc_ircService_servers`
|
|
or by extending the base configuration with additional configuration in `matrix_appservice_irc_configuration_extension_yaml`.
|
|
Overriding the whole bridge's configuration (`matrix_appservice_irc_configuration`) is yet another possibility.
|
|
when: "matrix_appservice_irc_configuration.ircService.servers | length == 0"
|
|
|
|
- name: (Deprecation) Catch and report renamed appservice-irc variables
|
|
ansible.builtin.fail:
|
|
msg: >-
|
|
Your configuration contains a variable, which now has a different name.
|
|
Please rename the variable (`{{ item.old }}` -> `{{ item.new }}`) on your configuration file (vars.yml).
|
|
when: "lookup('ansible.builtin.varnames', ('^' + item.old + '$'), wantlist=True) | length > 0"
|
|
with_items:
|
|
- {'old': 'matrix_appservice_irc_container_expose_client_server_api_port', 'new': '<superseded by matrix_appservice_irc_container_http_host_bind_port>'}
|
|
- {'old': 'matrix_appservice_irc_container_self_build', 'new': 'matrix_appservice_irc_container_image_self_build'}
|
|
- {'old': 'matrix_appservice_irc_docker_image_name_prefix', 'new': 'matrix_appservice_irc_docker_image_registry_prefix'}
|
|
- {'old': 'matrix_appservice_irc_homeserver_media_url', 'new': '<removed; media proxying now uses matrix_appservice_irc_ircService_mediaProxy_publicUrl>'}
|
|
|
|
- name: Fail if matrix_appservice_irc_ircService_mediaProxy_publicUrl_pathPrefix does not start with a slash
|
|
ansible.builtin.fail:
|
|
msg: >-
|
|
matrix_appservice_irc_ircService_mediaProxy_publicUrl_pathPrefix (`{{ matrix_appservice_irc_ircService_mediaProxy_publicUrl_pathPrefix }}`) must start with a slash (e.g. `/` or `/irc/`).
|
|
when: "matrix_appservice_irc_ircService_mediaProxy_publicUrl_pathPrefix[0] != '/'"
|
|
|
|
- name: Fail if matrix_appservice_irc_ircService_mediaProxy_publicUrl_pathPrefix does not end with a slash
|
|
ansible.builtin.fail:
|
|
msg: >-
|
|
matrix_appservice_irc_ircService_mediaProxy_publicUrl_pathPrefix (`{{ matrix_appservice_irc_ircService_mediaProxy_publicUrl_pathPrefix }}`) must end with a slash (e.g. `/` or `/irc/`).
|
|
when: "matrix_appservice_irc_ircService_mediaProxy_publicUrl_pathPrefix[-1] != '/'"
|
|
|
|
- when: matrix_appservice_irc_container_labels_traefik_enabled | bool
|
|
block:
|
|
# We ensure it doesn't end with a slash, because we handle both (slash and no-slash).
|
|
# Knowing that the 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_appservice_irc_container_labels_media_proxy_traefik_path_prefix ends with a slash
|
|
ansible.builtin.fail:
|
|
msg: >-
|
|
matrix_appservice_irc_container_labels_media_proxy_traefik_path_prefix (`{{ matrix_appservice_irc_container_labels_media_proxy_traefik_path_prefix }}`) must either be `/` or not end with a slash (e.g. `/irc`).
|
|
when: "matrix_appservice_irc_container_labels_media_proxy_traefik_path_prefix != '/' and matrix_appservice_irc_container_labels_media_proxy_traefik_path_prefix[-1] == '/'"
|