added matrix-client-cinny

roles/matrix-client-cinny/defaults/main.yml

@@ -0,0 +1,54 @@
+matrix_client_cinny_enabled: true
+
+matrix_client_cinny_container_image_self_build: false
+matrix_client_cinny_container_image_self_build_repo: "https://github.com/ajbura/cinny.git"
+
+matrix_client_cinny_version: v1.6.1
+matrix_client_cinny_docker_image: "{{ matrix_client_cinny_docker_image_name_prefix }}ajbura/cinny:{{ matrix_client_cinny_version }}"
+matrix_client_cinny_docker_image_name_prefix: "{{ 'localhost/' if matrix_client_cinny_container_image_self_build }}"
+matrix_client_cinny_docker_image_force_pull: "{{ matrix_client_cinny_docker_image.endswith(':latest') }}"
+
+matrix_client_cinny_data_path: "{{ matrix_base_data_path }}/client-cinny"
+matrix_client_cinny_docker_src_files_path: "{{ matrix_client_cinny_data_path }}/docker-src"
+
+# 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_client_cinny_container_http_host_bind_port: ''
+
+# A list of extra arguments to pass to the container
+matrix_client_cinny_container_extra_arguments: []
+
+# List of systemd services that matrix-client-cinny.service depends on
+matrix_client_cinny_systemd_required_services_list: ['docker.service']
+
+# Controls whether the self-check feature should validate SSL certificates.
+matrix_client_cinny_self_check_validate_certificates: true
+
+# config.json
+matrix_client_cinny_default_hs_url: ""
+
+# Default cinny 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_client_cinny_configuration_extension_json`)
+# or completely replace this variable with your own template.
+#
+# The side-effect of this lookup is that Ansible would even parse the JSON for us, returning a dict.
+# This is unlike what it does when looking up YAML template files (no automatic parsing there).
+matrix_client_cinny_configuration_default: "{{ lookup('template', 'templates/config.json.j2') }}"
+
+# Your custom JSON configuration for cinny should go to `matrix_client_cinny_configuration_extension_json`.
+# This configuration extends the default starting configuration (`matrix_client_cinny_configuration_default`).
+#
+# 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_client_cinny_configuration_default`.
+matrix_client_cinny_configuration_extension_json: '{}'
+
+matrix_client_cinny_configuration_extension: "{{ matrix_client_cinny_configuration_extension_json|from_json if matrix_client_cinny_configuration_extension_json|from_json is mapping else {} }}"
+
+# Holds the final cinny configuration (a combination of the default and its extension).
+# You most likely don't need to touch this variable. Instead, see `matrix_client_cinny_configuration_default`.
+matrix_client_cinny_configuration: "{{ matrix_client_cinny_configuration_default|combine(matrix_client_cinny_configuration_extension, recursive=True) }}"

roles/matrix-client-cinny/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 Cinny 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_client_cinny_container_image_self_build and matrix_client_cinny_enabled"
+
+- set_fact:
+    matrix_systemd_services_list: "{{ matrix_systemd_services_list + ['matrix-client-cinny.service'] }}"
+  when: matrix_client_cinny_enabled|bool

roles/matrix-client-cinny/tasks/main.yml

@@ -0,0 +1,28 @@
+- import_tasks: "{{ role_path }}/tasks/init.yml"
+  tags:
+    - always
+
+- import_tasks: "{{ role_path }}/tasks/validate_config.yml"
+  when: "run_setup|bool and matrix_client_cinny_enabled|bool"
+  tags:
+    - setup-all
+    - setup-client-cinny
+
+- import_tasks: "{{ role_path }}/tasks/setup_install.yml"
+  when: "run_setup|bool and matrix_client_cinny_enabled|bool"
+  tags:
+    - setup-all
+    - setup-client-cinny
+
+- import_tasks: "{{ role_path }}/tasks/self_check.yml"
+  delegate_to: 127.0.0.1
+  become: false
+  when: "run_self_check|bool and matrix_client_cinny_enabled|bool"
+  tags:
+    - self-check
+
+- import_tasks: "{{ role_path }}/tasks/setup_uninstall.yml"
+  when: "run_setup|bool and not matrix_client_cinny_enabled|bool"
+  tags:
+    - setup-all
+    - setup-client-cinny

roles/matrix-client-cinny/tasks/self_check.yml

@@ -0,0 +1,22 @@
+---
+
+- set_fact:
+    matrix_client_cinny_url_endpoint_public: "https://{{ matrix_server_fqn_cinny }}/config.json"
+
+- name: Check Cinny
+  uri:
+    url: "{{ matrix_client_cinny_url_endpoint_public }}"
+    follow_redirects: none
+    validate_certs: "{{ matrix_client_cinny_self_check_validate_certificates }}"
+  register: matrix_client_cinny_self_check_result
+  check_mode: no
+  ignore_errors: true
+
+- name: Fail if Cinny not working
+  fail:
+    msg: "Failed checking Cinny is up at `{{ matrix_server_fqn_cinny }}` (checked endpoint: `{{ matrix_client_cinny_url_endpoint_public }}`). Is Cinny running? Is port 443 open in your firewall? Full error: {{ matrix_client_cinny_self_check_result }}"
+  when: "matrix_client_cinny_self_check_result.failed or 'json' not in matrix_client_cinny_self_check_result"
+
+- name: Report working Cinny
+  debug:
+    msg: "Cinny at `{{ matrix_server_fqn_cinny }}` is working (checked endpoint: `{{ matrix_client_cinny_url_endpoint_public }}`)"

roles/matrix-client-cinny/tasks/setup_install.yml

@@ -0,0 +1,71 @@
+---
+- name: Ensure Cinny paths exists
+  file:
+    path: "{{ item.path }}"
+    state: directory
+    mode: 0750
+    owner: "{{ matrix_user_username }}"
+    group: "{{ matrix_user_groupname }}"
+  with_items:
+    - { path: "{{ matrix_client_cinny_data_path }}", when: true }
+    - { path: "{{ matrix_client_cinny_docker_src_files_path }}", when: "{{ matrix_client_cinny_container_image_self_build }}" }
+  when: "item.when|bool"
+
+- name: Ensure Cinny Docker image is pulled
+  docker_image:
+   name: "{{ matrix_client_cinny_docker_image }}"
+   source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}"
+   force_source: "{{ matrix_client_cinny_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_client_cinny_docker_image_force_pull }}"
+  when: "not matrix_client_cinny_container_image_self_build|bool"
+
+- name: Ensure Cinny repository is present on self-build
+  git:
+    repo: "{{ matrix_client_cinny_container_image_self_build_repo }}"
+    dest: "{{ matrix_client_cinny_docker_src_files_path }}"
+    version: "{{ matrix_client_cinny_docker_image.split(':')[1] }}"
+    force: "yes"
+  register: matrix_client_cinny_git_pull_results
+  when: "matrix_client_cinny_container_image_self_build|bool"
+
+- name: Ensure Cinny configuration installed
+  copy:
+    content: "{{ matrix_client_cinny_configuration|to_nice_json }}"
+    dest: "{{ matrix_client_cinny_data_path }}/config.json"
+    mode: 0644
+    owner: "{{ matrix_user_username }}"
+    group: "{{ matrix_user_groupname }}"
+
+- name: Ensure Cinny additional config files installed
+  template:
+    src: "{{ item.src }}"
+    dest: "{{ matrix_client_cinny_data_path }}/{{ item.name }}"
+    mode: 0644
+    owner: "{{ matrix_user_username }}"
+    group: "{{ matrix_user_groupname }}"
+  with_items:
+    - {src: "{{ role_path }}/templates/nginx.conf.j2", name: "nginx.conf"}
+  when: "item.src is not none"
+
+- name: Ensure Cinny Docker image is built
+  docker_image:
+    name: "{{ matrix_client_cinny_docker_image }}"
+    source: build
+    force_source: "{{ matrix_client_cinny_git_pull_results.changed }}"
+    build:
+      dockerfile: Dockerfile
+      path: "{{ matrix_client_cinny_docker_src_files_path }}"
+      pull: yes
+  when: "matrix_client_cinny_container_image_self_build|bool"
+
+- name: Ensure matrix-client-cinny.service installed
+  template:
+    src: "{{ role_path }}/templates/systemd/matrix-client-cinny.service.j2"
+    dest: "{{ matrix_systemd_path }}/matrix-client-cinny.service"
+    mode: 0644
+  register: matrix_client_cinny_systemd_service_result
+
+- name: Ensure systemd reloaded after matrix-client-cinny.service installation
+  service:
+    daemon_reload: yes
+  when: "matrix_client_cinny_systemd_service_result.changed|bool"

roles/matrix-client-cinny/tasks/setup_uninstall.yml

@@ -0,0 +1,35 @@
+---
+- name: Check existence of matrix-client-cinny.service
+  stat:
+    path: "{{ matrix_systemd_path }}/matrix-client-cinny.service"
+  register: matrix_client_cinny_service_stat
+
+- name: Ensure matrix-client-cinny is stopped
+  service:
+    name: matrix-client-cinny
+    state: stopped
+    enabled: no
+    daemon_reload: yes
+  register: stopping_result
+  when: "matrix_client_cinny_service_stat.stat.exists|bool"
+
+- name: Ensure matrix-client-cinny.service doesn't exist
+  file:
+    path: "{{ matrix_systemd_path }}/matrix-client-cinny.service"
+    state: absent
+  when: "matrix_client_cinny_service_stat.stat.exists|bool"
+
+- name: Ensure systemd reloaded after matrix-client-cinny.service removal
+  service:
+    daemon_reload: yes
+  when: "matrix_client_cinny_service_stat.stat.exists|bool"
+
+- name: Ensure Cinny paths doesn't exist
+  file:
+    path: "{{ matrix_client_cinny_data_path }}"
+    state: absent
+
+- name: Ensure Cinny Docker image doesn't exist
+  docker_image:
+    name: "{{ matrix_client_cinny_docker_image }}"
+    state: absent

roles/matrix-client-cinny/tasks/validate_config.yml

@@ -0,0 +1,8 @@
+---
+- name: Fail if required Cinny settings not defined
+  fail:
+    msg: >
+      You need to define a required configuration setting (`{{ item }}`) to use Cinny.
+  when: "(vars[item] == '' or vars[item] is none) and matrix_client_cinny_container_image_self_build|bool"
+  with_items:
+    - "matrix_client_cinny_default_hs_url"

roles/matrix-client-cinny/templates/config.json.j2

@@ -0,0 +1,6 @@
+{
+  "defaultHomeserver": 0,
+  "homeserverList": [
+    {{ matrix_client_cinny_default_hs_url|string|to_json }}
+  ]
+}

roles/matrix-client-cinny/templates/nginx.conf.j2

@@ -0,0 +1,66 @@
+#jinja2: lstrip_blocks: "True"
+# This is a custom nginx configuration file that we use in the container (instead of the default one),
+# because it allows us to run nginx with a non-root user.
+#
+# For this to work, the default vhost file (`/etc/nginx/conf.d/default.conf`) also needs to be removed.
+# (mounting `/dev/null` over `/etc/nginx/conf.d/default.conf` works well)
+#
+# The following changes have been done compared to a default nginx configuration file:
+# - default server port is changed (80 -> 8080), so that a non-root user can bind it
+# - various temp paths are changed to `/tmp`, so that a non-root user can write to them
+# - the `user` directive was removed, as we don't want nginx to switch users
+
+worker_processes 1;
+
+error_log /var/log/nginx/error.log warn;
+pid /tmp/nginx.pid;
+
+
+events {
+	worker_connections 1024;
+}
+
+
+http {
+	proxy_temp_path /tmp/proxy_temp;
+	client_body_temp_path /tmp/client_temp;
+	fastcgi_temp_path /tmp/fastcgi_temp;
+	uwsgi_temp_path /tmp/uwsgi_temp;
+	scgi_temp_path /tmp/scgi_temp;
+
+	include /etc/nginx/mime.types;
+	default_type application/octet-stream;
+
+	log_format main '$remote_addr - $remote_user [$time_local] "$request" '
+					'$status $body_bytes_sent "$http_referer" '
+					'"$http_user_agent" "$http_x_forwarded_for"';
+
+	access_log /var/log/nginx/access.log main;
+
+	sendfile on;
+	#tcp_nopush on;
+
+	keepalive_timeout 65;
+
+	#gzip on;
+
+	server {
+		listen 8080;
+		server_name localhost;
+
+		root /usr/share/nginx/html;
+
+		location / {
+			index index.html index.htm;
+		}
+
+		location ~* ^/(config(.+)?\.json$|(.+)\.html$|i18n) {
+			expires -1;
+		}
+
+		error_page 500 502 503 504 /50x.html;
+		location = /50x.html {
+			root /usr/share/nginx/html;
+		}
+	}
+}

roles/matrix-client-cinny/templates/systemd/matrix-client-cinny.service.j2

@@ -0,0 +1,40 @@
+#jinja2: lstrip_blocks: "True"
+[Unit]
+Description=Matrix Cinny Client
+{% for service in matrix_client_cinny_systemd_required_services_list %}
+Requires={{ service }}
+After={{ service }}
+{% endfor %}
+DefaultDependencies=no
+
+[Service]
+Type=simple
+Environment="HOME={{ matrix_systemd_unit_home_path }}"
+ExecStartPre=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-client-cinny 2>/dev/null'
+ExecStartPre=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-client-cinny 2>/dev/null'
+
+ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-client-cinny \
+			--log-driver=none \
+			--user={{ matrix_user_uid }}:{{ matrix_user_gid }} \
+			--cap-drop=ALL \
+			--read-only \
+			--network={{ matrix_docker_network }} \
+			{% if matrix_client_cinny_container_http_host_bind_port %}
+			-p {{ matrix_client_cinny_container_http_host_bind_port }}:8080 \
+			{% endif %}
+			--tmpfs=/tmp:rw,noexec,nosuid,size=10m \
+			--mount type=bind,src={{ matrix_client_cinny_data_path }}/nginx.conf,dst=/etc/nginx/nginx.conf,ro \
+			--mount type=bind,src={{ matrix_client_cinny_data_path }}/config.json,dst=/app/config.json,ro \
+			{% for arg in matrix_client_cinny_container_extra_arguments %}
+			{{ arg }} \
+			{% endfor %}
+			{{ matrix_client_cinny_docker_image }}
+
+ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-client-cinny 2>/dev/null'
+ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-client-cinny 2>/dev/null'
+Restart=always
+RestartSec=30
+SyslogIdentifier=matrix-client-cinny
+
+[Install]
+WantedBy=multi-user.target