sync with previous repo

roles/matrix-mailer/defaults/main.yml

@@ -0,0 +1,31 @@
+matrix_mailer_enabled: true
+
+matrix_mailer_base_path: "{{ matrix_base_data_path }}/mailer"
+
+matrix_mailer_container_image_self_build: false
+matrix_mailer_container_image_self_build_repository_url: "https://github.com/devture/exim-relay"
+matrix_mailer_container_image_self_build_src_files_path: "{{ matrix_mailer_base_path }}/docker-src"
+matrix_mailer_container_image_self_build_version: "{{ matrix_mailer_docker_image.split(':')[1] }}"
+
+matrix_mailer_version: 4.94.2-r0-2
+matrix_mailer_docker_image: "{{ matrix_mailer_docker_image_name_prefix }}devture/exim-relay:{{ matrix_mailer_version }}"
+matrix_mailer_docker_image_name_prefix: "{{ 'localhost/' if matrix_mailer_container_image_self_build else matrix_container_global_registry_prefix }}"
+matrix_mailer_docker_image_force_pull: "{{ matrix_mailer_docker_image.endswith(':latest') }}"
+
+# The user/group that the container runs with.
+# These match the `exim` user/group within the container image.
+matrix_mailer_container_user_uid: 100
+matrix_mailer_container_user_gid: 101
+
+# A list of extra arguments to pass to the container
+matrix_mailer_container_extra_arguments: []
+
+matrix_mailer_hostname: "{{ matrix_server_fqn_matrix }}"
+
+matrix_mailer_sender_address: "matrix@{{ matrix_domain }}"
+matrix_mailer_relay_use: false
+matrix_mailer_relay_host_name: "mail.example.com"
+matrix_mailer_relay_host_port: 587
+matrix_mailer_relay_auth: false
+matrix_mailer_relay_auth_username: ""
+matrix_mailer_relay_auth_password: ""

roles/matrix-mailer/tasks/init.yml

@@ -0,0 +1,10 @@
+# See https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/1070
+# and https://github.com/spantaleev/matrix-docker-ansible-deploy/commit/1ab507349c752042d26def3e95884f6df8886b74#commitcomment-51108407
+- name: Fail if trying to self-build on Ansible < 2.8
+  fail:
+    msg: "To self-build the Element image, you should use Ansible 2.8 or higher. See docs/ansible.md"
+  when: "ansible_version.major == 2 and ansible_version.minor < 8 and matrix_mailer_container_image_self_build and matrix_mailer_enabled"
+
+- set_fact:
+    matrix_systemd_services_list: "{{ matrix_systemd_services_list + ['matrix-mailer.service'] }}"
+  when: matrix_mailer_enabled|bool

roles/matrix-mailer/tasks/main.yml

@@ -0,0 +1,9 @@
+- import_tasks: "{{ role_path }}/tasks/init.yml"
+  tags:
+    - always
+
+- import_tasks: "{{ role_path }}/tasks/setup_mailer.yml"
+  when: run_setup|bool
+  tags:
+    - setup-all
+    - setup-mailer

roles/matrix-mailer/tasks/setup_mailer.yml

@@ -0,0 +1,107 @@
+---
+
+#
+# Tasks related to setting up the mailer
+#
+
+- name: Ensure mailer base path exists
+  file:
+    path: "{{ item.path }}"
+    state: directory
+    mode: 0750
+    owner: "{{ matrix_user_username }}"
+    group: "{{ matrix_user_groupname }}"
+  with_items:
+    - { path: "{{ matrix_mailer_base_path }}", when: true }
+    - { path: "{{ matrix_mailer_container_image_self_build_src_files_path }}", when: "{{ matrix_mailer_container_image_self_build }}" }
+  when: "matrix_mailer_enabled|bool and item.when"
+
+- name: Ensure mailer environment variables file created
+  template:
+    src: "{{ role_path }}/templates/env-mailer.j2"
+    dest: "{{ matrix_mailer_base_path }}/env-mailer"
+    mode: 0640
+  when: matrix_mailer_enabled|bool
+
+- name: Ensure exim-relay repository is present on self-build
+  git:
+    repo: "{{ matrix_mailer_container_image_self_build_repository_url }}"
+    dest: "{{ matrix_mailer_container_image_self_build_src_files_path }}"
+    version: "{{ matrix_mailer_container_image_self_build_version }}"
+    force: "yes"
+  register: matrix_mailer_git_pull_results
+  when: "matrix_mailer_enabled|bool and matrix_mailer_container_image_self_build|bool"
+
+- name: Ensure exim-relay Docker image is built
+  docker_image:
+    name: "{{ matrix_mailer_docker_image }}"
+    source: build
+    force_source: "{{ matrix_mailer_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_mailer_git_pull_results.changed }}"
+    build:
+      dockerfile: Dockerfile
+      path: "{{ matrix_mailer_container_image_self_build_src_files_path }}"
+      pull: yes
+  when: "matrix_mailer_enabled|bool and matrix_mailer_container_image_self_build|bool"
+
+- name: Ensure exim-relay image is pulled
+  docker_image:
+    name: "{{ matrix_mailer_docker_image }}"
+    source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}"
+    force_source: "{{ matrix_mailer_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_mailer_docker_image_force_pull }}"
+  when: "matrix_mailer_enabled|bool and not matrix_mailer_container_image_self_build|bool"
+
+- name: Ensure matrix-mailer.service installed
+  template:
+    src: "{{ role_path }}/templates/systemd/matrix-mailer.service.j2"
+    dest: "{{ matrix_systemd_path }}/matrix-mailer.service"
+    mode: 0644
+  register: matrix_mailer_systemd_service_result
+  when: matrix_mailer_enabled|bool
+
+- name: Ensure systemd reloaded after matrix-mailer.service installation
+  service:
+    daemon_reload: yes
+  when: "matrix_mailer_enabled|bool and matrix_mailer_systemd_service_result.changed"
+
+#
+# Tasks related to getting rid of the mailer (if it was previously enabled)
+#
+
+- name: Check existence of matrix-mailer service
+  stat:
+    path: "{{ matrix_systemd_path }}/matrix-mailer.service"
+  register: matrix_mailer_service_stat
+  when: "not matrix_mailer_enabled|bool"
+
+- name: Ensure matrix-mailer is stopped
+  service:
+    name: matrix-mailer
+    state: stopped
+    daemon_reload: yes
+  register: stopping_result
+  when: "not matrix_mailer_enabled|bool and matrix_mailer_service_stat.stat.exists"
+
+- name: Ensure matrix-mailer.service doesn't exist
+  file:
+    path: "{{ matrix_systemd_path }}/matrix-mailer.service"
+    state: absent
+  when: "not matrix_mailer_enabled|bool and matrix_mailer_service_stat.stat.exists"
+
+- name: Ensure systemd reloaded after matrix-mailer.service removal
+  service:
+    daemon_reload: yes
+  when: "not matrix_mailer_enabled|bool and matrix_mailer_service_stat.stat.exists"
+
+- name: Ensure Matrix mailer environment variables path doesn't exist
+  file:
+    path: "{{ matrix_mailer_base_path }}"
+    state: absent
+  when: "not matrix_mailer_enabled|bool"
+
+- name: Ensure mailer Docker image doesn't exist
+  docker_image:
+    name: "{{ matrix_mailer_docker_image }}"
+    state: absent
+  when: "not matrix_mailer_enabled|bool"

roles/matrix-mailer/templates/env-mailer.j2

@@ -0,0 +1,9 @@
+#jinja2: lstrip_blocks: "True"
+{% if matrix_mailer_relay_use %}
+SMARTHOST={{ matrix_mailer_relay_host_name }}::{{ matrix_mailer_relay_host_port }}
+{% endif %}
+{% if matrix_mailer_relay_auth %}
+SMTP_USERNAME={{ matrix_mailer_relay_auth_username }}
+SMTP_PASSWORD={{ matrix_mailer_relay_auth_password }}
+{% endif %}
+HOSTNAME={{ matrix_mailer_hostname }}

roles/matrix-mailer/templates/systemd/matrix-mailer.service.j2

@@ -0,0 +1,37 @@
+#jinja2: lstrip_blocks: "True"
+[Unit]
+Description=Matrix mailer
+After=docker.service
+Requires=docker.service
+DefaultDependencies=no
+
+[Service]
+Type=simple
+Environment="HOME={{ matrix_systemd_unit_home_path }}"
+ExecStartPre=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-mailer 2>/dev/null'
+ExecStartPre=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-mailer 2>/dev/null'
+
+# --hostname gives us a friendlier hostname than the default.
+# The real hostname is passed via a `HOSTNAME` environment variable though.
+ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-mailer \
+			--log-driver=none \
+			--user={{ matrix_mailer_container_user_uid }}:{{ matrix_mailer_container_user_gid }} \
+			--cap-drop=ALL \
+			--read-only \
+			--tmpfs=/var/spool/exim:rw,noexec,nosuid,size=100m \
+			--network={{ matrix_docker_network }} \
+			--env-file={{ matrix_mailer_base_path }}/env-mailer \
+			--hostname=matrix-mailer \
+			{% for arg in matrix_mailer_container_extra_arguments %}
+			{{ arg }} \
+			{% endfor %}
+			{{ matrix_mailer_docker_image }}
+
+ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-mailer 2>/dev/null'
+ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-mailer 2>/dev/null'
+Restart=always
+RestartSec=30
+SyslogIdentifier=matrix-mailer
+
+[Install]
+WantedBy=multi-user.target