Redo the way matryx-rageshake configuration is done

This makes it consistent with the rest of the playbook:
- there's a default config which has various variables controlling
  settings
- there's also an `_extension_yaml` variable, which lets you override it

roles/custom/matrix-rageshake/defaults/main.yml

@@ -31,12 +31,29 @@ matrix_rageshake_systemd_wanted_services_list: []
 
 matrix_rageshake_config_api_prefix: "https://{{ matrix_server_fqn_rageshake }}/api/"
 
-# Rageshake Settings
+# Default Rageshake 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_rageshake_configuration_extension_yaml`)
+# or completely replace this variable with your own template.
+matrix_rageshake_configuration_yaml: "{{ lookup('template', 'templates/config.yml.j2') }}"
 
-# Additional config  to pass to the rageshake.
+matrix_rageshake_configuration_extension_yaml: |
-# See https://github.com/matrix-org/rageshake/blob/master/rageshake.sample.yaml
+  # Your custom YAML configuration for Synapse goes here.
+  # This configuration extends the default starting configuration (`matrix_rageshake_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_rageshake_configuration_yaml`.
   #
-# Example:
+  # Example configuration extension follows:
-# matrix_rageshake_config: |
+  #
-#   github_token: secrettoken
+  # github_project_mappings:
-matrix_rageshake_config: ""
+  #   my-app: octocat/HelloWorld
+
+matrix_rageshake_configuration_extension: "{{ matrix_rageshake_configuration_extension_yaml | from_yaml if matrix_rageshake_configuration_extension_yaml | from_yaml is mapping else {} }}"
+
+# Holds the final Synapse configuration (a combination of the default and its extension).
+# You most likely don't need to touch this variable. Instead, see `matrix_rageshake_configuration_yaml`.
+matrix_rageshake_configuration: "{{ matrix_rageshake_configuration_yaml | from_yaml | combine(matrix_rageshake_configuration_extension, recursive=True) }}"

roles/custom/matrix-rageshake/tasks/install.yml

@@ -16,8 +16,8 @@
   when: "item.when | bool"
 
 - name: Ensure rageshake config file created
-  ansible.builtin.template:
+  ansible.builtin.copy:
-    src: "{{ role_path }}/templates/config.j2"
+    content: "{{ matrix_rageshake_configuration | to_nice_yaml(indent=2, width=999999) }}"
     dest: "{{ matrix_rageshake_config_path }}/config.yml"
     owner: "{{ matrix_user_username }}"
     group: "{{ matrix_user_groupname }}"
@@ -63,4 +63,3 @@
     src: "{{ role_path }}/templates/systemd/matrix-rageshake.service.j2"
     dest: "{{ devture_systemd_docker_base_systemd_path }}/matrix-rageshake.service"
     mode: 0644
-  register: matrix_rageshake_systemd_service_result

roles/custom/matrix-rageshake/templates/config.j2

@@ -1,2 +0,0 @@
-api_prefix: {{ matrix_rageshake_config_api_prefix | to_json }}
-{{ matrix_rageshake_config | to_nice_yaml(indent=2, width=999999) }}

roles/custom/matrix-rageshake/templates/config.yml.j2

@@ -0,0 +1,4 @@
+# Default configuration for Rageshake.
+# To extend it, use `matrix_rageshake_configuration_extension_yaml`.
+
+api_prefix: {{ matrix_rageshake_config_api_prefix | to_json }}