matrix-docker-ansible-deploy/setup.yml

---
- name: "Set up a Matrix server"
  hosts: "{{ target if target is defined else 'matrix_servers' }}"
  become: true

  vars_files:
    - roles/matrix-synapse/vars/workers.yml

  roles:
    - matrix-awx
    - matrix-base
    - matrix-dynamic-dns
    - matrix-mailer
    - matrix-postgres
    - matrix-redis
    - matrix-corporal
    - matrix-bridge-appservice-discord
    - matrix-bridge-appservice-slack
    - matrix-bridge-appservice-webhooks
    - matrix-bridge-appservice-irc
    - matrix-bridge-mautrix-facebook
    - matrix-bridge-mautrix-hangouts
    - matrix-bridge-mautrix-instagram
    - matrix-bridge-mautrix-signal
    - matrix-bridge-mautrix-telegram
    - matrix-bridge-mautrix-whatsapp
    - matrix-bridge-mx-puppet-discord
    - matrix-bridge-mx-puppet-groupme
    - matrix-bridge-mx-puppet-steam
    - matrix-bridge-mx-puppet-skype
    - matrix-bridge-mx-puppet-slack
    - matrix-bridge-mx-puppet-twitter
    - matrix-bridge-mx-puppet-instagram
    - matrix-bridge-sms
    - matrix-bridge-heisenbridge
    - matrix-bot-matrix-reminder-bot
    - matrix-bot-go-neb
    - matrix-bot-mjolnir
    - matrix-synapse
    - matrix-synapse-admin
    - matrix-prometheus-node-exporter
    - matrix-prometheus
    - matrix-grafana
    - matrix-registration
    - matrix-client-element
    - matrix-client-hydrogen
    - matrix-jitsi
    - matrix-ma1sd
    - matrix-dimension
    - matrix-etherpad
    - matrix-email2matrix
    - matrix-sygnal
    - matrix-nginx-proxy
    - matrix-coturn
    - matrix-aux
    - matrix-postgres-backup
    - matrix-prometheus-postgres-exporter
    - matrix-common-after

  tasks:
    - name: Ensure web-user is present
      user:
        name: "{{ web_user }}"
        state: present
        system: yes
      register: web_user_res
      tags: [ setup-caddy, setup-all, start ]
    - name: Ensure directory for revproxy config is present
      file:
        path: "{{ revproxy_autoload_dir }}/matrix"
        state: directory
        owner: "{{ web_user_res.uid }}"
        group: "{{ web_user_res.group }}"
        mode: 0750
      tags: [ setup-caddy, setup-all, start ]
    - name: Template reverse proxy configuration
      template:
        src: Caddyfile.j2
        dest: "{{ revproxy_autoload_dir }}/matrix/Caddyfile"
        owner: "{{ web_user_res.uid }}"
        group: "{{ web_user_res.group }}"
        mode: 0640
      tags: [ setup-caddy, setup-all, start ]
Initial commit 2017-07-31 20:07:30 +00:00			`---`
			`- name: "Set up a Matrix server"`
Fix TRANSFORM_INVALID_GROUP_CHARS deprecation warning 2019-05-21 15:39:33 +00:00			`hosts: "{{ target if target is defined else 'matrix_servers' }}"`
Initial commit 2017-07-31 20:07:30 +00:00			`become: true`

Load roles/matrix-synapse/vars/workers.yml earlier to not break --tags=setup-nginx-proxy If we load it at runtime, during matrix-synapse role execution, it's good enough for matrix-synapse and all roles after that, but.. it breaks when someone uses `--tags=setup-nginx-proxy` alone. The downside of including this vars file like this in `setup.yml` is that the variables contained in it cannot be overriden by the user (in their inventory's `vars.yml`). ... but it's not like overriding these variables was possible anyway when including them at runtime. 2021-01-24 18:17:10 +00:00			`vars_files:`
			`- roles/matrix-synapse/vars/workers.yml`

Initial commit 2017-07-31 20:07:30 +00:00			`roles:`
initial PR 2021-02-20 09:19:17 +00:00			`- matrix-awx`
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 15:53:00 +00:00			`- matrix-base`
Added containerization 2020-10-17 04:21:58 +00:00			`- matrix-dynamic-dns`
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 15:53:00 +00:00			`- matrix-mailer`
			`- matrix-postgres`
add redis support 2020-09-10 11:39:00 +00:00			`- matrix-redis`
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 15:53:00 +00:00			`- matrix-corporal`
Move matrix-appservice-discord into a separate role 2019-05-17 16:14:12 +00:00			`- matrix-bridge-appservice-discord`
Added Slack role 2019-06-10 14:52:48 +00:00			`- matrix-bridge-appservice-slack`
Add matrix-appservice-webhooks role. 2020-01-09 16:00:03 +00:00			`- matrix-bridge-appservice-webhooks`
Move matrix-appservice-irc into a separate role 2019-05-16 00:07:40 +00:00			`- matrix-bridge-appservice-irc`
Move mautrix-facebook into a separate role 2019-05-15 00:34:31 +00:00			`- matrix-bridge-mautrix-facebook`
add hangouts bridge by copying facebook bridge and find-replacing 2019-07-28 16:52:30 +00:00			`- matrix-bridge-mautrix-hangouts`
initial commit of mautrix-instagram role 2021-02-19 11:58:54 +00:00			`- matrix-bridge-mautrix-instagram`
added mautrix-signal role 2020-10-22 21:29:34 +00:00			`- matrix-bridge-mautrix-signal`
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 14:47:22 +00:00			`- matrix-bridge-mautrix-telegram`
			`- matrix-bridge-mautrix-whatsapp`
Add mx-puppet-discord 2020-06-11 15:54:36 +00:00			`- matrix-bridge-mx-puppet-discord`
Initial implementation 2021-02-13 04:13:30 +00:00			`- matrix-bridge-mx-puppet-groupme`
Add mx-puppet-steam 2020-07-01 11:46:58 +00:00			`- matrix-bridge-mx-puppet-steam`
Initial mx-puppet-skype bridge role 2020-03-17 00:33:11 +00:00			`- matrix-bridge-mx-puppet-skype`
Initial mx-puppet-slack bridge role 2020-04-12 14:17:30 +00:00			`- matrix-bridge-mx-puppet-slack`
Add mx-puppet-twitter Signed-off-by: Tulir Asokan <tulir@maunium.net> 2020-06-29 12:28:43 +00:00			`- matrix-bridge-mx-puppet-twitter`
mx-puppet-instagram: add role 2020-06-27 10:40:27 +00:00			`- matrix-bridge-mx-puppet-instagram`
renamed role matrix-sms-bridge to matrix-bridge-sms 2020-06-05 10:25:41 +00:00			`- matrix-bridge-sms`
Add Heisenbridge 2021-05-12 12:24:39 +00:00			`- matrix-bridge-heisenbridge`
Add support for matrix-reminder-bot 2020-07-20 11:13:08 +00:00			`- matrix-bot-matrix-reminder-bot`
Added support for the Go-NEB bot 2021-03-11 18:23:01 +00:00			`- matrix-bot-go-neb`
Add mjolnir 2021-03-24 03:46:08 +00:00			`- matrix-bot-mjolnir`
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 15:53:00 +00:00			`- matrix-synapse`
Add synapse-admin support Fixes #562 (Github Issue) 2020-07-22 05:10:26 +00:00			`- matrix-synapse-admin`
Prometheus Node Exporter Basic system stats, to show stuff the synapse metrics can't show such as resource usage by bridges, etc Seems to work fine as well. This too has only been tested on debian amd64 so far 2021-01-29 05:17:45 +00:00			`- matrix-prometheus-node-exporter`
Prometheus Initial attempt. Seems to work fine. Only tested on debian amd64 so far 2021-01-29 04:29:25 +00:00			`- matrix-prometheus`
Grafana Also includes the dashboards for Synapse and for Node Exporter. Again has only been tested on debian amd64 so far, but the grafana docker image is available for arm64 and arm32. Nice. 2021-01-29 08:10:49 +00:00			`- matrix-grafana`
Add matrix-registration support 2020-09-01 10:46:05 +00:00			`- matrix-registration`
Riot is now Element Fixes #586 (Github Issue) 2020-07-17 08:31:20 +00:00			`- matrix-client-element`
Add Hydrogen 2021-05-15 09:23:36 +00:00			`- matrix-client-hydrogen`
Add Jitsi support 2020-03-23 15:19:15 +00:00			`- matrix-jitsi`
Rename variables (s/mxisd/ma1sd/) and adapt roles 2020-01-08 21:31:44 +00:00			`- matrix-ma1sd`
Implement self-hosted Dimension server 2019-03-07 05:22:08 +00:00			`- matrix-dimension`
Etherpad role 2021-01-20 23:06:35 +00:00			`- matrix-etherpad`
Add Email2Matrix support 2019-08-05 10:06:49 +00:00			`- matrix-email2matrix`
Add Sygnal support Fixes https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/683 2021-03-20 11:31:34 +00:00			`- matrix-sygnal`
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 15:53:00 +00:00			`- matrix-nginx-proxy`
Add TLS support to Coturn 2019-03-19 08:24:39 +00:00			`- matrix-coturn`
Add matrix-aux role to help with managing auxiliary files/directories 2021-01-11 20:15:13 +00:00			`- matrix-aux`
- Added role to setup https://github.com/prodrigestivill/docker-postgres-backup-local container to backup all postgres databases 2021-02-11 16:18:25 +00:00			`- matrix-postgres-backup`
Add support for a prometheus postgres exporter This commit introduces a new role that downloads and installs the prometheus community postgres exporter https://github.com/prometheus-community/postgres_exporter. A new credential is added to matrix_postgres_additional_databases that allows the exporter access to the database to gather statistics. A new dashboard was added to the grafana role, with some refactoring to enable the dashboard only if the new role is enabled. I've included some basic instructions for how to enable the role in the Docs section. In terms of testing, I've tested enabling the role, and disabling it to make sure it cleans up the container and systemd role. 2021-05-27 19:13:29 +00:00			`- matrix-prometheus-postgres-exporter`
feat: add automatic creation of reverse-proxy routing 2021-04-18 09:55:40 +00:00			`- matrix-common-after`

			`tasks:`
			`- name: Ensure web-user is present`
			`user:`
			`name: "{{ web_user }}"`
			`state: present`
			`system: yes`
			`register: web_user_res`
			`tags: [ setup-caddy, setup-all, start ]`
			`- name: Ensure directory for revproxy config is present`
			`file:`
			`path: "{{ revproxy_autoload_dir }}/matrix"`
			`state: directory`
			`owner: "{{ web_user_res.uid }}"`
			`group: "{{ web_user_res.group }}"`
			`mode: 0750`
			`tags: [ setup-caddy, setup-all, start ]`
			`- name: Template reverse proxy configuration`
			`template:`
			`src: Caddyfile.j2`
			`dest: "{{ revproxy_autoload_dir }}/matrix/Caddyfile"`
			`owner: "{{ web_user_res.uid }}"`
			`group: "{{ web_user_res.group }}"`
			`mode: 0640`
			`tags: [ setup-caddy, setup-all, start ]`