Signed-off-by: Suguru Hirahara <did🔑z6MkvVZk1A3KBApWJXv2Ju4H14ErDfRGxh8zxdXSZ4vACDg5>
pull/4919/head
| @@ -1,169 +0,0 @@ | |||
| # SPDX-FileCopyrightText: 2020 - 2025 Slavi Pantaleev | |||
| # SPDX-FileCopyrightText: 2021 Aaron Raimist | |||
| # SPDX-FileCopyrightText: 2021 Ahmad Haghighi | |||
| # SPDX-FileCopyrightText: 2022 Marko Weltzer | |||
| # SPDX-FileCopyrightText: 2022 Nikita Chernyi | |||
| # SPDX-FileCopyrightText: 2023 Samuel Meenzen | |||
| # SPDX-FileCopyrightText: 2024 Suguru Hirahara | |||
| # | |||
| # SPDX-License-Identifier: AGPL-3.0-or-later | |||
| --- | |||
| # matrix-registration is a simple python application to have a token based Matrix registration | |||
| # See: https://zeratax.github.io/matrix-registration/ | |||
| # Project source code URL: https://github.com/ZerataX/matrix-registration | |||
| matrix_registration_enabled: true | |||
| matrix_registration_scheme: https | |||
| matrix_registration_hostname: '' | |||
| matrix_registration_path_prefix: / | |||
| matrix_registration_container_image_self_build: false | |||
| matrix_registration_container_image_self_build_repo: "https://github.com/ZerataX/matrix-registration" | |||
| matrix_registration_container_image_self_build_branch: "{{ 'master' if matrix_registration_version == 'latest' else matrix_registration_version }}" | |||
| # Controls whether we'll be patching the dependencies in `setup.py` when self-building. | |||
| # Without patching, building will likely fail, because of the poor unbounded way dependencies are defined (e.g. `flask-limiter>=1.1.0`). | |||
| # This is an attempt to get matrix-registration in its current (outdated) version to build. | |||
| matrix_registration_container_image_self_build_python_dependencies_patch_enabled: true | |||
| matrix_registration_base_path: "{{ matrix_base_data_path }}/matrix-registration" | |||
| matrix_registration_config_path: "{{ matrix_registration_base_path }}/config" | |||
| matrix_registration_data_path: "{{ matrix_registration_base_path }}/data" | |||
| matrix_registration_docker_src_files_path: "{{ matrix_registration_base_path }}/docker-src" | |||
| # renovate: datasource=docker depName=zeratax/matrix-registration | |||
| matrix_registration_version: "v0.7.2" | |||
| matrix_registration_docker_image: "{{ matrix_registration_docker_image_registry_prefix }}zeratax/matrix-registration:{{ matrix_registration_version }}" | |||
| matrix_registration_docker_image_registry_prefix: "{{ 'localhost/' if matrix_registration_container_image_self_build else matrix_registration_docker_image_registry_prefix_upstream }}" | |||
| matrix_registration_docker_image_registry_prefix_upstream: "{{ matrix_registration_docker_image_registry_prefix_upstream_default }}" | |||
| matrix_registration_docker_image_registry_prefix_upstream_default: "docker.io/" | |||
| matrix_registration_docker_image_force_pull: "{{ matrix_registration_docker_image.endswith(':latest') }}" | |||
| matrix_registration_container_network: "" | |||
| matrix_registration_container_additional_networks: "{{ matrix_registration_container_additional_networks_auto + matrix_registration_container_additional_networks_custom }}" | |||
| matrix_registration_container_additional_networks_auto: [] | |||
| matrix_registration_container_additional_networks_custom: [] | |||
| # matrix_registration_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_registration_container_labels_additional_labels`. | |||
| matrix_registration_container_labels_traefik_enabled: true | |||
| matrix_registration_container_labels_traefik_docker_network: "{{ matrix_registration_container_network }}" | |||
| matrix_registration_container_labels_traefik_entrypoints: web-secure | |||
| matrix_registration_container_labels_traefik_tls_certResolver: default # noqa var-naming | |||
| # Controls whether labels will be added that expose matrix-registration's public endpoints | |||
| matrix_registration_container_labels_public_endpoint_enabled: true | |||
| matrix_registration_container_labels_public_endpoint_traefik_rule: "Host(`{{ matrix_registration_hostname }}`){% if matrix_registration_path_prefix != '/' %} && PathPrefix(`{{ matrix_registration_path_prefix }}`){% endif %}" | |||
| matrix_registration_container_labels_public_endpoint_traefik_priority: 0 | |||
| matrix_registration_container_labels_public_endpoint_traefik_entrypoints: "{{ matrix_registration_container_labels_traefik_entrypoints }}" | |||
| matrix_registration_container_labels_public_endpoint_traefik_tls: "{{ matrix_registration_container_labels_public_endpoint_traefik_entrypoints != 'web' }}" | |||
| matrix_registration_container_labels_public_endpoint_traefik_tls_certResolver: "{{ matrix_registration_container_labels_traefik_tls_certResolver }}" # noqa var-naming | |||
| # matrix_registration_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_registration_container_labels_additional_labels: | | |||
| # my.label=1 | |||
| # another.label="here" | |||
| matrix_registration_container_labels_additional_labels: '' | |||
| # A list of extra arguments to pass to the container | |||
| matrix_registration_container_extra_arguments: [] | |||
| # List of systemd services that matrix-registration.service depends on | |||
| matrix_registration_systemd_required_services_list: "{{ matrix_registration_systemd_required_services_list_default + matrix_registration_systemd_required_services_list_auto + matrix_registration_systemd_required_services_list_custom }}" | |||
| matrix_registration_systemd_required_services_list_default: "{{ [devture_systemd_docker_base_docker_service_name] if devture_systemd_docker_base_docker_service_name else [] }}" | |||
| matrix_registration_systemd_required_services_list_auto: [] | |||
| matrix_registration_systemd_required_services_list_custom: [] | |||
| # List of systemd services that matrix-registration.service wants | |||
| matrix_registration_systemd_wanted_services_list: [] | |||
| # Controls whether the matrix-registration container exposes its HTTP port (tcp/5000 in the container). | |||
| # | |||
| # Takes an "<ip>:<port>" or "<port>" value (e.g. "127.0.0.1:8767"), or empty string to not expose. | |||
| matrix_registration_container_http_host_bind_port: '' | |||
| # Database-related configuration fields. | |||
| # | |||
| # To use SQLite, stick to these defaults. | |||
| # | |||
| # To use Postgres: | |||
| # - change the engine (`matrix_registration_database_engine: 'postgres'`) | |||
| # - adjust your database credentials via the `matrix_registration_database_*` variables | |||
| matrix_registration_database_engine: 'sqlite' | |||
| matrix_registration_sqlite_database_path_local: "{{ matrix_registration_data_path }}/db.sqlite3" | |||
| matrix_registration_sqlite_database_path_in_container: "/data/db.sqlite3" | |||
| matrix_registration_database_username: 'matrix_registration' | |||
| matrix_registration_database_password: 'some-password' | |||
| matrix_registration_database_hostname: '' | |||
| matrix_registration_database_port: 5432 | |||
| matrix_registration_database_name: 'matrix_registration' | |||
| matrix_registration_database_connection_string: 'postgresql://{{ matrix_registration_database_username }}:{{ matrix_registration_database_password }}@{{ matrix_registration_database_hostname }}:{{ matrix_registration_database_port }}/{{ matrix_registration_database_name }}' | |||
| # For some reason, matrix-registraiton expects the `db` field to be like this: `sqlite:////data/db.sqlite3`. | |||
| # (seems like one too many slashes, but..) | |||
| matrix_registration_db: "{{ | |||
| { | |||
| 'sqlite': ('sqlite:///' + matrix_registration_sqlite_database_path_in_container), | |||
| 'postgres': matrix_registration_database_connection_string, | |||
| }[matrix_registration_database_engine] | |||
| }}" | |||
| matrix_registration_base_url: "{{ matrix_registration_path_prefix }}" | |||
| matrix_registration_api_register_endpoint: "{{ matrix_registration_scheme }}://{{ matrix_registration_hostname }}{{ matrix_registration_base_url }}{{ '' if matrix_registration_base_url == '/' else '/' }}register" | |||
| matrix_registration_api_token_endpoint: "{{ matrix_registration_scheme }}://{{ matrix_registration_hostname }}{{ matrix_registration_base_url }}{{ '' if matrix_registration_base_url == '/' else '/' }}token" | |||
| matrix_registration_api_validate_certs: true | |||
| # The URL to your homeserver (e.g.: `https://matrix.example.com`). | |||
| # A local (in-container address) is preferable. | |||
| matrix_registration_server_location: "" | |||
| matrix_registration_server_name: "{{ matrix_domain }}" | |||
| # matrix_registration_shared_secret needs to match the homeserver's registration secret. | |||
| # For Synapse, that's the `registration_shared_secret` setting. | |||
| matrix_registration_shared_secret: "" | |||
| # matrix_registration_admin_secret is your own admin secret for using matrix-registration (creating new tokens, etc.) | |||
| matrix_registration_admin_secret: "" | |||
| matrix_registration_riot_instance: "https://element.io/app/" | |||
| # Default matrix-registration configuration template which covers the generic use case. | |||
| # You can customize it by controlling the various variables inside it. | |||
| # | |||
| # For a more advanced customization, you can extend the default (see `matrix_registration_configuration_extension_yaml`) | |||
| # or completely replace this variable with your own template. | |||
| matrix_registration_configuration_yaml: "{{ lookup('template', 'templates/config.yaml.j2') }}" | |||
| matrix_registration_configuration_extension_yaml: | | |||
| # Your custom YAML configuration for registration goes here. | |||
| # This configuration extends the default starting configuration (`matrix_registration_configuration_yaml`). | |||
| # | |||
| # You can override individual variables from the default configuration, or introduce new ones. | |||
| # | |||
| # If you need something more special, you can take full control by | |||
| # completely redefining `matrix_registration_configuration_yaml`. | |||
| # | |||
| # Example configuration extension follows: | |||
| # | |||
| # password: | |||
| # min_length: 12 | |||
| matrix_registration_configuration_extension: "{{ matrix_registration_configuration_extension_yaml | from_yaml if matrix_registration_configuration_extension_yaml | from_yaml is mapping else {} }}" | |||
| # Holds the final matrix-registration configuration (a combination of the default and its extension). | |||
| # You most likely don't need to touch this variable. Instead, see `matrix_registration_configuration_yaml`. | |||
| matrix_registration_configuration: "{{ matrix_registration_configuration_yaml | from_yaml | combine(matrix_registration_configuration_extension, recursive=True) }}" | |||
| @@ -1,57 +0,0 @@ | |||
| # SPDX-FileCopyrightText: 2020 - 2022 Slavi Pantaleev | |||
| # SPDX-FileCopyrightText: 2022 Marko Weltzer | |||
| # | |||
| # SPDX-License-Identifier: AGPL-3.0-or-later | |||
| --- | |||
| - name: Fail if playbook called incorrectly | |||
| ansible.builtin.fail: | |||
| msg: "The `one_time` variable needs to be provided to this playbook, via --extra-vars" | |||
| when: "one_time is not defined or one_time not in ['yes', 'no']" | |||
| - name: Fail if playbook called incorrectly | |||
| ansible.builtin.fail: | |||
| msg: "The `ex_date` variable (expiration date) needs to be provided to this playbook, via --extra-vars" | |||
| when: "ex_date is not defined or ex_date == '<date>'" | |||
| - name: Call matrix-registration token creation API | |||
| ansible.builtin.uri: | |||
| url: "{{ matrix_registration_api_token_endpoint }}" | |||
| follow_redirects: none | |||
| validate_certs: "{{ matrix_registration_api_validate_certs }}" | |||
| headers: | |||
| Content-Type: application/json | |||
| Authorization: "SharedSecret {{ matrix_registration_admin_secret }}" | |||
| method: POST | |||
| body_format: json | |||
| body: | | |||
| { | |||
| "one_time": {{ 'true' if one_time == 'yes' else 'false' }}, | |||
| "ex_date": {{ ex_date | to_json }} | |||
| } | |||
| check_mode: false | |||
| register: matrix_registration_api_result | |||
| - ansible.builtin.set_fact: | |||
| matrix_registration_api_result_message: >- | |||
| matrix-registration result: | |||
| Direct registration link (with the token prefilled): | |||
| {{ matrix_registration_api_register_endpoint }}?token={{ matrix_registration_api_result.json.name }} | |||
| Full token details are: | |||
| {{ matrix_registration_api_result.json }} | |||
| check_mode: false | |||
| - name: Inject result message into devture_playbook_runtime_messages_list | |||
| ansible.builtin.set_fact: | |||
| devture_playbook_runtime_messages_list: | | |||
| {{ | |||
| devture_playbook_runtime_messages_list | default([]) | |||
| + | |||
| [matrix_registration_api_result_message] | |||
| }} | |||
| check_mode: false | |||
| @@ -1,37 +0,0 @@ | |||
| # SPDX-FileCopyrightText: 2021 MDAD project contributors | |||
| # SPDX-FileCopyrightText: 2022 Marko Weltzer | |||
| # SPDX-FileCopyrightText: 2022 Slavi Pantaleev | |||
| # | |||
| # SPDX-License-Identifier: AGPL-3.0-or-later | |||
| --- | |||
| - name: Call matrix-registration list all tokens API | |||
| ansible.builtin.uri: | |||
| url: "{{ matrix_registration_api_token_endpoint }}" | |||
| follow_redirects: none | |||
| validate_certs: "{{ matrix_registration_api_validate_certs }}" | |||
| headers: | |||
| Content-Type: application/json | |||
| Authorization: "SharedSecret {{ matrix_registration_admin_secret }}" | |||
| method: GET | |||
| body_format: json | |||
| check_mode: false | |||
| register: matrix_registration_api_result | |||
| - ansible.builtin.set_fact: | |||
| matrix_registration_api_result_message: >- | |||
| matrix-registration result: | |||
| {{ matrix_registration_api_result.json | to_nice_json }} | |||
| check_mode: false | |||
| - name: Inject result message into devture_playbook_runtime_messages_list | |||
| ansible.builtin.set_fact: | |||
| devture_playbook_runtime_messages_list: | | |||
| {{ | |||
| devture_playbook_runtime_messages_list | default([]) | |||
| + | |||
| [matrix_registration_api_result_message] | |||
| }} | |||
| check_mode: false | |||
| @@ -1,38 +0,0 @@ | |||
| # SPDX-FileCopyrightText: 2020 - 2024 Slavi Pantaleev | |||
| # SPDX-FileCopyrightText: 2021 MDAD project contributors | |||
| # SPDX-FileCopyrightText: 2022 Marko Weltzer | |||
| # | |||
| # SPDX-License-Identifier: AGPL-3.0-or-later | |||
| --- | |||
| - tags: | |||
| - setup-all | |||
| - setup-matrix-registration | |||
| - install-all | |||
| - install-matrix-registration | |||
| block: | |||
| - when: matrix_registration_enabled | bool | |||
| ansible.builtin.include_tasks: "{{ role_path }}/tasks/validate_config.yml" | |||
| - when: matrix_registration_enabled | bool | |||
| ansible.builtin.include_tasks: "{{ role_path }}/tasks/setup_install.yml" | |||
| - tags: | |||
| - setup-all | |||
| - setup-matrix-registration | |||
| block: | |||
| - when: not matrix_registration_enabled | bool | |||
| ansible.builtin.include_tasks: "{{ role_path }}/tasks/setup_uninstall.yml" | |||
| - tags: | |||
| - generate-matrix-registration-token | |||
| block: | |||
| - when: matrix_registration_enabled | bool | |||
| ansible.builtin.include_tasks: "{{ role_path }}/tasks/generate_token.yml" | |||
| - tags: | |||
| - list-matrix-registration-tokens | |||
| block: | |||
| - when: matrix_registration_enabled | bool | |||
| ansible.builtin.include_tasks: "{{ role_path }}/tasks/list_tokens.yml" | |||
| @@ -1,138 +0,0 @@ | |||
| # SPDX-FileCopyrightText: 2020 - 2024 Slavi Pantaleev | |||
| # SPDX-FileCopyrightText: 2020 Stuart Mumford | |||
| # SPDX-FileCopyrightText: 2022 Jim Myhrberg | |||
| # SPDX-FileCopyrightText: 2022 Marko Weltzer | |||
| # SPDX-FileCopyrightText: 2022 Nikita Chernyi | |||
| # SPDX-FileCopyrightText: 2022 Sebastian Gumprich | |||
| # SPDX-FileCopyrightText: 2024 David Mehren | |||
| # | |||
| # SPDX-License-Identifier: AGPL-3.0-or-later | |||
| --- | |||
| - ansible.builtin.set_fact: | |||
| matrix_registration_requires_restart: false | |||
| - when: "matrix_registration_database_engine == 'postgres'" | |||
| block: | |||
| - name: Check if an SQLite database already exists | |||
| ansible.builtin.stat: | |||
| path: "{{ matrix_registration_sqlite_database_path_local }}" | |||
| register: matrix_registration_sqlite_database_path_local_stat_result | |||
| - when: "matrix_registration_sqlite_database_path_local_stat_result.stat.exists | bool" | |||
| block: | |||
| - ansible.builtin.include_role: | |||
| name: galaxy/postgres | |||
| tasks_from: migrate_db_to_postgres | |||
| vars: | |||
| postgres_db_migration_request: | |||
| src: "{{ matrix_registration_sqlite_database_path_local }}" | |||
| dst: "{{ matrix_registration_database_connection_string }}" | |||
| caller: "{{ role_path | basename }}" | |||
| engine_variable_name: 'matrix_registration_database_engine' | |||
| engine_old: 'sqlite' | |||
| systemd_services_to_stop: ['matrix-registration.service'] | |||
| # pgloader makes `ex_date` of type `TIMESTAMP WITH TIMEZONE`, | |||
| # which makes matrix-registration choke on it later on when comparing dates. | |||
| additional_psql_statements_list: | |||
| - ALTER TABLE tokens ALTER COLUMN ex_date TYPE TIMESTAMP WITHOUT TIME ZONE; | |||
| additional_psql_statements_db_name: "{{ matrix_registration_database_name }}" | |||
| - ansible.builtin.set_fact: | |||
| matrix_registration_requires_restart: true | |||
| - name: Ensure matrix-registration paths exist | |||
| ansible.builtin.file: | |||
| path: "{{ item.path }}" | |||
| state: directory | |||
| mode: 0750 | |||
| owner: "{{ matrix_user_name }}" | |||
| group: "{{ matrix_group_name }}" | |||
| with_items: | |||
| - {path: "{{ matrix_registration_base_path }}", when: true} | |||
| - {path: "{{ matrix_registration_config_path }}", when: true} | |||
| - {path: "{{ matrix_registration_data_path }}", when: true} | |||
| - {path: "{{ matrix_registration_docker_src_files_path }}", when: "{{ matrix_registration_container_image_self_build }}"} | |||
| when: "item.when | bool" | |||
| - name: Ensure matrix-registration image is pulled | |||
| community.docker.docker_image: | |||
| name: "{{ matrix_registration_docker_image }}" | |||
| source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}" | |||
| force_source: "{{ matrix_registration_docker_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_registration_docker_image_force_pull }}" | |||
| when: "not matrix_registration_container_image_self_build | bool" | |||
| register: result | |||
| retries: "{{ devture_playbook_help_container_retries_count }}" | |||
| delay: "{{ devture_playbook_help_container_retries_delay }}" | |||
| until: result is not failed | |||
| - name: Ensure matrix-registration repository is present when self-building | |||
| ansible.builtin.git: | |||
| repo: "{{ matrix_registration_container_image_self_build_repo }}" | |||
| dest: "{{ matrix_registration_docker_src_files_path }}" | |||
| version: "{{ matrix_registration_container_image_self_build_branch }}" | |||
| force: "yes" | |||
| become: true | |||
| become_user: "{{ matrix_user_name }}" | |||
| register: matrix_registration_git_pull_results | |||
| when: "matrix_registration_container_image_self_build | bool" | |||
| # See: https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/1864 | |||
| - name: Patch setup.py to allow self-built version to work | |||
| ansible.builtin.lineinfile: | |||
| path: "{{ matrix_registration_docker_src_files_path }}/setup.py" | |||
| regexp: 'flask-limiter' | |||
| line: '"flask-limiter~=1.1.0", "Markupsafe<2.1",' | |||
| when: "matrix_registration_container_image_self_build | bool and matrix_registration_container_image_self_build_python_dependencies_patch_enabled | bool" | |||
| - name: Ensure matrix-registration Docker image is built | |||
| community.docker.docker_image: | |||
| name: "{{ matrix_registration_docker_image }}" | |||
| source: build | |||
| force_source: "{{ matrix_registration_git_pull_results.changed 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_registration_git_pull_results.changed }}" | |||
| build: | |||
| dockerfile: Dockerfile | |||
| path: "{{ matrix_registration_docker_src_files_path }}" | |||
| pull: true | |||
| when: "matrix_registration_container_image_self_build | bool" | |||
| - name: Ensure matrix-registration config installed | |||
| ansible.builtin.copy: | |||
| content: "{{ matrix_registration_configuration | to_nice_yaml(indent=2, width=999999) }}" | |||
| dest: "{{ matrix_registration_config_path }}/config.yaml" | |||
| mode: 0644 | |||
| owner: "{{ matrix_user_name }}" | |||
| group: "{{ matrix_group_name }}" | |||
| - name: Ensure matrix-registration support files installed | |||
| ansible.builtin.template: | |||
| src: "{{ role_path }}/templates/{{ item }}.j2" | |||
| dest: "{{ matrix_registration_base_path }}/{{ item }}" | |||
| mode: 0640 | |||
| owner: "{{ matrix_user_name }}" | |||
| group: "{{ matrix_group_name }}" | |||
| with_items: | |||
| - labels | |||
| - name: Ensure matrix-registration container network is created | |||
| community.general.docker_network: | |||
| enable_ipv6: "{{ devture_systemd_docker_base_ipv6_enabled }}" | |||
| name: "{{ matrix_registration_container_network }}" | |||
| driver: bridge | |||
| driver_options: "{{ devture_systemd_docker_base_container_networks_driver_options }}" | |||
| - name: Ensure matrix-registration.service installed | |||
| ansible.builtin.template: | |||
| src: "{{ role_path }}/templates/systemd/matrix-registration.service.j2" | |||
| dest: "{{ devture_systemd_docker_base_systemd_path }}/matrix-registration.service" | |||
| mode: 0644 | |||
| - name: Ensure matrix-registration.service restarted, if necessary | |||
| ansible.builtin.service: | |||
| name: "matrix-registration.service" | |||
| state: restarted | |||
| daemon_reload: true | |||
| when: "matrix_registration_requires_restart | bool" | |||
| @@ -1,26 +0,0 @@ | |||
| # SPDX-FileCopyrightText: 2020 - 2022 Slavi Pantaleev | |||
| # SPDX-FileCopyrightText: 2022 Marko Weltzer | |||
| # SPDX-FileCopyrightText: 2022 Sebastian Gumprich | |||
| # | |||
| # SPDX-License-Identifier: AGPL-3.0-or-later | |||
| --- | |||
| - name: Check existence of matrix-registration service | |||
| ansible.builtin.stat: | |||
| path: "{{ devture_systemd_docker_base_systemd_path }}/matrix-registration.service" | |||
| register: matrix_registration_service_stat | |||
| - when: matrix_registration_service_stat.stat.exists | bool | |||
| block: | |||
| - name: Ensure matrix-registration is stopped | |||
| ansible.builtin.service: | |||
| name: matrix-registration | |||
| state: stopped | |||
| enabled: false | |||
| daemon_reload: true | |||
| - name: Ensure matrix-registration.service doesn't exist | |||
| ansible.builtin.file: | |||
| path: "{{ devture_systemd_docker_base_systemd_path }}/matrix-registration.service" | |||
| state: absent | |||
| @@ -1,30 +0,0 @@ | |||
| # SPDX-FileCopyrightText: 2020 - 2024 Slavi Pantaleev | |||
| # SPDX-FileCopyrightText: 2025 Suguru Hirahara | |||
| # | |||
| # SPDX-License-Identifier: AGPL-3.0-or-later | |||
| --- | |||
| - name: Fail if required matrix-registration 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_registration_hostname', when: true} | |||
| - {'name': 'matrix_registration_path_prefix', when: true} | |||
| - {'name': 'matrix_registration_container_network', when: true} | |||
| - {'name': 'matrix_registration_shared_secret', when: true} | |||
| - {'name': 'matrix_registration_admin_secret', when: true} | |||
| - {'name': 'matrix_registration_server_location', when: true} | |||
| - {'name': 'matrix_registration_database_hostname', when: "{{ matrix_registration_database_engine == 'postgres' }}"} | |||
| - name: (Deprecation) Catch and report renamed settings | |||
| 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_registration_docker_repo', 'new': 'matrix_registration_container_image_self_build_repo'} | |||
| - {'old': 'matrix_registration_public_endpoint', 'new': 'matrix_registration_path_prefix'} | |||
| @@ -1,37 +0,0 @@ | |||
| {# | |||
| SPDX-FileCopyrightText: 2020 - 2022 Slavi Pantaleev | |||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||
| #} | |||
| server_location: {{ matrix_registration_server_location|to_json }} | |||
| server_name: {{ matrix_registration_server_name|to_json }} | |||
| shared_secret: {{ matrix_registration_shared_secret|to_json }} | |||
| admin_secret: {{ matrix_registration_admin_secret|to_json }} | |||
| riot_instance: {{ matrix_registration_riot_instance|to_json }} | |||
| db: {{ matrix_registration_db|to_json }} | |||
| host: '0.0.0.0' | |||
| port: 5000 | |||
| rate_limit: ["100 per day", "10 per minute"] | |||
| allow_cors: false | |||
| logging: | |||
| disable_existing_loggers: False | |||
| version: 1 | |||
| root: | |||
| level: DEBUG | |||
| handlers: [console] | |||
| formatters: | |||
| brief: | |||
| format: '%(name)s - %(levelname)s - %(message)s' | |||
| precise: | |||
| format: '%(asctime)s - %(name)s - %(levelname)s - %(message)s' | |||
| handlers: | |||
| console: | |||
| class: logging.StreamHandler | |||
| level: INFO | |||
| formatter: brief | |||
| stream: ext://sys.stdout | |||
| # password requirements | |||
| password: | |||
| min_length: 8 | |||
| base_url: {{ matrix_registration_base_url|to_json }} | |||
| @@ -1,69 +0,0 @@ | |||
| {# | |||
| SPDX-FileCopyrightText: 2024 Slavi Pantaleev | |||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||
| #} | |||
| {% if matrix_registration_container_labels_traefik_enabled %} | |||
| traefik.enable=true | |||
| {% if matrix_registration_container_labels_traefik_docker_network %} | |||
| traefik.docker.network={{ matrix_registration_container_labels_traefik_docker_network }} | |||
| {% endif %} | |||
| traefik.http.services.matrix-registration.loadbalancer.server.port=5000 | |||
| {% if matrix_registration_container_labels_public_endpoint_enabled %} | |||
| ############################################################ | |||
| # # | |||
| # Public (e.g. /matrix-registration) # | |||
| # # | |||
| ############################################################ | |||
| {% set middlewares = [] %} | |||
| {% if matrix_registration_path_prefix != '/' %} | |||
| traefik.http.middlewares.matrix-registration-slashless-redirect-slashless.redirectregex.regex=({{ matrix_registration_path_prefix | quote }})$ | |||
| traefik.http.middlewares.matrix-registration-slashless-redirect-slashless.redirectregex.replacement=${1}/ | |||
| {% set middlewares = middlewares + ['matrix-registration-slashless-redirect-slashless'] %} | |||
| {% endif %} | |||
| # matrix-registration serves nothing at the root URL, so we redirect to /register instead. | |||
| traefik.http.middlewares.matrix-registration-slashless-redirect-root.redirectregex.regex=({{ matrix_registration_path_prefix | quote }}{{ '' if matrix_registration_path_prefix == '/' else '/' }})$ | |||
| traefik.http.middlewares.matrix-registration-slashless-redirect-root.redirectregex.replacement=${1}register | |||
| {% set middlewares = middlewares + ['matrix-registration-slashless-redirect-root'] %} | |||
| {% if matrix_registration_path_prefix != '/' %} | |||
| traefik.http.middlewares.matrix-registration-strip-prefix.stripprefix.prefixes={{ matrix_registration_path_prefix }} | |||
| {% set middlewares = middlewares + ['matrix-registration-strip-prefix'] %} | |||
| {% endif %} | |||
| traefik.http.routers.matrix-registration-public.rule={{ matrix_registration_container_labels_public_endpoint_traefik_rule }} | |||
| {% if middlewares | length > 0 %} | |||
| traefik.http.routers.matrix-registration-public.middlewares={{ middlewares | join(',') }} | |||
| {% endif %} | |||
| {% if matrix_registration_container_labels_public_endpoint_traefik_priority | int > 0 %} | |||
| traefik.http.routers.matrix-registration-public.priority={{ matrix_registration_container_labels_public_endpoint_traefik_priority }} | |||
| {% endif %} | |||
| traefik.http.routers.matrix-registration-public.service=matrix-registration | |||
| traefik.http.routers.matrix-registration-public.entrypoints={{ matrix_registration_container_labels_public_endpoint_traefik_entrypoints }} | |||
| traefik.http.routers.matrix-registration-public.tls={{ matrix_registration_container_labels_public_endpoint_traefik_tls | to_json }} | |||
| {% if matrix_registration_container_labels_public_endpoint_traefik_tls %} | |||
| traefik.http.routers.matrix-registration-public.tls.certResolver={{ matrix_registration_container_labels_public_endpoint_traefik_tls_certResolver }} | |||
| {% endif %} | |||
| ############################################################ | |||
| # # | |||
| # /Public (e.g. /matrix-registration) # | |||
| # # | |||
| ############################################################ | |||
| {% endif %} | |||
| {% endif %} | |||
| {{ matrix_registration_container_labels_additional_labels }} | |||
| @@ -1,51 +0,0 @@ | |||
| #jinja2: lstrip_blocks: True | |||
| [Unit] | |||
| Description=matrix-registration | |||
| {% for service in matrix_registration_systemd_required_services_list %} | |||
| Requires={{ service }} | |||
| After={{ service }} | |||
| {% endfor %} | |||
| {% for service in matrix_registration_systemd_wanted_services_list %} | |||
| Wants={{ service }} | |||
| {% endfor %} | |||
| DefaultDependencies=no | |||
| [Service] | |||
| Type=simple | |||
| Environment="HOME={{ devture_systemd_docker_base_systemd_unit_home_path }}" | |||
| ExecStartPre=-{{ devture_systemd_docker_base_host_command_sh }} -c '{{ devture_systemd_docker_base_host_command_docker }} stop -t {{ devture_systemd_docker_base_container_stop_grace_time_seconds }} matrix-registration 2>/dev/null || true' | |||
| ExecStartPre=-{{ devture_systemd_docker_base_host_command_sh }} -c '{{ devture_systemd_docker_base_host_command_docker }} rm matrix-registration 2>/dev/null || true' | |||
| ExecStartPre={{ devture_systemd_docker_base_host_command_docker }} create \ | |||
| --rm \ | |||
| --name=matrix-registration \ | |||
| --log-driver=none \ | |||
| --user={{ matrix_user_uid }}:{{ matrix_user_gid }} \ | |||
| --cap-drop=ALL \ | |||
| --network={{ matrix_registration_container_network }} \ | |||
| {% if matrix_registration_container_http_host_bind_port %} | |||
| -p {{ matrix_registration_container_http_host_bind_port }}:5000 \ | |||
| {% endif %} | |||
| --mount type=bind,src={{ matrix_registration_config_path }},dst=/config,ro \ | |||
| --mount type=bind,src={{ matrix_registration_data_path }},dst=/data \ | |||
| --label-file={{ matrix_registration_base_path }}/labels \ | |||
| {% for arg in matrix_registration_container_extra_arguments %} | |||
| {{ arg }} \ | |||
| {% endfor %} | |||
| {{ matrix_registration_docker_image }} \ | |||
| serve | |||
| {% for network in matrix_registration_container_additional_networks %} | |||
| ExecStartPre={{ devture_systemd_docker_base_host_command_docker }} network connect {{ network }} matrix-registration | |||
| {% endfor %} | |||
| ExecStart={{ devture_systemd_docker_base_host_command_docker }} start --attach matrix-registration | |||
| ExecStop=-{{ devture_systemd_docker_base_host_command_sh }} -c '{{ devture_systemd_docker_base_host_command_docker }} stop -t {{ devture_systemd_docker_base_container_stop_grace_time_seconds }} matrix-registration 2>/dev/null || true' | |||
| ExecStop=-{{ devture_systemd_docker_base_host_command_sh }} -c '{{ devture_systemd_docker_base_host_command_docker }} rm matrix-registration 2>/dev/null || true' | |||
| Restart=always | |||
| RestartSec=30 | |||
| SyslogIdentifier=matrix-registration | |||
| [Install] | |||
| WantedBy=multi-user.target | |||
| @@ -1,3 +0,0 @@ | |||
| SPDX-FileCopyrightText: 2020 Slavi Pantaleev | |||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||