mirror of
				https://github.com/spantaleev/matrix-docker-ansible-deploy.git
				synced 2025-10-30 14:57:57 +01:00 
			
		
		
		
	added mautrix-signal role
This commit is contained in:
		
							
								
								
									
										102
									
								
								roles/matrix-bridge-mautrix-signal/defaults/main.yml
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										102
									
								
								roles/matrix-bridge-mautrix-signal/defaults/main.yml
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,102 @@ | ||||
| # mautrix-telegram is a Matrix <-> Telegram bridge | ||||
| # See: https://github.com/tulir/mautrix-telegram | ||||
|  | ||||
| matrix_mautrix_signal_enabled: false | ||||
|  | ||||
| # See: https://mau.dev/tulir/mautrix-signal/container_registry | ||||
| matrix_mautrix_signal_docker_image: "dock.mau.dev/tulir/mautrix-signal:latest" | ||||
| matrix_mautrix_signal_docker_image_force_pull: "{{ matrix_mautrix_signal_docker_image.endswith(':latest') }}" | ||||
|  | ||||
| matrix_mautrix_signal_base_path: "{{ matrix_base_data_path }}/mautrix-signal" | ||||
| matrix_mautrix_signal_config_path: "{{ matrix_mautrix_signal_base_path }}/bridge" | ||||
|  | ||||
| matrix_mautrix_signal_daemon_docker_image: "dock.mau.dev/maunium/signald:latest" | ||||
| matrix_mautrix_signal_daemon_docker_image_force_pull: "{{ matrix_mautrix_signal_daemon_docker_image.endswith(':latest') }}" | ||||
|  | ||||
| matrix_mautrix_signal_daemon_path: "{{ matrix_mautrix_signal_base_path }}/signald" | ||||
|  | ||||
| # # Get your own API keys at https://my.telegram.org/apps | ||||
| # matrix_mautrix_telegram_api_id: '' | ||||
| # matrix_mautrix_telegram_api_hash: '' | ||||
| # matrix_mautrix_telegram_bot_token: disabled | ||||
|  | ||||
| # # Mautrix telegram public endpoint to log in to telegram | ||||
| # # Use an uuid so it's not easily discoverable. | ||||
| # # Example: /741a0483-ba17-4682-9900-30bd7269f1cc | ||||
| # matrix_mautrix_telegram_public_endpoint: '' | ||||
|  | ||||
| matrix_mautrix_signal_homeserver_address: 'http://matrix-synapse:8008' | ||||
| matrix_mautrix_signal_homeserver_domain: '{{ matrix_domain }}' | ||||
| matrix_mautrix_signal_appservice_address: 'http://matrix-mautrix-signal:29328' | ||||
| # matrix_mautrix_telegram_appservice_public_external: 'https://{{ matrix_server_fqn_matrix }}{{ matrix_mautrix_telegram_public_endpoint }}' | ||||
|  | ||||
| # Controls whether the matrix-mautrix-telegram container exposes its HTTP port (tcp/8080 in the container). | ||||
| # | ||||
| # Takes an "<ip>:<port>" or "<port>" value (e.g. "127.0.0.1:9006"), or empty string to not expose. | ||||
| matrix_mautrix_signal_container_http_host_bind_port: '' | ||||
|  | ||||
| # A list of extra arguments to pass to the container | ||||
| matrix_mautrix_signal_container_extra_arguments: [] | ||||
|  | ||||
| # List of systemd services that matrix-mautrix-signal.service depends on. | ||||
| matrix_mautrix_signal_systemd_required_services_list: ['docker.service', 'matrix-mautrix-signal-daemon.service', 'matrix-mautrix-signal-db.service'] | ||||
|  | ||||
| # List of systemd services that matrix-mautrix-telegram.service wants | ||||
| matrix_mautrix_signal_systemd_wanted_services_list: [] | ||||
|  | ||||
| matrix_mautrix_signal_appservice_token: '' | ||||
| matrix_mautrix_signal_homeserver_token: '' | ||||
|  | ||||
| matrix_mautrix_signal_db_docker_image: "postgres:13.0-alpine" | ||||
| matrix_mautrix_signal_db_docker_image_force_pull: "{{ matrix_mautrix_signal_db_docker_image.endswith(':latest') }}" | ||||
| matrix_mautrix_signal_db_storage_path: "{{ matrix_mautrix_signal_base_path }}/database" | ||||
|  | ||||
| matrix_mautrix_signal_db_user: '' | ||||
| matrix_mautrix_signal_db_password: '' | ||||
| matrix_mautrix_signal_db_host: 'matrix-mautrix-signal-db' | ||||
| matrix_mautrix_signal_db_port: '5432' | ||||
| matrix_mautrix_signal_db_database: '' | ||||
|  | ||||
| matrix_mautrix_signal_db_url: "postgres://{{ matrix_mautrix_signal_db_user }}:{{ matrix_mautrix_signal_db_password }}@{{ matrix_mautrix_signal_db_host }}:{{ matrix_mautrix_signal_db_port }}/{{ matrix_mautrix_signal_db_database }}" | ||||
|  | ||||
| # Can be set to enable automatic double-puppeting via Shared Secret Auth (https://github.com/devture/matrix-synapse-shared-secret-auth). | ||||
| matrix_mautrix_signal_login_shared_secret: '' | ||||
|  | ||||
| # Default 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_mautrix_telegram_configuration_extension_yaml`) | ||||
| # or completely replace this variable with your own template. | ||||
| matrix_mautrix_signal_configuration_yaml: "{{ lookup('template', 'templates/config.yaml.j2') }}" | ||||
|  | ||||
| matrix_mautrix_signal_configuration_extension_yaml: | | ||||
|   # Your custom YAML configuration goes here. | ||||
|   # This configuration extends the default starting configuration (`matrix_mautrix_telegram_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_mautrix_telegram_configuration_yaml`. | ||||
|  | ||||
| matrix_mautrix_signal_configuration_extension: "{{ matrix_mautrix_signal_configuration_extension_yaml|from_yaml if matrix_mautrix_signal_configuration_extension_yaml|from_yaml is mapping else {} }}" | ||||
|  | ||||
| # Holds the final configuration (a combination of the default and its extension). | ||||
| # You most likely don't need to touch this variable. Instead, see `matrix_mautrix_telegram_configuration_yaml`. | ||||
| matrix_mautrix_signal_configuration: "{{ matrix_mautrix_signal_configuration_yaml|from_yaml|combine(matrix_mautrix_signal_configuration_extension, recursive=True) }}" | ||||
|  | ||||
| matrix_mautrix_signal_registration_yaml: | | ||||
|   id: signal | ||||
|   as_token: "{{ matrix_mautrix_signal_appservice_token }}" | ||||
|   hs_token: "{{ matrix_mautrix_signal_homeserver_token }}" | ||||
|   namespaces: | ||||
|       users: | ||||
|       - exclusive: true | ||||
|         regex: '^@signal_.+:{{ matrix_mautrix_signal_homeserver_domain|regex_escape }}$' | ||||
|       aliases: | ||||
|       - exclusive: true | ||||
|         regex: '^#signal_.+:{{ matrix_mautrix_signal_homeserver_domain|regex_escape }}$' | ||||
|   url: {{ matrix_mautrix_signal_appservice_address }} | ||||
|   sender_localpart: signalbot | ||||
|   rate_limited: false | ||||
|  | ||||
| matrix_mautrix_signal_registration: "{{ matrix_mautrix_signal_registration_yaml|from_yaml }}" | ||||
							
								
								
									
										63
									
								
								roles/matrix-bridge-mautrix-signal/tasks/init.yml
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										63
									
								
								roles/matrix-bridge-mautrix-signal/tasks/init.yml
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,63 @@ | ||||
| - set_fact: | ||||
|     matrix_systemd_services_list: "{{ matrix_systemd_services_list + ['matrix-mautrix-signal', 'matrix-mautrix-signal-daemon'] }}" | ||||
|   when: matrix_mautrix_signal_enabled|bool | ||||
|  | ||||
| # If the matrix-synapse role is not used, these variables may not exist. | ||||
| - set_fact: | ||||
|     matrix_synapse_container_extra_arguments: > | ||||
|       {{ matrix_synapse_container_extra_arguments|default([]) }} | ||||
|       + | ||||
|       ["--mount type=bind,src={{ matrix_mautrix_signal_config_path }}/registration.yaml,dst=/matrix-mautrix-signal-registration.yaml,ro"] | ||||
|  | ||||
|     matrix_synapse_app_service_config_files: > | ||||
|       {{ matrix_synapse_app_service_config_files|default([]) }} | ||||
|       + | ||||
|       {{ ["/matrix-mautrix-signal-registration.yaml"] }} | ||||
|   when: matrix_mautrix_signal_enabled|bool | ||||
|  | ||||
| # - block: | ||||
| #   - name: Fail if matrix-nginx-proxy role already executed | ||||
| #     fail: | ||||
| #       msg: >- | ||||
| #         Trying to append Mautrix Signal's reverse-proxying configuration to matrix-nginx-proxy, | ||||
| #         but it's pointless since the matrix-nginx-proxy role had already executed. | ||||
| #         To fix this, please change the order of roles in your plabook, | ||||
| #         so that the matrix-nginx-proxy role would run after the matrix-bridge-mautrix-signal role. | ||||
| #     when: matrix_nginx_proxy_role_executed|default(False)|bool | ||||
|  | ||||
|   # - name: Generate Mautrix Signal proxying configuration for matrix-nginx-proxy | ||||
|   #   set_fact: | ||||
|   #     matrix_mautrix_telegram_matrix_nginx_proxy_configuration: | | ||||
|   #       location {{ matrix_mautrix_telegram_public_endpoint }} { | ||||
|   #       {% if matrix_nginx_proxy_enabled|default(False) %} | ||||
|   #       	{# Use the embedded DNS resolver in Docker containers to discover the service #} | ||||
|   #       	resolver 127.0.0.11 valid=5s; | ||||
|   #       	set $backend "matrix-mautrix-telegram:8080"; | ||||
|   #       	proxy_pass http://$backend; | ||||
|   #       {% else %} | ||||
|   #       	{# Generic configuration for use outside of our container setup #} | ||||
|   #       	proxy_pass http://127.0.0.1:9006; | ||||
|   #       {% endif %} | ||||
|   #       } | ||||
|  | ||||
|   # - name: Register Mautrix Telegram proxying configuration with matrix-nginx-proxy | ||||
|   #   set_fact: | ||||
|   #     matrix_nginx_proxy_proxy_matrix_additional_server_configuration_blocks: | | ||||
|   #       {{ | ||||
|   #         matrix_nginx_proxy_proxy_matrix_additional_server_configuration_blocks|default([]) | ||||
|   #         + | ||||
|   #         [matrix_mautrix_telegram_matrix_nginx_proxy_configuration] | ||||
|   #       }} | ||||
|   # tags: | ||||
|   #  - always | ||||
|   # when: matrix_mautrix_telegram_enabled|bool | ||||
|  | ||||
| # - name: Warn about reverse-proxying if matrix-nginx-proxy not used | ||||
| #   debug: | ||||
| #     msg: >- | ||||
| #       NOTE: You've enabled the Mautrix Telegram bridge but are not using the matrix-nginx-proxy | ||||
| #       reverse proxy. | ||||
| #       Please make sure that you're proxying the `{{ matrix_mautrix_telegram_public_endpoint }}` | ||||
| #       URL endpoint to the matrix-mautrix-telegram container. | ||||
| #       You can expose the container's port using the `matrix_mautrix_telegram_container_http_host_bind_port` variable. | ||||
| #   when: "matrix_mautrix_telegram_enabled|bool and matrix_nginx_proxy_enabled is not defined" | ||||
							
								
								
									
										21
									
								
								roles/matrix-bridge-mautrix-signal/tasks/main.yml
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										21
									
								
								roles/matrix-bridge-mautrix-signal/tasks/main.yml
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,21 @@ | ||||
| - import_tasks: "{{ role_path }}/tasks/init.yml" | ||||
|   tags: | ||||
|     - always | ||||
|  | ||||
| - import_tasks: "{{ role_path }}/tasks/validate_config.yml" | ||||
|   when: "run_setup|bool and matrix_mautrix_signal_enabled|bool" | ||||
|   tags: | ||||
|     - setup-all | ||||
|     - setup-mautrix-signal | ||||
|  | ||||
| - import_tasks: "{{ role_path }}/tasks/setup_install.yml" | ||||
|   when: "run_setup|bool and matrix_mautrix_signal_enabled|bool" | ||||
|   tags: | ||||
|     - setup-all | ||||
|     - setup-mautrix-signal | ||||
|  | ||||
| - import_tasks: "{{ role_path }}/tasks/setup_uninstall.yml" | ||||
|   when: "run_setup|bool and not matrix_mautrix_signal_enabled|bool" | ||||
|   tags: | ||||
|     - setup-all | ||||
|     - setup-mautrix-signal | ||||
							
								
								
									
										102
									
								
								roles/matrix-bridge-mautrix-signal/tasks/setup_install.yml
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										102
									
								
								roles/matrix-bridge-mautrix-signal/tasks/setup_install.yml
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,102 @@ | ||||
| --- | ||||
|  | ||||
| # If the matrix-synapse role is not used, `matrix_synapse_role_executed` won't exist. | ||||
| # We don't want to fail in such cases. | ||||
| - name: Fail if matrix-synapse role already executed | ||||
|   fail: | ||||
|     msg: >- | ||||
|       The matrix-bridge-mautrix-signal role needs to execute before the matrix-synapse role. | ||||
|   when: "matrix_synapse_role_executed|default(False)" | ||||
|  | ||||
| - name: Ensure Mautrix Signal image is pulled | ||||
|   docker_image: | ||||
|     name: "{{ matrix_mautrix_signal_docker_image }}" | ||||
|     source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}" | ||||
|     force_source: "{{ matrix_mautrix_signal_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_mautrix_signal_docker_image_force_pull }}" | ||||
|  | ||||
| - name: Ensure Mautrix Signal Daemon image is pulled | ||||
|   docker_image: | ||||
|     name: "{{ matrix_mautrix_signal_daemon_docker_image }}" | ||||
|     source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}" | ||||
|     force_source: "{{ matrix_mautrix_signal_daemon_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_mautrix_signal_docker_image_force_pull }}" | ||||
|  | ||||
| - name: Ensure Mautrix Signal database image is pulled | ||||
|   docker_image: | ||||
|     name: "{{ matrix_mautrix_signal_db_docker_image }}" | ||||
|     source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}" | ||||
|     force_source: "{{ matrix_mautrix_signal_db_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_mautrix_signal_docker_image_force_pull }}" | ||||
|  | ||||
| - name: Ensure Mautrix Signal paths exist | ||||
|   file: | ||||
|     path: "{{ item }}" | ||||
|     state: directory | ||||
|     mode: 0750 | ||||
|     owner: "{{ matrix_user_username }}" | ||||
|     group: "{{ matrix_user_groupname }}" | ||||
|   with_items: | ||||
|     - "{{ matrix_mautrix_signal_base_path }}" | ||||
|     - "{{ matrix_mautrix_signal_config_path }}" | ||||
|     - "{{ matrix_mautrix_signal_daemon_path }}" | ||||
|     - "{{ matrix_mautrix_signal_db_storage_path }}" | ||||
|  | ||||
| # - name: Check if an old database file already exists | ||||
| #   stat: | ||||
| #     path: "{{ matrix_mautrix_telegram_base_path }}/mautrix-telegram.db" | ||||
| #   register: matrix_mautrix_telegram_stat_database | ||||
| # | ||||
| # - name: (Data relocation) Ensure matrix-mautrix-telegram.service is stopped | ||||
| #   service: | ||||
| #     name: matrix-mautrix-telegram | ||||
| #     state: stopped | ||||
| #     daemon_reload: yes | ||||
| #   failed_when: false | ||||
| #   when: "matrix_mautrix_telegram_stat_database.stat.exists" | ||||
| # | ||||
| # - name: (Data relocation) Move mautrix-telegram database file to ./data directory | ||||
| #   command: "mv {{ matrix_mautrix_telegram_base_path }}/mautrix-telegram.db {{ matrix_mautrix_telegram_data_path }}/mautrix-telegram.db" | ||||
| #   when: "matrix_mautrix_telegram_stat_database.stat.exists" | ||||
|  | ||||
| - name: Ensure mautrix-signal config.yaml installed | ||||
|   copy: | ||||
|     content: "{{ matrix_mautrix_signal_configuration|to_nice_yaml }}" | ||||
|     dest: "{{ matrix_mautrix_signal_config_path }}/config.yaml" | ||||
|     mode: 0644 | ||||
|     owner: "{{ matrix_user_username }}" | ||||
|     group: "{{ matrix_user_groupname }}" | ||||
|  | ||||
| - name: Ensure mautrix-signal registration.yaml installed | ||||
|   copy: | ||||
|     content: "{{ matrix_mautrix_signal_registration|to_nice_yaml }}" | ||||
|     dest: "{{ matrix_mautrix_signal_config_path }}/registration.yaml" | ||||
|     mode: 0644 | ||||
|     owner: "{{ matrix_user_username }}" | ||||
|     group: "{{ matrix_user_groupname }}" | ||||
|  | ||||
| - name: Ensure matrix-mautrix-signal-daemon.service installed | ||||
|   template: | ||||
|     src: "{{ role_path }}/templates/systemd/matrix-mautrix-signal-daemon.service.j2" | ||||
|     dest: "{{ matrix_systemd_path }}/matrix-mautrix-signal-daemon.service" | ||||
|     mode: 0644 | ||||
|   register: matrix_mautrix_signal_daemon_systemd_service_result | ||||
|  | ||||
| - name: Ensure matrix-mautrix-signal-db.service installed | ||||
|   template: | ||||
|     src: "{{ role_path }}/templates/systemd/matrix-mautrix-signal-db.service.j2" | ||||
|     dest: "{{ matrix_systemd_path }}/matrix-mautrix-signal-db.service" | ||||
|     mode: 0644 | ||||
|   register: matrix_mautrix_signal_db_systemd_service_result | ||||
|  | ||||
| - name: Ensure matrix-mautrix-signal.service installed | ||||
|   template: | ||||
|     src: "{{ role_path }}/templates/systemd/matrix-mautrix-signal.service.j2" | ||||
|     dest: "{{ matrix_systemd_path }}/matrix-mautrix-signal.service" | ||||
|     mode: 0644 | ||||
|   register: matrix_mautrix_signal_systemd_service_result | ||||
|  | ||||
| - name: Ensure systemd reloaded after matrix-mautrix-signal.service installation | ||||
|   service: | ||||
|     daemon_reload: yes | ||||
|   when: "matrix_mautrix_signal_systemd_service_result.changed or matrix_mautrix_signal_daemon_systemd_service_result.changed or matrix_mautrix_signal_db_systemd_service_result.changed" | ||||
							
								
								
									
										64
									
								
								roles/matrix-bridge-mautrix-signal/tasks/setup_uninstall.yml
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										64
									
								
								roles/matrix-bridge-mautrix-signal/tasks/setup_uninstall.yml
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,64 @@ | ||||
| --- | ||||
|  | ||||
| # Signal database service | ||||
| - name: Check existence of matrix-mautrix-signal-db service | ||||
|   stat: | ||||
|     path: "{{ matrix_systemd_path }}/matrix-mautrix-signal-db.service" | ||||
|   register: matrix_mautrix_signal_db_service_stat | ||||
|  | ||||
| - name: Ensure matrix-mautrix-signal-db is stopped | ||||
|   service: | ||||
|     name: matrix-mautrix-signal-db | ||||
|     state: stopped | ||||
|     daemon_reload: yes | ||||
|   when: "matrix_mautrix_signal_db_service_stat.stat.exists" | ||||
|  | ||||
| - name: Ensure matrix-mautrix-signal-db.service doesn't exist | ||||
|   file: | ||||
|     path: "{{ matrix_systemd_path }}/matrix-mautrix-signal-db.service" | ||||
|     state: absent | ||||
|   when: "matrix_mautrix_signal_db_service_stat.stat.exists" | ||||
|  | ||||
| # Signal daemon service | ||||
| - name: Check existence of matrix-mautrix-signal-daemon service | ||||
|   stat: | ||||
|     path: "{{ matrix_systemd_path }}/matrix-mautrix-signal-daemon.service" | ||||
|   register: matrix_mautrix_signal_daemon_service_stat | ||||
|  | ||||
| - name: Ensure matrix-mautrix-signal-daemon is stopped | ||||
|   service: | ||||
|     name: matrix-mautrix-signal-daemon | ||||
|     state: stopped | ||||
|     daemon_reload: yes | ||||
|   when: "matrix_mautrix_signal_daemon_service_stat.stat.exists" | ||||
|  | ||||
| - name: Ensure matrix-mautrix-signal-daemon.service doesn't exist | ||||
|   file: | ||||
|     path: "{{ matrix_systemd_path }}/matrix-mautrix-signal-daemon.service" | ||||
|     state: absent | ||||
|   when: "matrix_mautrix_signal_daemon_service_stat.stat.exists" | ||||
|  | ||||
| # Bridge service | ||||
| - name: Check existence of matrix-mautrix-signal service | ||||
|   stat: | ||||
|     path: "{{ matrix_systemd_path }}/matrix-mautrix-signal.service" | ||||
|   register: matrix_mautrix_signal_service_stat | ||||
|  | ||||
| - name: Ensure matrix-mautrix-signal is stopped | ||||
|   service: | ||||
|     name: matrix-mautrix-signal | ||||
|     state: stopped | ||||
|     daemon_reload: yes | ||||
|   when: "matrix_mautrix_signal_service_stat.stat.exists" | ||||
|  | ||||
| - name: Ensure matrix-mautrix-signal.service doesn't exist | ||||
|   file: | ||||
|     path: "{{ matrix_systemd_path }}/matrix-mautrix-signal.service" | ||||
|     state: absent | ||||
|   when: "matrix_mautrix_signal_service_stat.stat.exists" | ||||
|  | ||||
| # All services | ||||
| - name: Ensure systemd reloaded after matrix-mautrix-signal_X.service removal | ||||
|   service: | ||||
|     daemon_reload: yes | ||||
|   when: "matrix_mautrix_signal_service_stat.stat.exists or matrix_mautrix_signal_daemon_service_stat.stat.exists or matrix_mautrix_signal_db_service_stat.stat.exists" | ||||
							
								
								
									
										22
									
								
								roles/matrix-bridge-mautrix-signal/tasks/validate_config.yml
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										22
									
								
								roles/matrix-bridge-mautrix-signal/tasks/validate_config.yml
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,22 @@ | ||||
| --- | ||||
|  | ||||
| - name: Fail if required settings not defined | ||||
|   fail: | ||||
|     msg: >- | ||||
|       You need to define a required configuration setting (`{{ item }}`). | ||||
|   when: "vars[item] == ''" | ||||
|   with_items: | ||||
|     - "matrix_mautrix_signal_appservice_token" | ||||
|     - "matrix_mautrix_signal_homeserver_token" | ||||
|     - "matrix_mautrix_signal_db_user" | ||||
|     - "matrix_mautrix_signal_db_password" | ||||
|     - "matrix_mautrix_signal_db_database" | ||||
|  | ||||
| - name: (Deprecation) Catch and report renamed Signal variables | ||||
|   fail: | ||||
|     msg: >- | ||||
|       Your configuration contains a variable, which now has a different name. | ||||
|       Please change your configuration to rename the variable (`{{ item.old }}` -> `{{ item.new }}`). | ||||
|   when: "item.old in vars" | ||||
|   with_items: | ||||
|     - {'old': 'matrix_mautrix_signal_container_exposed_port_number', 'new': '<superseded by matrix_mautrix_signal_container_http_host_bind_port>'} | ||||
							
								
								
									
										207
									
								
								roles/matrix-bridge-mautrix-signal/templates/config.yaml.j2
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										207
									
								
								roles/matrix-bridge-mautrix-signal/templates/config.yaml.j2
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,207 @@ | ||||
| #jinja2: lstrip_blocks: "True" | ||||
| # Homeserver details | ||||
| homeserver: | ||||
|     # The address that this appservice can use to connect to the homeserver. | ||||
|     address: {{ matrix_mautrix_signal_homeserver_address }} | ||||
|     # The domain of the homeserver (for MXIDs, etc). | ||||
|     domain: {{ matrix_mautrix_signal_homeserver_domain }} | ||||
|     # Whether or not to verify the SSL certificate of the homeserver. | ||||
|     # Only applies if address starts with https:// | ||||
|     verify_ssl: true | ||||
|     asmux: false | ||||
|  | ||||
| # Application service host/registration related details | ||||
| # Changing these values requires regeneration of the registration. | ||||
| appservice: | ||||
|     # The address that the homeserver can use to connect to this appservice. | ||||
|     address: {{ matrix_mautrix_signal_appservice_address }} | ||||
|     # When using https:// the TLS certificate and key files for the address. | ||||
|     tls_cert: false | ||||
|     tls_key: false | ||||
|  | ||||
|     # The hostname and port where this appservice should listen. | ||||
|     hostname: 0.0.0.0 | ||||
|     port: 29328 | ||||
|     # The maximum body size of appservice API requests (from the homeserver) in mebibytes | ||||
|     # Usually 1 is enough, but on high-traffic bridges you might need to increase this to avoid 413s | ||||
|     max_body_size: 1 | ||||
|  | ||||
|     # The full URI to the database. Only Postgres is currently supported. | ||||
|     database: {{ matrix_mautrix_signal_db_url }} | ||||
|  | ||||
|     # Provisioning API part of the web server for automated portal creation and fetching information. | ||||
|     # Used by things like mautrix-manager (https://github.com/tulir/mautrix-manager). | ||||
|     provisioning: | ||||
|         # Whether or not the provisioning API should be enabled. | ||||
|         enabled: true | ||||
|         # The prefix to use in the provisioning API endpoints. | ||||
|         prefix: /_matrix/provision/v1 | ||||
|         # The shared secret to authorize users of the API. | ||||
|         # Set to "generate" to generate and save a new token. | ||||
|         shared_secret: generate | ||||
|  | ||||
|     # The unique ID of this appservice. | ||||
|     id: signal | ||||
|     # Username of the appservice bot. | ||||
|     bot_username: signalbot | ||||
|     # Display name and avatar for bot. Set to "remove" to remove display name/avatar, leave empty | ||||
|     # to leave display name/avatar as-is. | ||||
|     bot_displayname: Signal bridge bot | ||||
|     bot_avatar: mxc://maunium.net/wPJgTQbZOtpBFmDNkiNEMDUp | ||||
|  | ||||
|     # Community ID for bridged users (changes registration file) and rooms. | ||||
|     # Must be created manually. | ||||
|     # | ||||
|     # Example: "+signal:example.com". Set to false to disable. | ||||
|     community_id: false | ||||
|  | ||||
|     # Authentication tokens for AS <-> HS communication. | ||||
|     as_token: "{{ matrix_mautrix_signal_appservice_token }}" | ||||
|     hs_token: "{{ matrix_mautrix_signal_homeserver_token }}" | ||||
|  | ||||
| # Prometheus telemetry config. Requires prometheus-client to be installed. | ||||
| metrics: | ||||
|     enabled: false | ||||
|     listen_port: 8000 | ||||
|  | ||||
| signal: | ||||
|     # Path to signald unix socket | ||||
|     socket_path: /signald/signald.sock | ||||
|     # Directory for temp files when sending files to Signal. This should be an | ||||
|     # absolute path that signald can read. For attachments in the other direction, | ||||
|     # make sure signald is configured to use an absolute path as the data directory. | ||||
|     outgoing_attachment_dir: /signald/attachments | ||||
|     # Directory where signald stores avatars for groups. | ||||
|     avatar_dir: /signald/avatars | ||||
|     # Whether or not message attachments should be removed from disk after they're bridged. | ||||
|     remove_file_after_handling: true | ||||
|  | ||||
| # Bridge config | ||||
| bridge: | ||||
|     # Localpart template of MXIDs for Signal users. | ||||
|     # {userid} is replaced with an identifier for the Signal user. | ||||
|     username_template: "signal_{userid}" | ||||
|     # Displayname template for Signal users. | ||||
|     # {displayname} is replaced with the displayname of the Signal user, which is the first | ||||
|     # available variable in displayname_preference. The variables in displayname_preference | ||||
|     # can also be used here directly. | ||||
|     displayname_template: "{displayname} (Signal)" | ||||
|     # Whether or not contact list displaynames should be used. | ||||
|     # Using this isn't recommended on multi-user instances. | ||||
|     allow_contact_list_name_updates: false | ||||
|     # Available variables: full_name, first_name, last_name, phone, uuid | ||||
|     displayname_preference: | ||||
|     - full_name | ||||
|     - phone | ||||
|  | ||||
|     # Whether or not to create portals for all groups on login/connect. | ||||
|     autocreate_group_portal: true | ||||
|     # Whether or not to create portals for all contacts on login/connect. | ||||
|     autocreate_contact_portal: false | ||||
|     # Whether or not to use /sync to get read receipts and typing notifications | ||||
|     # when double puppeting is enabled | ||||
|     sync_with_custom_puppets: true | ||||
|     # Whether or not to update the m.direct account data event when double puppeting is enabled. | ||||
|     # Note that updating the m.direct event is not atomic (except with mautrix-asmux) | ||||
|     # and is therefore prone to race conditions. | ||||
|     sync_direct_chat_list: false | ||||
|     # Allow using double puppeting from any server with a valid client .well-known file. | ||||
|     double_puppet_allow_discovery: false | ||||
|     # Servers to allow double puppeting from, even if double_puppet_allow_discovery is false. | ||||
|     double_puppet_server_map: {} | ||||
|     # Shared secret for https://github.com/devture/matrix-synapse-shared-secret-auth | ||||
|     # | ||||
|     # If set, custom puppets will be enabled automatically for local users | ||||
|     # instead of users having to find an access token and run `login-matrix` | ||||
|     # manually. | ||||
|     # If using this for other servers than the bridge's server, | ||||
|     # you must also set the URL in the double_puppet_server_map. | ||||
|     login_shared_secret_map: | ||||
|         {{ matrix_mautrix_signal_homeserver_domain }}: {{ matrix_mautrix_signal_login_shared_secret|to_json }} | ||||
|     # Whether or not created rooms should have federation enabled. | ||||
|     # If false, created portal rooms will never be federated. | ||||
|     federate_rooms: true | ||||
|     # End-to-bridge encryption support options. These require matrix-nio to be installed with pip | ||||
|     # and login_shared_secret to be configured in order to get a device for the bridge bot. | ||||
|     # | ||||
|     # Additionally, https://github.com/matrix-org/synapse/pull/5758 is required if using a normal | ||||
|     # application service. | ||||
|     encryption: | ||||
|         # Allow encryption, work in group chat rooms with e2ee enabled | ||||
|         allow: false | ||||
|         # Default to encryption, force-enable encryption in all portals the bridge creates | ||||
|         # This will cause the bridge bot to be in private chats for the encryption to work properly. | ||||
|         default: false | ||||
|         # Options for automatic key sharing. | ||||
|         key_sharing: | ||||
|             # Enable key sharing? If enabled, key requests for rooms where users are in will be fulfilled. | ||||
|             # You must use a client that supports requesting keys from other users to use this feature. | ||||
|             allow: false | ||||
|             # Require the requesting device to have a valid cross-signing signature? | ||||
|             # This doesn't require that the bridge has verified the device, only that the user has verified it. | ||||
|             # Not yet implemented. | ||||
|             require_cross_signing: false | ||||
|             # Require devices to be verified by the bridge? | ||||
|             # Verification by the bridge is not yet implemented. | ||||
|             require_verification: true | ||||
|     # Whether or not to explicitly set the avatar and room name for private | ||||
|     # chat portal rooms. This will be implicitly enabled if encryption.default is true. | ||||
|     private_chat_portal_meta: false | ||||
|     # Whether or not the bridge should send a read receipt from the bridge bot when a message has | ||||
|     # been sent to Signal. This let's you check manually whether the bridge is receiving your | ||||
|     # messages. | ||||
|     # Note that this is not related to Signal delivery receipts. | ||||
|     delivery_receipts: false | ||||
|     # Whether or not delivery errors should be reported as messages in the Matrix room. (not yet implemented) | ||||
|     delivery_error_reports: false | ||||
|     # Set this to true to tell the bridge to re-send m.bridge events to all rooms on the next run. | ||||
|     # This field will automatically be changed back to false after it, | ||||
|     # except if the config file is not writable. | ||||
|     resend_bridge_info: false | ||||
|  | ||||
|     # The prefix for commands. Only required in non-management rooms. | ||||
|     command_prefix: "!signal" | ||||
|  | ||||
|     # Permissions for using the bridge. | ||||
|     # Permitted values: | ||||
|     #       user - Use the bridge with puppeting. | ||||
|     #      admin - Use and administrate the bridge. | ||||
|     # Permitted keys: | ||||
|     #        * - All Matrix users | ||||
|     #   domain - All users on that homeserver | ||||
|     #     mxid - Specific user | ||||
|     permissions: | ||||
|         "1m.at": "user" | ||||
|         "@admin:1m.at": "admin" | ||||
|  | ||||
|  | ||||
| # Python logging configuration. | ||||
| # | ||||
| # See section 16.7.2 of the Python documentation for more info: | ||||
| # https://docs.python.org/3.6/library/logging.config.html#configuration-dictionary-schema | ||||
| logging: | ||||
|     version: 1 | ||||
|     formatters: | ||||
|         colored: | ||||
|             (): mautrix_signal.util.ColorFormatter | ||||
|             format: "[%(asctime)s] [%(levelname)s@%(name)s] %(message)s" | ||||
|         normal: | ||||
|             format: "[%(asctime)s] [%(levelname)s@%(name)s] %(message)s" | ||||
|     handlers: | ||||
|         file: | ||||
|             class: logging.handlers.RotatingFileHandler | ||||
|             formatter: normal | ||||
|             filename: ./mautrix-signal.log | ||||
|             maxBytes: 10485760 | ||||
|             backupCount: 10 | ||||
|         console: | ||||
|             class: logging.StreamHandler | ||||
|             formatter: colored | ||||
|     loggers: | ||||
|         mau: | ||||
|             level: DEBUG | ||||
|         aiohttp: | ||||
|             level: INFO | ||||
|     root: | ||||
|         level: DEBUG | ||||
|         handlers: [file, console] | ||||
| @@ -0,0 +1,29 @@ | ||||
| #jinja2: lstrip_blocks: "True" | ||||
| [Unit] | ||||
| Description=Matrix Mautrix Signal daemon | ||||
|  | ||||
| [Service] | ||||
| Type=simple | ||||
|  | ||||
| ExecStartPre=-{{ matrix_host_command_docker }} kill matrix-mautrix-signal-daemon | ||||
| ExecStartPre=-{{ matrix_host_command_docker }} rm matrix-mautrix-signal-daemon | ||||
|  | ||||
| # Intentional delay, so that the homeserver (we likely depend on) can manage to start. | ||||
| ExecStartPre={{ matrix_host_command_sleep }} 5 | ||||
|  | ||||
| ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-mautrix-signal-daemon \ | ||||
| 			--log-driver=none \ | ||||
| 			--user={{ matrix_user_uid }}:{{ matrix_user_gid }} \ | ||||
| 			--network={{ matrix_docker_network }} \ | ||||
| 			-v {{ matrix_mautrix_signal_daemon_path }}:/signald:z \ | ||||
| 			{{ matrix_mautrix_signal_daemon_docker_image }} | ||||
|  | ||||
| ExecStop=-{{ matrix_host_command_docker }} kill matrix-mautrix-signal-daemon | ||||
| ExecStop=-{{ matrix_host_command_docker }} rm matrix-mautrix-signal-daemon | ||||
|  | ||||
| Restart=always | ||||
| RestartSec=30 | ||||
| SyslogIdentifier=matrix-mautrix-signal-daemon | ||||
|  | ||||
| [Install] | ||||
| WantedBy=multi-user.target | ||||
| @@ -0,0 +1,32 @@ | ||||
| #jinja2: lstrip_blocks: "True" | ||||
| [Unit] | ||||
| Description=Matrix Mautrix Signal database server | ||||
|  | ||||
| [Service] | ||||
| Type=simple | ||||
|  | ||||
| ExecStartPre=-{{ matrix_host_command_docker }} kill {{ matrix_mautrix_signal_db_host }} | ||||
| ExecStartPre=-{{ matrix_host_command_docker }} rm {{ matrix_mautrix_signal_db_host }} | ||||
|  | ||||
| # Intentional delay, so that the homeserver (we likely depend on) can manage to start. | ||||
| ExecStartPre={{ matrix_host_command_sleep }} 5 | ||||
|  | ||||
| ExecStart={{ matrix_host_command_docker }} run --rm --name {{ matrix_mautrix_signal_db_host }} \ | ||||
| 			--log-driver=none \ | ||||
| 			--user={{ matrix_user_uid }}:{{ matrix_user_gid }} \ | ||||
| 			--network={{ matrix_docker_network }} \ | ||||
| 			--env POSTGRES_USER={{ matrix_mautrix_signal_db_user }} \ | ||||
| 			--env POSTGRES_PASSWORD={{ matrix_mautrix_signal_db_password }} \ | ||||
| 			--env POSTGRES_DB={{ matrix_mautrix_signal_db_database }} \ | ||||
| 			-v {{ matrix_mautrix_signal_db_storage_path }}:/var/lib/postgresql/data:z \ | ||||
| 			{{ matrix_mautrix_signal_db_docker_image }} | ||||
|  | ||||
| ExecStop=-{{ matrix_host_command_docker }} kill {{ matrix_mautrix_signal_db_host }} | ||||
| ExecStop=-{{ matrix_host_command_docker }} rm {{ matrix_mautrix_signal_db_host }} | ||||
|  | ||||
| Restart=always | ||||
| RestartSec=30 | ||||
| SyslogIdentifier=matrix-mautrix-signal-db | ||||
|  | ||||
| [Install] | ||||
| WantedBy=multi-user.target | ||||
| @@ -0,0 +1,44 @@ | ||||
| #jinja2: lstrip_blocks: "True" | ||||
| [Unit] | ||||
| Description=Matrix Mautrix Signal server | ||||
|  | ||||
| {% for service in matrix_mautrix_signal_systemd_required_services_list %} | ||||
| Requires={{ service }} | ||||
| After={{ service }} | ||||
| {% endfor %} | ||||
|  | ||||
| {% for service in matrix_mautrix_signal_systemd_wanted_services_list %} | ||||
| Wants={{ service }} | ||||
| {% endfor %} | ||||
|  | ||||
| [Service] | ||||
| Type=simple | ||||
| ExecStartPre=-{{ matrix_host_command_docker }} kill matrix-mautrix-signal | ||||
| ExecStartPre=-{{ matrix_host_command_docker }} rm matrix-mautrix-signal | ||||
|  | ||||
| # Intentional delay, so that the homeserver (we likely depend on) can manage to start. | ||||
| ExecStartPre={{ matrix_host_command_sleep }} 5 | ||||
|  | ||||
| ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-mautrix-signal \ | ||||
| 			--log-driver=none \ | ||||
| 			--network={{ matrix_docker_network }} \ | ||||
| 			{% if matrix_mautrix_signal_container_http_host_bind_port %} | ||||
| 			-p {{ matrix_mautrix_signal_container_http_host_bind_port }}:29328 \ | ||||
| 			{% endif %} | ||||
| 			-v {{ matrix_mautrix_signal_daemon_path }}:/signald:z \ | ||||
| 			-v {{ matrix_mautrix_signal_config_path }}:/data:z \ | ||||
| 			{% for arg in matrix_mautrix_signal_container_extra_arguments %} | ||||
| 			{{ arg }} \ | ||||
| 			{% endfor %} | ||||
| 			{{ matrix_mautrix_signal_docker_image }} \ | ||||
| 			python3 -m mautrix_signal -c /data/config.yaml | ||||
|  | ||||
| ExecStop=-{{ matrix_host_command_docker }} kill matrix-mautrix-signal | ||||
| ExecStop=-{{ matrix_host_command_docker }} rm matrix-mautrix-signal | ||||
|  | ||||
| Restart=always | ||||
| RestartSec=30 | ||||
| SyslogIdentifier=matrix-mautrix-signal | ||||
|  | ||||
| [Install] | ||||
| WantedBy=multi-user.target | ||||
		Reference in New Issue
	
	Block a user