synapse: add argument specs

galaxy.yml

@@ -3,7 +3,7 @@
 namespace: uumas
 name: matrix
 description: Matrix roles
-version: 0.0.3
+version: 0.0.4
 readme: README.md
 repository: https://git.uumas.fi/uumas/ansible-matrix
 license_file: LICENSE

playbooks/vars/nginx.yml

@@ -1,6 +1,6 @@
 ---
 
-# Worker endpoints last updated on 2023-04-25
+# Worker endpoints last updated on 2023-07-18
 nginx_upstreams:
   synapse_main:
     servers:
@@ -46,7 +46,6 @@ nginx_upstreams:
       - name: '~ ^/_matrix/client/v1/rooms/.*/hierarchy$'
       - name: '~ ^/_matrix/client/(v1|unstable)/rooms/.*/relations/'
       - name: '~ ^/_matrix/client/v1/rooms/.*/threads$'
-      - name: '~ ^/_matrix/client/unstable/org.matrix.msc2716/rooms/.*/batch_send$'
       - name: '~ ^/_matrix/client/unstable/im.nheko.summary/rooms/.*/summary$'
       - name: '~ ^/_matrix/client/(r0|v3|unstable)/account/3pid$'
       - name: '~ ^/_matrix/client/(r0|v3|unstable)/account/whoami$'

roles/synapse/defaults/main.yml

@@ -9,10 +9,4 @@ matrix_max_upload_size_mb: 100
 synapse_metrics: false
 synapse_presence: true
 
-persister_workers:
+matrix_auto_join_rooms: []
-  - event_persister
-  - typing_persister
-  - account_persister
-  - device_persister
-  - presence_persister
-  - receipt_persister

roles/synapse/meta/argument_specs.yml

@@ -0,0 +1,53 @@
+---
+
+argument_specs:
+  main:
+    short_description: Matrix Synaspe
+    description: "Installs and configures a synapse server. Supports workers and matrix_synapse_shared_secret_auth"
+    options:
+      synapse_psql_user:
+        description: Postgres database username for synapse
+        type: str
+        required: true
+      synapse_psql_pw:
+        description: Postgres database password for synapse
+        type: str
+        required: true
+      synapse_psql_db:
+        description: Postgres database name for synapse
+        type: str
+        required: false
+        default: "{{ synapse_psql_user }}"
+      synapse_psql_host:
+        description: Postgres database server hostname
+        type: str
+        required: false
+        default: localhost
+
+      matrix_max_upload_size_mb:
+        description: Maximum file upload size for synapse in megabytes
+        type: int
+        required: false
+        default: 100
+      matrix_auto_join_rooms:
+        description: A list of room aliases new users will be joined to automatically
+        type: list
+        required: false
+        default: []
+
+      matrix_signing_key:
+        description: Matrix federation signing key. Will use auto-generated one if not defined.
+        type: str
+        required: false
+
+      synapse_metrics:
+        description: Whether to enable prometheus metrics listener on port 9656
+        type: bool
+        required: false
+        default: false
+      
+      synapse_presence:
+        description: Whether to enable presence detection on synapse. If disabled all users will be shown as permanently offline.
+        type: bool
+        required: false
+        default: true

roles/synapse/tasks/config.yml

@@ -29,6 +29,7 @@
     - listeners
     - server_name
     - url_preview
+    - autojoin
   notify: Config matrix target
 
 - name: Ensure synapse configs including secrets is in place
@@ -43,16 +44,6 @@
     - general
   notify: Config matrix target
 
-- name: Ensure autojoin config is in place
-  ansible.builtin.template:
-    src: conf.d/autojoin.yaml.j2
-    dest: /etc/matrix-synapse/conf.d/autojoin.yaml
-    owner: matrix-synapse
-    group: nogroup
-    mode: 0644
-  when: matrix_auto_join_rooms is defined
-  notify: Config matrix target
-
 - name: Ensure password provider config is in place
   ansible.builtin.template:
     src: conf.d/password_providers.yaml.j2

roles/synapse/tasks/worker_type.yml

@@ -5,13 +5,13 @@
     worker_type: "{{ synapse_worker.key }}"
 
 - name: Include default variables
-  ansible.builtin.include_vars: defaults.yml
+  ansible.builtin.include_vars: workers/defaults.yml
 
 - name: Include variables for {{ worker_type }}
   ansible.builtin.include_vars: "{{ item }}"
   with_first_found:
     - files:
-        - "{{ worker_type }}.yml"
+        - "workers/{{ worker_type }}.yml"
       skip: true
 
 - name: Warn of legacy workers

roles/synapse/templates/conf.d/autojoin.yaml.j2

@@ -1,6 +1,3 @@
 # {{ ansible_managed }}
 
-auto_join_rooms:
+auto_join_rooms: {{ matrix_auto_join_rooms }}
-{% for room_id in matrix_auto_join_rooms %}
-  - "{{ room_id }}"
-{% endfor %}

roles/synapse/templates/conf.d/general.yaml.j2

@@ -12,5 +12,3 @@ use_presence: {{ synapse_presence }}
 enable_media_repo: {{ matrix_media_repo_server is not defined and 'media_repository' not in synapse_workers }}
 retention:
   enabled: true
-experimental_features:
-  msc2716_enabled: true

roles/synapse/templates/conf.d/workers.yaml.j2

@@ -18,9 +18,11 @@ update_user_directory_from_worker: user_dir-0
 
 {% if 'event_persister' in synapse_workers or 'typing_persister' in synapse_workers or 'account_persister' in synapse_workers or 'device_persister' in synapse_workers or 'presence_persister' in synapse_workers or 'receipt_persister' in synapse_workers %}
 instance_map:
+  main:
+    host: localhost
+    port: 9093
 
 {% for persister_type in persister_workers %}
-
 {% if persister_type in synapse_workers %}
 {% for port in synapse_workers[persister_type] %}
   {{ persister_type }}-{{ loop.index0 }}:
@@ -28,7 +30,6 @@ instance_map:
     port: {{ port }}
 {% endfor %}
 {% endif %}
-
 {% endfor %}
 
 stream_writers:

roles/synapse/templates/worker.yaml.j2

@@ -2,10 +2,6 @@
 worker_app: synapse.app.{{ worker_app }}
 worker_name: {{ worker }}
 
-# The replication listener on the synapse to talk to.
-worker_replication_host: 127.0.0.1
-worker_replication_http_port: 9093
-
 worker_log_config: /etc/matrix-synapse/worker-logs/{{ worker }}-log.yaml
 {% if worker_port is defined and worker_listeners|length !=0 or synapse_metrics %}
 worker_listeners:

roles/synapse/vars/main.yml

@@ -0,0 +1,9 @@
+---
+
+persister_workers:
+  - event_persister
+  - typing_persister
+  - account_persister
+  - device_persister
+  - presence_persister
+  - receipt_persister