matrix-docker-ansible-deploy/roles/custom/matrix-synapse/tasks/main.yml

---

- block:
    - when: matrix_synapse_enabled | bool
      ansible.builtin.include_tasks: "{{ role_path }}/tasks/init.yml"
  tags:
    - setup-all
    - setup-synapse
    - install-all
    - install-synapse
    - setup-synapse-reverse-proxy-companion
    - install-synapse-reverse-proxy-companion
    - start
    - start-all
    - start-group
    - restart
    - restart-all
    - restart-group
    - stop
    - stop-all
    - stop-group

- block:
    - when: matrix_synapse_enabled | bool
      ansible.builtin.include_tasks: "{{ role_path }}/tasks/validate_config.yml"

    - when: matrix_synapse_enabled | bool
      ansible.builtin.include_tasks: "{{ role_path }}/tasks/setup_install.yml"
  tags:
    - setup-all
    - setup-synapse
    - install-all
    - install-synapse

- block:
    - when: not matrix_synapse_enabled | bool
      ansible.builtin.include_tasks: "{{ role_path }}/tasks/setup_uninstall.yml"
  tags:
    - setup-all
    - setup-synapse

- block:
    - when: matrix_synapse_enabled | bool
      ansible.builtin.include_tasks: "{{ role_path }}/tasks/import_media_store.yml"
  tags:
    - import-synapse-media-store

- block:
    - when: matrix_synapse_enabled | bool
      ansible.builtin.include_tasks: "{{ role_path }}/tasks/register_user.yml"
  tags:
    - register-user

- block:
    - when: matrix_synapse_enabled | bool
      ansible.builtin.include_tasks: "{{ role_path }}/tasks/update_user_password.yml"
  tags:
    - update-user-password

- block:
    - when: matrix_synapse_enabled | bool
      ansible.builtin.include_tasks: "{{ role_path }}/tasks/rust-synapse-compress-state/main.yml"
  tags:
    - rust-synapse-compress-state

- block:
    - when: matrix_synapse_enabled | bool
      ansible.builtin.include_tasks: "{{ role_path }}/tasks/self_check_client_api.yml"

    - when: matrix_synapse_enabled | bool
      ansible.builtin.include_tasks: "{{ role_path }}/tasks/self_check_federation_api.yml"
  tags:
    - self-check
fix: all praise the allmighty yamllinter 2022-02-05 22:32:54 +02:00			`---`

Replace most import_tasks calls with include_tasks for improved performance 2022-11-24 11:33:30 +02:00			`- block:`
			`- when: matrix_synapse_enabled \| bool`
Rename inject_into_nginx_proxy.yml to init.yml when it does more than injection 2022-12-09 10:18:40 +02:00			`ansible.builtin.include_tasks: "{{ role_path }}/tasks/init.yml"`
Split playbook into multiple roles As suggested in #63 (Github issue), splitting the playbook's logic into multiple roles will be beneficial for maintainability. This patch realizes this split. Still, some components affect others, so the roles are not really independent of one another. For example: - disabling mxisd (`matrix_mxisd_enabled: false`), causes Synapse and riot-web to reconfigure themselves with other (public) Identity servers. - enabling matrix-corporal (`matrix_corporal_enabled: true`) affects how reverse-proxying (by `matrix-nginx-proxy`) is done, in order to put matrix-corporal's gateway server in front of Synapse We may be able to move away from such dependencies in the future, at the expense of a more complicated manual configuration, but it's probably not worth sacrificing the convenience we have now. As part of this work, the way we do "start components" has been redone now to use a loop, as suggested in #65 (Github issue). This should make restarting faster and more reliable. 2019-01-12 17:53:00 +02:00			`tags:`
Do not run matrix-nginx-proxy config injection tasks unless necessary These `init.yml` (now `inject_into_nginx_proxy.yml`) tasks do not need to `always` run. They only need to run for `setup-all` and `setup-nginx-proxy`. Unless we're dealing with these 2 tags, we can spare ourselves a lot of work. This patch also moves the `when` statement from `init.yml` into `main.yml` in an effort to further optimize things by potentially avoiding the extra file include. 2022-11-23 15:52:58 +02:00			`- setup-all`
			`- setup-synapse`
Add some missing tags to Synapse role Without these: - `--tags=install-synapse` and `--tags=install-all` would be incomplete and will not contain Synapse worker configuration - `--tags=install-synapse-reverse-proxy-companion` and `--tags=setup-synapse-reverse-proxy-companion` would not contain Synapse worker configuration 2022-12-09 10:15:06 +02:00			`- install-all`
			`- install-synapse`
			`- setup-synapse-reverse-proxy-companion`
			`- install-synapse-reverse-proxy-companion`
Do not run matrix-nginx-proxy config injection tasks unless necessary These `init.yml` (now `inject_into_nginx_proxy.yml`) tasks do not need to `always` run. They only need to run for `setup-all` and `setup-nginx-proxy`. Unless we're dealing with these 2 tags, we can spare ourselves a lot of work. This patch also moves the `when` statement from `init.yml` into `main.yml` in an effort to further optimize things by potentially avoiding the extra file include. 2022-11-23 15:52:58 +02:00			`- start`
			`- start-all`
			`- start-group`
			`- restart`
			`- restart-all`
			`- restart-group`
			`- stop`
			`- stop-all`
			`- stop-group`
Split playbook into multiple roles As suggested in #63 (Github issue), splitting the playbook's logic into multiple roles will be beneficial for maintainability. This patch realizes this split. Still, some components affect others, so the roles are not really independent of one another. For example: - disabling mxisd (`matrix_mxisd_enabled: false`), causes Synapse and riot-web to reconfigure themselves with other (public) Identity servers. - enabling matrix-corporal (`matrix_corporal_enabled: true`) affects how reverse-proxying (by `matrix-nginx-proxy`) is done, in order to put matrix-corporal's gateway server in front of Synapse We may be able to move away from such dependencies in the future, at the expense of a more complicated manual configuration, but it's probably not worth sacrificing the convenience we have now. As part of this work, the way we do "start components" has been redone now to use a loop, as suggested in #65 (Github issue). This should make restarting faster and more reliable. 2019-01-12 17:53:00 +02:00
Replace most import_tasks calls with include_tasks for improved performance 2022-11-24 11:33:30 +02:00			`- block:`
			`- when: matrix_synapse_enabled \| bool`
			`ansible.builtin.include_tasks: "{{ role_path }}/tasks/validate_config.yml"`
Make roles more independent of one another With this change, the following roles are now only dependent on the minimal `matrix-base` role: - `matrix-corporal` - `matrix-coturn` - `matrix-mailer` - `matrix-mxisd` - `matrix-postgres` - `matrix-riot-web` - `matrix-synapse` The `matrix-nginx-proxy` role still does too much and remains dependent on the others. Wiring up the various (now-independent) roles happens via a glue variables file (`group_vars/matrix-servers`). It's triggered for all hosts in the `matrix-servers` group. According to Ansible's rules of priority, we have the following chain of inclusion/overriding now: - role defaults (mostly empty or good for independent usage) - playbook glue variables (`group_vars/matrix-servers`) - inventory host variables (`inventory/host_vars/matrix.<your-domain>`) All roles default to enabling their main component (e.g. `matrix_mxisd_enabled: true`, `matrix_riot_web_enabled: true`). Reasoning: if a role is included in a playbook (especially separately, in another playbook), it should "work" by default. Our playbook disables some of those if they are not generally useful (e.g. `matrix_corporal_enabled: false`). 2019-01-16 18:05:48 +02:00
Untangle the setup import/include mess in matrix-synapse 2022-11-24 16:27:11 +02:00			`- when: matrix_synapse_enabled \| bool`
			`ansible.builtin.include_tasks: "{{ role_path }}/tasks/setup_install.yml"`
Add install-* tags for quicker runs 2022-11-25 16:02:51 +02:00			`tags:`
			`- setup-all`
			`- setup-synapse`
			`- install-all`
			`- install-synapse`
Untangle the setup import/include mess in matrix-synapse 2022-11-24 16:27:11 +02:00
Add install-* tags for quicker runs 2022-11-25 16:02:51 +02:00			`- block:`
Untangle the setup import/include mess in matrix-synapse 2022-11-24 16:27:11 +02:00			`- when: not matrix_synapse_enabled \| bool`
			`ansible.builtin.include_tasks: "{{ role_path }}/tasks/setup_uninstall.yml"`
Split playbook into multiple roles As suggested in #63 (Github issue), splitting the playbook's logic into multiple roles will be beneficial for maintainability. This patch realizes this split. Still, some components affect others, so the roles are not really independent of one another. For example: - disabling mxisd (`matrix_mxisd_enabled: false`), causes Synapse and riot-web to reconfigure themselves with other (public) Identity servers. - enabling matrix-corporal (`matrix_corporal_enabled: true`) affects how reverse-proxying (by `matrix-nginx-proxy`) is done, in order to put matrix-corporal's gateway server in front of Synapse We may be able to move away from such dependencies in the future, at the expense of a more complicated manual configuration, but it's probably not worth sacrificing the convenience we have now. As part of this work, the way we do "start components" has been redone now to use a loop, as suggested in #65 (Github issue). This should make restarting faster and more reliable. 2019-01-12 17:53:00 +02:00			`tags:`
			`- setup-all`
			`- setup-synapse`

Replace most import_tasks calls with include_tasks for improved performance 2022-11-24 11:33:30 +02:00			`- block:`
			`- when: matrix_synapse_enabled \| bool`
			`ansible.builtin.include_tasks: "{{ role_path }}/tasks/import_media_store.yml"`
Split playbook into multiple roles As suggested in #63 (Github issue), splitting the playbook's logic into multiple roles will be beneficial for maintainability. This patch realizes this split. Still, some components affect others, so the roles are not really independent of one another. For example: - disabling mxisd (`matrix_mxisd_enabled: false`), causes Synapse and riot-web to reconfigure themselves with other (public) Identity servers. - enabling matrix-corporal (`matrix_corporal_enabled: true`) affects how reverse-proxying (by `matrix-nginx-proxy`) is done, in order to put matrix-corporal's gateway server in front of Synapse We may be able to move away from such dependencies in the future, at the expense of a more complicated manual configuration, but it's probably not worth sacrificing the convenience we have now. As part of this work, the way we do "start components" has been redone now to use a loop, as suggested in #65 (Github issue). This should make restarting faster and more reliable. 2019-01-12 17:53:00 +02:00			`tags:`
Rename some doc files and commands related to importing Since we'll likely have generic SQLite database importing via [pgloader](https://pgloader.io/) for migrating bridge databases from SQLite to Postgres, we'd rather avoid calling the "import Synapse SQLite database" command as just `--tags=import-sqlite-db`. Similarly, for the media store, we'd like to mention that it's related to Synapse as well. We'd like to be more explicit, so as to be less confusing, especially in light of other homeserver implementations coming in the future. 2020-12-14 01:48:36 +02:00			`- import-synapse-media-store`
Split playbook into multiple roles As suggested in #63 (Github issue), splitting the playbook's logic into multiple roles will be beneficial for maintainability. This patch realizes this split. Still, some components affect others, so the roles are not really independent of one another. For example: - disabling mxisd (`matrix_mxisd_enabled: false`), causes Synapse and riot-web to reconfigure themselves with other (public) Identity servers. - enabling matrix-corporal (`matrix_corporal_enabled: true`) affects how reverse-proxying (by `matrix-nginx-proxy`) is done, in order to put matrix-corporal's gateway server in front of Synapse We may be able to move away from such dependencies in the future, at the expense of a more complicated manual configuration, but it's probably not worth sacrificing the convenience we have now. As part of this work, the way we do "start components" has been redone now to use a loop, as suggested in #65 (Github issue). This should make restarting faster and more reliable. 2019-01-12 17:53:00 +02:00
Replace most import_tasks calls with include_tasks for improved performance 2022-11-24 11:33:30 +02:00			`- block:`
			`- when: matrix_synapse_enabled \| bool`
			`ansible.builtin.include_tasks: "{{ role_path }}/tasks/register_user.yml"`
Split playbook into multiple roles As suggested in #63 (Github issue), splitting the playbook's logic into multiple roles will be beneficial for maintainability. This patch realizes this split. Still, some components affect others, so the roles are not really independent of one another. For example: - disabling mxisd (`matrix_mxisd_enabled: false`), causes Synapse and riot-web to reconfigure themselves with other (public) Identity servers. - enabling matrix-corporal (`matrix_corporal_enabled: true`) affects how reverse-proxying (by `matrix-nginx-proxy`) is done, in order to put matrix-corporal's gateway server in front of Synapse We may be able to move away from such dependencies in the future, at the expense of a more complicated manual configuration, but it's probably not worth sacrificing the convenience we have now. As part of this work, the way we do "start components" has been redone now to use a loop, as suggested in #65 (Github issue). This should make restarting faster and more reliable. 2019-01-12 17:53:00 +02:00			`tags:`
			`- register-user`

Replace most import_tasks calls with include_tasks for improved performance 2022-11-24 11:33:30 +02:00			`- block:`
			`- when: matrix_synapse_enabled \| bool`
			`ansible.builtin.include_tasks: "{{ role_path }}/tasks/update_user_password.yml"`
Split playbook into multiple roles As suggested in #63 (Github issue), splitting the playbook's logic into multiple roles will be beneficial for maintainability. This patch realizes this split. Still, some components affect others, so the roles are not really independent of one another. For example: - disabling mxisd (`matrix_mxisd_enabled: false`), causes Synapse and riot-web to reconfigure themselves with other (public) Identity servers. - enabling matrix-corporal (`matrix_corporal_enabled: true`) affects how reverse-proxying (by `matrix-nginx-proxy`) is done, in order to put matrix-corporal's gateway server in front of Synapse We may be able to move away from such dependencies in the future, at the expense of a more complicated manual configuration, but it's probably not worth sacrificing the convenience we have now. As part of this work, the way we do "start components" has been redone now to use a loop, as suggested in #65 (Github issue). This should make restarting faster and more reliable. 2019-01-12 17:53:00 +02:00			`tags:`
Fix accidentally swapped tags (rust-synapse-compress-state and update-user-password) 2022-11-27 07:24:24 +02:00			`- update-user-password`
Add the ability to update user passwords with ansible (when using the matrix-postgres container). 2019-04-30 15:30:26 +02:00
Replace most import_tasks calls with include_tasks for improved performance 2022-11-24 11:33:30 +02:00			`- block:`
			`- when: matrix_synapse_enabled \| bool`
			`ansible.builtin.include_tasks: "{{ role_path }}/tasks/rust-synapse-compress-state/main.yml"`
Add the ability to update user passwords with ansible (when using the matrix-postgres container). 2019-04-30 15:30:26 +02:00			`tags:`
Fix accidentally swapped tags (rust-synapse-compress-state and update-user-password) 2022-11-27 07:24:24 +02:00			`- rust-synapse-compress-state`
Move mautrix telegram and whatsapp into separate roles The goal is to move each bridge into its own separate role. This commit starts off the work on this with 2 bridges: - mautrix-telegram - mautrix-whatsapp Each bridge's role (including these 2) is meant to: - depend only on the matrix-base role - integrate nicely with the matrix-synapse role (if available) - integrate nicely with the matrix-nginx-proxy role (if available and if required). mautrix-telegram bridge benefits from integrating with it. - not break if matrix-synapse or matrix-nginx-proxy are not used at all This has been provoked by #174 (Github Issue). 2019-05-14 16:47:22 +02:00
Replace most import_tasks calls with include_tasks for improved performance 2022-11-24 11:33:30 +02:00			`- block:`
			`- when: matrix_synapse_enabled \| bool`
			`ansible.builtin.include_tasks: "{{ role_path }}/tasks/self_check_client_api.yml"`

			`- when: matrix_synapse_enabled \| bool`
			`ansible.builtin.include_tasks: "{{ role_path }}/tasks/self_check_federation_api.yml"`
Add support for rust-synapse-compress-state 2020-08-21 12:52:16 +02:00			`tags:`
Replace most import_tasks calls with include_tasks for improved performance 2022-11-24 11:33:30 +02:00			`- self-check`