Add a role to install 'ntfy' push-notification server.

This commit adds a 'matrix-ntfy' role that runs Ntfy server in Docker with
simple configuration, and plumbing to add the role to the playbook.

TODO: documentation, self-check, database persistence.

roles/matrix-ntfy/README.md

@@ -0,0 +1,40 @@
+# A role to install the [ntfy](https://ntfy.sh) push-notification server.
+
+The ntfy server and clients implement self-hosted support push notifications
+from Matrix (and other) servers to Android (and other) clients, using the
+[UnifiedPush](https://unifiedpush.org) standard.
+
+This role installs ntfy server in Docker.  It is intended to support push
+notifications, via UnifiedPush, from the Matrix and Matrix-related services
+that are installed alongside it to any clients that support UnifiedPush.
+
+This role is not intended to support other features of the ntfy server and
+clients.
+
+
+# Using the ntfy role
+
+Configure the role by adding settings in your Ansible inventory.
+
+The only required setting is to enable ntfy:
+
+    matrix_ntfy_enabled: true
+
+The default domain for ntfy is `ntfy.<matrix_domain>`.  This can be changed
+with the `matrix_server_fqn_ntfy` variable:
+
+    matrix_server_fqn_ntfy: "my-ntfy.{{ matrix_domain }}"
+
+Other ntfy settings can be configured by adding extra arguments to the
+docker run command, e.g.:
+
+    matrix_ntfy_container_extra_arguments:
+      - '--env=NTFY_LOG_LEVEL=DEBUG'
+
+
+# TODO
+
+- Documentation.
+- Self-check.
+- Mount the ntfy database to disk so subscriptions persist across restarts.
+- Authentication?

roles/matrix-ntfy/defaults/main.yml

@@ -0,0 +1,16 @@
+---
+matrix_ntfy_enabled: true
+
+matrix_ntfy_base_path: "{{ matrix_base_data_path }}/ntfy"
+
+matrix_ntfy_version: v1.27.2
+matrix_ntfy_docker_image: "{{ matrix_container_global_registry_prefix }}binwiederhier/ntfy:{{ matrix_ntfy_version }}"
+matrix_ntfy_docker_image_force_pull: "{{ matrix_ntfy_docker_image.endswith(':latest') }}"
+
+# Controls whether the container exposes its HTTP port (tcp/8080 in the container).
+#
+# Takes an "<ip>:<port>" or "<port>" value (e.g. "127.0.0.1:8768"), or empty string to not expose.
+matrix_ntfy_container_http_host_bind_port: ''
+
+# A list of extra arguments to pass to the container
+matrix_ntfy_container_extra_arguments: []

roles/matrix-ntfy/tasks/init.yml

@@ -0,0 +1,5 @@
+---
+
+- set_fact:
+    matrix_systemd_services_list: "{{ matrix_systemd_services_list + ['matrix-ntfy.service'] }}"
+  when: matrix_ntfy_enabled|bool

roles/matrix-ntfy/tasks/main.yml

@@ -0,0 +1,10 @@
+---
+
+- import_tasks: "{{ role_path }}/tasks/init.yml"
+  tags:
+    - always
+
+- import_tasks: "{{ role_path }}/tasks/setup.yml"
+  tags:
+    - setup-all
+    - setup-ntfy

roles/matrix-ntfy/tasks/setup.yml

@@ -0,0 +1,58 @@
+---
+#
+# Tasks related to setting up matrix-ntfy
+#
+
+- name: Ensure matrix-ntfy image is pulled
+  docker_image:
+    name: "{{ matrix_ntfy_docker_image }}"
+    source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}"
+    force_source: "{{ matrix_ntfy_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_ntfy_docker_image_force_pull }}"
+  when: "matrix_ntfy_enabled|bool"
+  register: result
+  retries: "{{ matrix_container_retries_count }}"
+  delay: "{{ matrix_container_retries_delay }}"
+  until: result is not failed
+
+- name: Ensure matrix-ntfy.service installed
+  template:
+    src: "{{ role_path }}/templates/systemd/matrix-ntfy.service.j2"
+    dest: "{{ matrix_systemd_path }}/matrix-ntfy.service"
+    mode: 0644
+  register: matrix_ntfy_systemd_service_result
+  when: matrix_ntfy_enabled|bool
+
+- name: Ensure systemd reloaded after matrix-ntfy.service installation
+  service:
+    daemon_reload: true
+  when: "matrix_ntfy_enabled|bool and matrix_ntfy_systemd_service_result.changed"
+
+#
+# Tasks related to getting rid of matrix-ntfy (if it was previously enabled)
+#
+
+- name: Check existence of matrix-ntfy service
+  stat:
+    path: "{{ matrix_systemd_path }}/matrix-ntfy.service"
+  register: matrix_ntfy_service_stat
+
+- name: Ensure matrix-ntfy is stopped
+  service:
+    name: matrix-ntfy
+    state: stopped
+    enabled: false
+    daemon_reload: true
+  register: stopping_result
+  when: "not matrix_ntfy_enabled|bool and matrix_ntfy_service_stat.stat.exists"
+
+- name: Ensure matrix-ntfy.service doesn't exist
+  file:
+    path: "{{ matrix_systemd_path }}/matrix-ntfy.service"
+    state: absent
+  when: "not matrix_ntfy_enabled|bool and matrix_ntfy_service_stat.stat.exists"
+
+- name: Ensure systemd reloaded after matrix-ntfy.service removal
+  service:
+    daemon_reload: true
+  when: "not matrix_ntfy_enabled|bool and matrix_ntfy_service_stat.stat.exists"

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

@@ -0,0 +1,37 @@
+#jinja2: lstrip_blocks: "True"
+[Unit]
+Description=matrix-ntfy
+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-ntfy 2>/dev/null || true'
+ExecStartPre=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-ntfy 2>/dev/null || true'
+
+ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-ntfy \
+			--log-driver=none \
+			--user={{ matrix_user_uid }}:{{ matrix_user_gid }} \
+			--cap-drop=ALL \
+			--read-only \
+			{% for arg in matrix_ntfy_container_extra_arguments %}
+			{{ arg }} \
+			{% endfor %}
+			--network={{ matrix_docker_network }} \
+			{% if matrix_ntfy_container_http_host_bind_port %}
+			-p {{ matrix_ntfy_container_http_host_bind_port }}:80 \
+			{% endif %}
+			--env NTFY_BASE_URL=https://{{ matrix_server_fqn_ntfy }} \
+			{{ matrix_ntfy_docker_image }} \
+			serve --behind-proxy
+
+ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-ntfy 2>/dev/null || true'
+ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-ntfy 2>/dev/null || true'
+Restart=always
+RestartSec=30
+SyslogIdentifier=matrix-ntfy
+
+[Install]
+WantedBy=multi-user.target