| @@ -1,3 +1,71 @@ | |||||
| # 2022-01-07 | |||||
| ## Dendrite support | |||||
| **TLDR**: We now have optional experimental [Dendrite](https://github.com/matrix-org/dendrite) homeserver support for new installations. **Existing (Synapse) installations need to be updated**, because some internals changed. See [Adapting the configuration for existing Synapse installations](#adapting-the-configuration-for-existing-synapse-installations). | |||||
| [Jip J. Dekker](https://github.com/Dekker1) did the [initial work](https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/818) of adding [Dendrite](https://github.com/matrix-org/dendrite) support to the playbook back in January 2021. Lots of work (and time) later, Dendrite support is finally ready for testing. | |||||
| We believe that 2022 will be the year of the non-Synapse Matrix server! | |||||
| The playbook was previously quite [Synapse](https://github.com/matrix-org/synapse)-centric, but can now accommodate multiple homeserver implementations. Only one homeserver implementation can be active (installed) at a given time. | |||||
| **Synapse is still the default homeserver implementation** installed by the playbook. A new variable (`matrix_homeserver_implementation`) controls which server implementation is enabled (`synapse` or `dendrite` at the given moment). | |||||
| ### Adapting the configuration for existing Synapse installations | |||||
| Because the playbook is not so Synapse-centric anymore, a small configuration change is necessary for existing installations to bring them up to date. | |||||
| The `vars.yml` file for **existing installations will need to be updated** by adding this **additional configuration**: | |||||
| ```yaml | |||||
| # All secrets keys are now derived from `matrix_homeserver_generic_secret_key`, not from `matrix_synapse_macaroon_secret_key`. | |||||
| # To keep them all the same, define `matrix_homeserver_generic_secret_key` in terms of `matrix_synapse_macaroon_secret_key`. | |||||
| # Using a new secret value for this configuration key is also possible and should not cause any problems. | |||||
| # | |||||
| # Fun fact: new installations (based on the new `examples/vars.yml` file) do this in reverse. | |||||
| # That is, the Synapse macaroon secret is derived from `matrix_homeserver_generic_secret_key`. | |||||
| matrix_homeserver_generic_secret_key: "{{ matrix_synapse_macaroon_secret_key }}" | |||||
| ``` | |||||
| ### Trying out Dendrite | |||||
| Finally, **to try out Dendrite**, we recommend that you **use a new server** and the following addition to your `vars.yml` configuration: | |||||
| ```yaml | |||||
| matrix_homeserver_implementation: dendrite | |||||
| ``` | |||||
| **The homeserver implementation of an existing server cannot be changed** (e.g. from Synapse to Dendrite) without data loss. | |||||
| We're excited to gain support for other homeserver implementations, like [Conduit](https://conduit.rs/), etc! | |||||
| ## Honoroit bot support | |||||
| Thanks to [Aine](https://gitlab.com/etke.cc) of [etke.cc](https://etke.cc/), the playbook can now help you set up [Honoroit](https://gitlab.com/etke.cc/honoroit) - a helpdesk bot. | |||||
| See our [Setting up Honoroit](docs/configuring-playbook-bot-honoroit.md) documentation to get started. | |||||
| # 2022-01-06 | |||||
| ## Cinny support | |||||
| Thanks to [Aine](https://gitlab.com/etke.cc) of [etke.cc](https://etke.cc/), the playbook now supports [Cinny](https://cinny.in/) - a new simple, elegant and secure Matrix client. | |||||
| By default, we still install Element. Still, people who'd like to try Cinny out can now install it via the playbook. | |||||
| Additional details are available in [Setting up Cinny](docs/configuring-playbook-client-cinny.md). | |||||
| # 2021-12-22 | |||||
| ## Twitter bridging support via mautrix-twitter | |||||
| Thanks to [Matthew Cengia](https://github.com/mattcen) and [Shreyas Ajjarapu](https://github.com/shreyasajj), besides [mx-puppet-twitter](docs/configuring-playbook-bridge-mx-puppet-twitter.md), bridging to [Twitter](https://twitter.com/) can now also happen with [mautrix-twitter](docs/configuring-playbook-bridge-mautrix-twitter.md). | |||||
| # 2021-12-14 | # 2021-12-14 | ||||
| ## (Security) Users of the Signal bridge may wish to upgrade it to work around log4j vulnerability | ## (Security) Users of the Signal bridge may wish to upgrade it to work around log4j vulnerability | ||||
| @@ -19,6 +19,8 @@ Using this playbook, you can get the following services configured on your serve | |||||
| - (optional, default) a [Synapse](https://github.com/matrix-org/synapse) homeserver - storing your data and managing your presence in the [Matrix](http://matrix.org/) network | - (optional, default) a [Synapse](https://github.com/matrix-org/synapse) homeserver - storing your data and managing your presence in the [Matrix](http://matrix.org/) network | ||||
| - (optional) a [Dendrite](https://github.com/matrix-org/dendrite) homeserver - storing your data and managing your presence in the [Matrix](http://matrix.org/) network. Dendrite is a second-generation Matrix homeserver written in Go, an alternative to Synapse. | |||||
| - (optional) [Amazon S3](https://aws.amazon.com/s3/) storage for Synapse's content repository (`media_store`) files using [Goofys](https://github.com/kahing/goofys) | - (optional) [Amazon S3](https://aws.amazon.com/s3/) storage for Synapse's content repository (`media_store`) files using [Goofys](https://github.com/kahing/goofys) | ||||
| - (optional, default) [PostgreSQL](https://www.postgresql.org/) database for Synapse. [Using an external PostgreSQL server](docs/configuring-playbook-external-postgres.md) is also possible. | - (optional, default) [PostgreSQL](https://www.postgresql.org/) database for Synapse. [Using an external PostgreSQL server](docs/configuring-playbook-external-postgres.md) is also possible. | ||||
| @@ -51,6 +53,8 @@ Using this playbook, you can get the following services configured on your serve | |||||
| - (optional) the [mautrix-facebook](https://github.com/mautrix/facebook) bridge for bridging your Matrix server to [Facebook](https://facebook.com/) | - (optional) the [mautrix-facebook](https://github.com/mautrix/facebook) bridge for bridging your Matrix server to [Facebook](https://facebook.com/) | ||||
| - (optional) the [mautrix-twitter](https://github.com/mautrix/twitter) bridge for bridging your Matrix server to [Twitter](https://twitter.com/) | |||||
| - (optional) the [mautrix-hangouts](https://github.com/mautrix/hangouts) bridge for bridging your Matrix server to [Google Hangouts](https://en.wikipedia.org/wiki/Google_Hangouts) | - (optional) the [mautrix-hangouts](https://github.com/mautrix/hangouts) bridge for bridging your Matrix server to [Google Hangouts](https://en.wikipedia.org/wiki/Google_Hangouts) | ||||
| - (optional) the [mautrix-googlechat](https://github.com/mautrix/googlechat) bridge for bridging your Matrix server to [Google Chat](https://en.wikipedia.org/wiki/Google_Chat) | - (optional) the [mautrix-googlechat](https://github.com/mautrix/googlechat) bridge for bridging your Matrix server to [Google Chat](https://en.wikipedia.org/wiki/Google_Chat) | ||||
| @@ -97,6 +101,8 @@ Using this playbook, you can get the following services configured on your serve | |||||
| - (optional) [matrix-reminder-bot](https://github.com/anoadragon453/matrix-reminder-bot) for scheduling one-off & recurring reminders and alarms - see [docs/configuring-playbook-bot-matrix-reminder-bot.md](docs/configuring-playbook-bot-matrix-reminder-bot.md) for setup documentation | - (optional) [matrix-reminder-bot](https://github.com/anoadragon453/matrix-reminder-bot) for scheduling one-off & recurring reminders and alarms - see [docs/configuring-playbook-bot-matrix-reminder-bot.md](docs/configuring-playbook-bot-matrix-reminder-bot.md) for setup documentation | ||||
| - (optional) [honoroit](https://gitlab.com/etke.cc/honoroit) helpdesk bot - see [docs/configuring-playbook-bot-honoroit.md](docs/configuring-playbook-bot-honoroit.md) for setup documentation | |||||
| - (optional) [Go-NEB](https://github.com/matrix-org/go-neb) multi functional bot written in Go - see [docs/configuring-playbook-bot-go-neb.md](docs/configuring-playbook-bot-go-neb.md) for setup documentation | - (optional) [Go-NEB](https://github.com/matrix-org/go-neb) multi functional bot written in Go - see [docs/configuring-playbook-bot-go-neb.md](docs/configuring-playbook-bot-go-neb.md) for setup documentation | ||||
| - (optional) [Mjolnir](https://github.com/matrix-org/mjolnir), a moderation tool for Matrix - see [docs/configuring-playbook-bot-mjolnir.md](docs/configuring-playbook-bot-mjolnir.md) for setup documentation | - (optional) [Mjolnir](https://github.com/matrix-org/mjolnir), a moderation tool for Matrix - see [docs/configuring-playbook-bot-mjolnir.md](docs/configuring-playbook-bot-mjolnir.md) for setup documentation | ||||
| @@ -111,6 +117,8 @@ Using this playbook, you can get the following services configured on your serve | |||||
| - (optional) the [Hydrogen](https://github.com/vector-im/hydrogen-web) web client - see [docs/configuring-playbook-client-hydrogen.md](docs/configuring-playbook-client-hydrogen.md) for setup documentation | - (optional) the [Hydrogen](https://github.com/vector-im/hydrogen-web) web client - see [docs/configuring-playbook-client-hydrogen.md](docs/configuring-playbook-client-hydrogen.md) for setup documentation | ||||
| - (optional) the [Cinny](https://github.com/ajbura/cinny) web client - see [docs/configuring-playbook-client-cinny.md](docs/configuring-playbook-client-cinny.md) for setup documentation | |||||
| Basically, this playbook aims to get you up-and-running with all the necessities around Matrix, without you having to do anything else. | Basically, this playbook aims to get you up-and-running with all the necessities around Matrix, without you having to do anything else. | ||||
| **Note**: the list above is exhaustive. It includes optional or even some advanced components that you will most likely not need. | **Note**: the list above is exhaustive. It includes optional or even some advanced components that you will most likely not need. | ||||
| @@ -51,7 +51,7 @@ docker run -it --rm \ | |||||
| -v `pwd`:/work \ | -v `pwd`:/work \ | ||||
| -v $HOME/.ssh/id_rsa:/root/.ssh/id_rsa:ro \ | -v $HOME/.ssh/id_rsa:/root/.ssh/id_rsa:ro \ | ||||
| --entrypoint=/bin/sh \ | --entrypoint=/bin/sh \ | ||||
| docker.io/devture/ansible:2.10.7-r0 | |||||
| docker.io/devture/ansible:2.11.6-r1 | |||||
| ``` | ``` | ||||
| The above command tries to mount an SSH key (`$HOME/.ssh/id_rsa`) into the container (at `/root/.ssh/id_rsa`). | The above command tries to mount an SSH key (`$HOME/.ssh/id_rsa`) into the container (at `/root/.ssh/id_rsa`). | ||||
| @@ -4,7 +4,7 @@ An AWX setup for managing multiple Matrix servers. | |||||
| This section is used in an AWX system that can create and manage multiple [Matrix](http://matrix.org/) servers. You can issue members an AWX login to their own 'organisation', which they can use to manage/configure 1 to N servers. | This section is used in an AWX system that can create and manage multiple [Matrix](http://matrix.org/) servers. You can issue members an AWX login to their own 'organisation', which they can use to manage/configure 1 to N servers. | ||||
| Members can be assigned a server from Digitalocean, or they can connect their own on-premises server. This script is free to use in a commercial context with the 'MemberPress Plus' and 'WP Oauth Sever' addons. It can also be run in a non-commercial context. | |||||
| Members can be assigned a server from Digitalocean, or they can connect their own on-premises server. These playbooks are free to use in a commercial context with the 'MemberPress Plus' plugin. They can also be run in a non-commercial context. | |||||
| The AWX system is arranged into 'members' each with their own 'subscriptions'. After creating a subscription the user enters the 'provision stage' where they defined the URLs they will use, the servers location and whether or not there's already a website at the base domain. They then proceed onto the 'deploy stage' where they can configure their Matrix server. | The AWX system is arranged into 'members' each with their own 'subscriptions'. After creating a subscription the user enters the 'provision stage' where they defined the URLs they will use, the servers location and whether or not there's already a website at the base domain. They then proceed onto the 'deploy stage' where they can configure their Matrix server. | ||||
| @@ -21,12 +21,7 @@ The following repositories allow you to copy and use this setup: | |||||
| [Ansible Provision Server](https://gitlab.com/GoMatrixHosting/ansible-provision-server) - Used by AWX members to perform initial configuration of their DigitalOcean or On-Premises server. | [Ansible Provision Server](https://gitlab.com/GoMatrixHosting/ansible-provision-server) - Used by AWX members to perform initial configuration of their DigitalOcean or On-Premises server. | ||||
| ## Testing Fork For This Playbook | |||||
| Updates to this section are trailed here: | |||||
| [GoMatrixHosting Matrix Docker Ansible Deploy](https://gitlab.com/GoMatrixHosting/matrix-docker-ansible-deploy) | |||||
| [GMHosting External Tools](https://gitlab.com/GoMatrixHosting/gmhosting-external-tools) - Extra tools we run outside of AWX, some of which are experimental. | |||||
| ## Does I need an AWX setup to use this? How do I configure it? | ## Does I need an AWX setup to use this? How do I configure it? | ||||
| @@ -38,7 +33,6 @@ For simpler installation steps you can use to get started with this system, chec | |||||
| ## Does I need a front-end WordPress site? And a DigitalOcean account? | ## Does I need a front-end WordPress site? And a DigitalOcean account? | ||||
| You do not need a front-end WordPress site or any of the mentioned WordPress plugins to use this setup. It can be run on it's own in a non-commercial context. | |||||
| You also don't need a DigitalOcean account, but this will limit you to only being able to connect 'On-Premises' servers. | |||||
| You do not need a front-end WordPress site or the MemberPress plugin to use this setup. It can be run on it's own in a non-commercial context. | |||||
| You also don't need a DigitalOcean account, although this will limit you to only being able to connect 'On-Premises' servers. | |||||
| @@ -37,6 +37,7 @@ If you are using Cloudflare DNS, make sure to disable the proxy and set all reco | |||||
| | CNAME | `goneb` | - | - | - | `matrix.<your-domain>` | | | CNAME | `goneb` | - | - | - | `matrix.<your-domain>` | | ||||
| | CNAME | `sygnal` | - | - | - | `matrix.<your-domain>` | | | CNAME | `sygnal` | - | - | - | `matrix.<your-domain>` | | ||||
| | CNAME | `hydrogen` | - | - | - | `matrix.<your-domain>` | | | CNAME | `hydrogen` | - | - | - | `matrix.<your-domain>` | | ||||
| | CNAME | `cinny` | - | - | - | `matrix.<your-domain>` | | |||||
| ## Subdomains setup | ## Subdomains setup | ||||
| @@ -57,6 +58,7 @@ The `sygnal.<your-domain>` subdomain may be necessary, because this playbook cou | |||||
| The `hydrogen.<your-domain>` subdomain may be necessary, because this playbook could install the [Hydrogen](https://github.com/vector-im/hydrogen-web) web client. The installation of Hydrogen is disabled by default, it is not a core required component. To learn how to install it, see our [configuring Hydrogen guide](configuring-playbook-client-hydrogen.md). If you do not wish to set up Hydrogen, feel free to skip the `hydrogen.<your-domain>` DNS record. | The `hydrogen.<your-domain>` subdomain may be necessary, because this playbook could install the [Hydrogen](https://github.com/vector-im/hydrogen-web) web client. The installation of Hydrogen is disabled by default, it is not a core required component. To learn how to install it, see our [configuring Hydrogen guide](configuring-playbook-client-hydrogen.md). If you do not wish to set up Hydrogen, feel free to skip the `hydrogen.<your-domain>` DNS record. | ||||
| The `cinny.<your-domain>` subdomain may be necessary, because this playbook could install the [Cinny](https://github.com/ajbura/cinny) web client. The installation of cinny is disabled by default, it is not a core required component. To learn how to install it, see our [configuring cinny guide](configuring-playbook-client-cinny.md). If you do not wish to set up cinny, feel free to skip the `cinny.<your-domain>` DNS record. | |||||
| ## `_matrix-identity._tcp` SRV record setup | ## `_matrix-identity._tcp` SRV record setup | ||||
| @@ -198,8 +198,8 @@ matrix_bot_go_neb_services: | |||||
| # Each room will get the notification with the alert rendered with the given template | # Each room will get the notification with the alert rendered with the given template | ||||
| rooms: | rooms: | ||||
| "!someroomid:domain.tld": | "!someroomid:domain.tld": | ||||
| text_template: "{{range .Alerts -}} [{{ .Status }}] {{index .Labels \"alertname\" }}: {{index .Annotations \"description\"}} {{ end -}}" | |||||
| html_template: "{{range .Alerts -}} {{ $severity := index .Labels \"severity\" }} {{ if eq .Status \"firing\" }} {{ if eq $severity \"critical\"}} <font color='red'><b>[FIRING - CRITICAL]</b></font> {{ else if eq $severity \"warning\"}} <font color='orange'><b>[FIRING - WARNING]</b></font> {{ else }} <b>[FIRING - {{ $severity }}]</b> {{ end }} {{ else }} <font color='green'><b>[RESOLVED]</b></font> {{ end }} {{ index .Labels \"alertname\"}} : {{ index .Annotations \"description\"}} <a href=\"{{ .GeneratorURL }}\">source</a><br/>{{end -}}" | |||||
| text_template: "{% raw %}{{range .Alerts -}} [{{ .Status }}] {{index .Labels \"alertname\" }}: {{index .Annotations \"description\"}} {{ end -}}{% endraw %}" | |||||
| html_template: "{% raw %}{{range .Alerts -}} {{ $severity := index .Labels \"severity\" }} {{ if eq .Status \"firing\" }} {{ if eq $severity \"critical\"}} <font color='red'><b>[FIRING - CRITICAL]</b></font> {{ else if eq $severity \"warning\"}} <font color='orange'><b>[FIRING - WARNING]</b></font> {{ else }} <b>[FIRING - {{ $severity }}]</b> {{ end }} {{ else }} <font color='green'><b>[RESOLVED]</b></font> {{ end }} {{ index .Labels \"alertname\"}} : {{ index .Annotations \"description\"}} <a href=\"{{ .GeneratorURL }}\">source</a><br/>{{end -}}{% endraw %}" | |||||
| msg_type: "m.text" # Must be either `m.text` or `m.notice` | msg_type: "m.text" # Must be either `m.text` or `m.notice` | ||||
| ``` | ``` | ||||
| @@ -0,0 +1,55 @@ | |||||
| # Setting up Honoroit (optional) | |||||
| The playbook can install and configure [Honoroit](https://gitlab.com/etke.cc/honoroit) for you. | |||||
| It's a bot you can use to setup **your own helpdesk on matrix** | |||||
| See the project's [documentation](https://gitlab.com/etke.cc/honoroit#how-it-looks-like) to learn what it does with screenshots and why it might be useful to you. | |||||
| ## Registering the bot user | |||||
| By default, the playbook will set up the bot with a username like this: `@honoroit:DOMAIN`. | |||||
| (to use a different username, adjust the `matrix_bot_honoroit_login` variable). | |||||
| You **need to register the bot user manually** before setting up the bot. You can use the playbook to [register a new user](registering-users.md): | |||||
| ``` | |||||
| ansible-playbook -i inventory/hosts setup.yml --extra-vars='username=honoroit password=PASSWORD_FOR_THE_BOT admin=no' --tags=register-user | |||||
| ``` | |||||
| Choose a strong password for the bot. You can generate a good password with a command like this: `pwgen -s 64 1`. | |||||
| ## Adjusting the playbook configuration | |||||
| Add the following configuration to your `inventory/host_vars/matrix.DOMAIN/vars.yml` file: | |||||
| ```yaml | |||||
| matrix_bot_honoroit_enabled: true | |||||
| # Adjust this to whatever password you chose when registering the bot user | |||||
| matrix_bot_honoroit_password: PASSWORD_FOR_THE_BOT | |||||
| # Adjust this to your room ID | |||||
| matrix_bot_honoroit_roomid: "!yourRoomID:DOMAIN" | |||||
| ``` | |||||
| ## Installing | |||||
| After configuring the playbook, run the [installation](installing.md) command again: | |||||
| ``` | |||||
| ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start | |||||
| ``` | |||||
| ## Usage | |||||
| To use the bot, invite the `@honoroit:DOMAIN` to the room you specified in config, after that any matrix user can send a message to the `@honoroit:DOMAIN` to start a new thread in that room. | |||||
| Send `!ho help` to the room to see the bot's help menu for additional commands. | |||||
| You can also refer to the upstream [documentation](https://gitlab.com/etke.cc/honoroit#features). | |||||
| @@ -0,0 +1,35 @@ | |||||
| # Setting up Mautrix Twitter (optional) | |||||
| **Note**: bridging to [Twitter](https://twitter.com/) can also happen via the [mx-puppet-twitter](configuring-playbook-bridge-mx-puppet-twitter.md) bridge supported by the playbook. | |||||
| The playbook can install and configure [mautrix-twitter](https://github.com/mautrix/twitter) for you. | |||||
| See the project's [documentation](https://github.com/mautrix/twitter) to learn what it does and why it might be useful to you. | |||||
| ```yaml | |||||
| matrix_mautrix_twitter_enabled: true | |||||
| ``` | |||||
| ## Set up Double Puppeting | |||||
| If you'd like to use [Double Puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html) (hint: you most likely do), you have 2 ways of going about it. | |||||
| ### Method 1: automatically, by enabling Shared Secret Auth | |||||
| The bridge will automatically perform Double Puppeting if you enable [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) for this playbook. | |||||
| This is the recommended way of setting up Double Puppeting, as it's easier to accomplish, works for all your users automatically, and has less of a chance of breaking in the future. | |||||
| ### Method 2: manually, by asking each user to provide a working access token | |||||
| This method is currently not available for the Mautrix-Twitter bridge, but is on the [roadmap](https://github.com/mautrix/twitter/blob/master/ROADMAP.md) under Misc/Manual login with `login-matrix` | |||||
| ## Usage | |||||
| 1. You then need to start a chat with `@twitterbot:YOUR_DOMAIN` (where `YOUR_DOMAIN` is your base domain, not the `matrix.` domain). | |||||
| 2. Send login-cookie to start the login. The bot should respond with instructions on how to proceed. | |||||
| You can learn more here about authentication from the bridge's [official documentation on Authentication](https://docs.mau.fi/bridges/python/twitter/authentication.html). | |||||
| After successfully enabling bridging, you may wish to [set up Double Puppeting](#set-up-double-puppeting), if you haven't already done so. | |||||
| @@ -1,5 +1,7 @@ | |||||
| # Setting up MX Puppet Twitter (optional) | # Setting up MX Puppet Twitter (optional) | ||||
| **Note**: bridging to [Twitter](https://twitter.com/) can also happen via the [mautrix-twitter](configuring-playbook-bridge-mautrix-twitter.md) bridge supported by the playbook. | |||||
| The playbook can install and configure | The playbook can install and configure | ||||
| [mx-puppet-twitter](https://github.com/Sorunome/mx-puppet-twitter) for you. | [mx-puppet-twitter](https://github.com/Sorunome/mx-puppet-twitter) for you. | ||||
| @@ -0,0 +1,21 @@ | |||||
| # Configuring Cinny (optional) | |||||
| This playbook can install the [cinny](https://github.com/ajbura/cinny) Matrix web client for you. | |||||
| cinny is a web client focusing primarily on simple, elegant and secure interface. | |||||
| cinny can be installed alongside or instead of Element. | |||||
| If you'd like cinny to be installed, add the following to your configuration file (`inventory/host_vars/matrix.<your-domain>/vars.yml`): | |||||
| ```yaml | |||||
| matrix_client_cinny_enabled: true | |||||
| ``` | |||||
| You will also need to add a DNS record so that cinny can be accessed. | |||||
| By default cinny will use https://cinny.DOMAIN so you will need to create an CNAME record | |||||
| for `cinny`. See [Configuring DNS](configuring-dns.md). | |||||
| If you would like to use a different domain, add the following to your configuration file (changing it to use your preferred domain): | |||||
| ```yaml | |||||
| matrix_server_fqn_cinny: "app.{{ matrix_domain }}" | |||||
| ``` | |||||
| @@ -58,7 +58,7 @@ curl -X POST --header 'Content-Type: application/json' -d '{ | |||||
| "type": "m.login.password" | "type": "m.login.password" | ||||
| }' 'https://matrix.YOURDOMAIN/_matrix/client/r0/login' | }' 'https://matrix.YOURDOMAIN/_matrix/client/r0/login' | ||||
| ``` | ``` | ||||
| *Change the "YourDimensionUser/Pass" URL accordigly* | |||||
| *Change `YourDimensionUsername`, `YourDimensionPassword`, and `YOURDOMAIN` accordingly.* | |||||
| **Access tokens are sensitive information. Do not include them in any bug reports, messages, or logs. Do not share the access token with anyone.** | **Access tokens are sensitive information. Do not include them in any bug reports, messages, or logs. Do not share the access token with anyone.** | ||||
| @@ -25,6 +25,23 @@ The Dimension administrator users can configure the default URL template. The Di | |||||
| If you wish to disable the Etherpad chat button, you can do it by appending `?showChat=false` to the end of the pad URL, or the template. | If you wish to disable the Etherpad chat button, you can do it by appending `?showChat=false` to the end of the pad URL, or the template. | ||||
| Example: `https://dimension.<your-domain>/etherpad/p/$roomId_$padName?showChat=false` | Example: `https://dimension.<your-domain>/etherpad/p/$roomId_$padName?showChat=false` | ||||
| ### Etherpad Admin access (optional) | |||||
| Etherpad comes with a admin web-UI which is disabled by default. You can enable it by setting a username and password in your configuration file (`inventory/host_vars/matrix.<your-domain>/vars.yml`): | |||||
| ```yaml | |||||
| matrix_etherpad_admin_username: admin | |||||
| matrix_etherpad_admin_password: some-password | |||||
| ``` | |||||
| The admin web-UI should then be available on: `https://dimension.<your-domain>/etherpad/admin` | |||||
| ### Managing / Deleting old pads | |||||
| If you want to manage and remove old unused pads from Etherpad, you will first need to able Admin access as described above. | |||||
| Then from the plugin manager page (`https://dimension.<your-domain>/etherpad/admin/plugins`), install the `adminpads2` plugin. Once installed, you should have a "Manage pads" section in the Admin web-UI. | |||||
| ## Known issues | ## Known issues | ||||
| If your Etherpad widget fails to load, this might be due to Dimension generating a Pad name so long, the Etherpad app rejects it. | If your Etherpad widget fails to load, this might be due to Dimension generating a Pad name so long, the Etherpad app rejects it. | ||||
| @@ -64,7 +64,7 @@ Once you've followed the [Preparation](#preparation) guide above, you can take a | |||||
| ### Using your own external caddy webserver | ### Using your own external caddy webserver | ||||
| After following the [Preparation](#preparation) guide above, you can take a look at the [examples/caddy](../examples/caddy) directory for a sample configuration. | |||||
| After following the [Preparation](#preparation) guide above, you can take a look at the [examples/caddy](../examples/caddy) directory and [examples/caddy2](../examples/caddy2) directory for a sample configuration for Caddy v1 and v2, respectively. | |||||
| ### Using your own HAproxy reverse proxy | ### Using your own HAproxy reverse proxy | ||||
| After following the [Preparation](#preparation) guide above, you can take a look at the [examples/haproxy](../examples/haproxy) directory for a sample configuration. In this case HAproxy is used as a reverse proxy and a simple Nginx container is used to serve statically `.well-known` files. | After following the [Preparation](#preparation) guide above, you can take a look at the [examples/haproxy](../examples/haproxy) directory for a sample configuration. In this case HAproxy is used as a reverse proxy and a simple Nginx container is used to serve statically `.well-known` files. | ||||
| @@ -69,6 +69,7 @@ When you're done with all the configuration you'd like to do, continue with [Ins | |||||
| - [Adjusting email-sending settings](configuring-playbook-email.md) (optional) | - [Adjusting email-sending settings](configuring-playbook-email.md) (optional) | ||||
| - [Setting up Hydrogen](configuring-playbook-client-hydrogen.md) - a new lightweight matrix client with legacy and mobile browser support (optional) | - [Setting up Hydrogen](configuring-playbook-client-hydrogen.md) - a new lightweight matrix client with legacy and mobile browser support (optional) | ||||
| - [Setting up Cinny](configuring-playbook-client-cinny.md) - a web client focusing primarily on simple, elegant and secure interface (optional) | |||||
| ### Authentication and user-related | ### Authentication and user-related | ||||
| @@ -102,6 +103,8 @@ When you're done with all the configuration you'd like to do, continue with [Ins | |||||
| - [Setting up Mautrix Instagram bridging](configuring-playbook-bridge-mautrix-instagram.md) (optional) | - [Setting up Mautrix Instagram bridging](configuring-playbook-bridge-mautrix-instagram.md) (optional) | ||||
| - [Setting up Mautrix Twitter bridging](configuring-playbook-bridge-mautrix-twitter.md) (optional) | |||||
| - [Setting up Mautrix Signal bridging](configuring-playbook-bridge-mautrix-signal.md) (optional) | - [Setting up Mautrix Signal bridging](configuring-playbook-bridge-mautrix-signal.md) (optional) | ||||
| - [Setting up Appservice IRC bridging](configuring-playbook-bridge-appservice-irc.md) (optional) | - [Setting up Appservice IRC bridging](configuring-playbook-bridge-appservice-irc.md) (optional) | ||||
| @@ -139,6 +142,8 @@ When you're done with all the configuration you'd like to do, continue with [Ins | |||||
| - [Setting up matrix-reminder-bot](configuring-playbook-bot-matrix-reminder-bot.md) - a bot to remind you about stuff (optional) | - [Setting up matrix-reminder-bot](configuring-playbook-bot-matrix-reminder-bot.md) - a bot to remind you about stuff (optional) | ||||
| - [Setting up honoroit](configuring-playbook-bot-honoroit.md) - a helpdesk bot (optional) | |||||
| - [Setting up Go-NEB](configuring-playbook-bot-go-neb.md) - an extensible multifunctional bot (optional) | - [Setting up Go-NEB](configuring-playbook-bot-go-neb.md) - an extensible multifunctional bot (optional) | ||||
| - [Setting up Mjolnir](configuring-playbook-bot-mjolnir.md) - a moderation tool/bot (optional) | - [Setting up Mjolnir](configuring-playbook-bot-mjolnir.md) - a moderation tool/bot (optional) | ||||
| @@ -30,6 +30,8 @@ These services are enabled and used by default, but you can turn them off, if yo | |||||
| These services are not part of our default installation, but can be enabled by [configuring the playbook](configuring-playbook.md) (either before the initial installation or any time later): | These services are not part of our default installation, but can be enabled by [configuring the playbook](configuring-playbook.md) (either before the initial installation or any time later): | ||||
| - [matrixdotorg/dendrite-monolith](https://hub.docker.com/r/matrixdotorg/dendrite-monolith/) - the official [Dendrite](https://github.com/matrix-org/dendrite) Matrix homeserver (optional) | |||||
| - [ewoutp/goofys](https://hub.docker.com/r/ewoutp/goofys/) - the [Goofys](https://github.com/kahing/goofys) Amazon [S3](https://aws.amazon.com/s3/) file-system-mounting program (optional) | - [ewoutp/goofys](https://hub.docker.com/r/ewoutp/goofys/) - the [Goofys](https://github.com/kahing/goofys) Amazon [S3](https://aws.amazon.com/s3/) file-system-mounting program (optional) | ||||
| - [etherpad/etherpad](https://hub.docker.com/r/etherpad/etherpad/) - the [Etherpad](https://etherpad.org) realtime collaborative text editor that can be used in a Jitsi audio/video call or integrated as a widget into Matrix chat rooms via the Dimension integration manager (optional) | - [etherpad/etherpad](https://hub.docker.com/r/etherpad/etherpad/) - the [Etherpad](https://etherpad.org) realtime collaborative text editor that can be used in a Jitsi audio/video call or integrated as a widget into Matrix chat rooms via the Dimension integration manager (optional) | ||||
| @@ -46,6 +48,8 @@ These services are not part of our default installation, but can be enabled by [ | |||||
| - [mautrix/facebook](https://mau.dev/mautrix/facebook/container_registry) - the [mautrix-facebook](https://github.com/mautrix/facebook) bridge to [Facebook](https://facebook.com/) (optional) | - [mautrix/facebook](https://mau.dev/mautrix/facebook/container_registry) - the [mautrix-facebook](https://github.com/mautrix/facebook) bridge to [Facebook](https://facebook.com/) (optional) | ||||
| - [mautrix/twitter](https://mau.dev/mautrix/twitter/container_registry) - the [mautrix-twitter](https://github.com/mautrix/twitter) bridge to [Twitter](https://twitter.com/) (optional) | |||||
| - [mautrix/hangouts](https://mau.dev/mautrix/hangouts/container_registry) - the [mautrix-hangouts](https://github.com/mautrix/hangouts) bridge to [Google Hangouts](https://en.wikipedia.org/wiki/Google_Hangouts) (optional) | - [mautrix/hangouts](https://mau.dev/mautrix/hangouts/container_registry) - the [mautrix-hangouts](https://github.com/mautrix/hangouts) bridge to [Google Hangouts](https://en.wikipedia.org/wiki/Google_Hangouts) (optional) | ||||
| - [mautrix/googlechat](https://mau.dev/mautrix/googlechat/container_registry) - the [mautrix-googlechat](https://github.com/mautrix/googlechat) bridge to [Google Chat](https://en.wikipedia.org/wiki/Google_Chat) (optional) | - [mautrix/googlechat](https://mau.dev/mautrix/googlechat/container_registry) - the [mautrix-googlechat](https://github.com/mautrix/googlechat) bridge to [Google Chat](https://en.wikipedia.org/wiki/Google_Chat) (optional) | ||||
| @@ -90,6 +94,8 @@ These services are not part of our default installation, but can be enabled by [ | |||||
| - [anoa/matrix-reminder-bot](https://hub.docker.com/r/anoa/matrix-reminder-bot) - the [matrix-reminder-bot](https://github.com/anoadragon453/matrix-reminder-bot) bot for one-off & recurring reminders and alarms (optional) | - [anoa/matrix-reminder-bot](https://hub.docker.com/r/anoa/matrix-reminder-bot) - the [matrix-reminder-bot](https://github.com/anoadragon453/matrix-reminder-bot) bot for one-off & recurring reminders and alarms (optional) | ||||
| - [etke.cc/honoroit](https://gitlab.com/etke.cc/honoroit/container_registry) - the [honoroit](https://gitlab.com/etke.cc/honoroit) helpdesk bot (optional) | |||||
| - [matrixdotorg/go-neb](https://hub.docker.com/r/matrixdotorg/go-neb) - the [Go-NEB](https://github.com/matrix-org/go-neb) bot (optional) | - [matrixdotorg/go-neb](https://hub.docker.com/r/matrixdotorg/go-neb) - the [Go-NEB](https://github.com/matrix-org/go-neb) bot (optional) | ||||
| - [matrixdotorg/mjolnir](https://hub.docker.com/r/matrixdotorg/mjolnir) - the [mjolnir](https://github.com/matrix-org/mjolnir) moderation bot (optional) | - [matrixdotorg/mjolnir](https://hub.docker.com/r/matrixdotorg/mjolnir) - the [mjolnir](https://github.com/matrix-org/mjolnir) moderation bot (optional) | ||||
| @@ -15,6 +15,7 @@ List of roles where self-building the Docker image is currently possible: | |||||
| - `matrix-synapse-admin` | - `matrix-synapse-admin` | ||||
| - `matrix-client-element` | - `matrix-client-element` | ||||
| - `matrix-client-hydrogen` | - `matrix-client-hydrogen` | ||||
| - `matrix-client-cinny` | |||||
| - `matrix-registration` | - `matrix-registration` | ||||
| - `matrix-coturn` | - `matrix-coturn` | ||||
| - `matrix-corporal` | - `matrix-corporal` | ||||
| @@ -24,6 +25,7 @@ List of roles where self-building the Docker image is currently possible: | |||||
| - `matrix-bridge-appservice-irc` | - `matrix-bridge-appservice-irc` | ||||
| - `matrix-bridge-appservice-slack` | - `matrix-bridge-appservice-slack` | ||||
| - `matrix-bridge-appservice-webhooks` | - `matrix-bridge-appservice-webhooks` | ||||
| - `matrix-bridge-beeper-linkedin` | |||||
| - `matrix-bridge-mautrix-facebook` | - `matrix-bridge-mautrix-facebook` | ||||
| - `matrix-bridge-mautrix-hangouts` | - `matrix-bridge-mautrix-hangouts` | ||||
| - `matrix-bridge-mautrix-googlechat` | - `matrix-bridge-mautrix-googlechat` | ||||
| @@ -32,6 +34,7 @@ List of roles where self-building the Docker image is currently possible: | |||||
| - `matrix-bridge-mautrix-whatsapp` | - `matrix-bridge-mautrix-whatsapp` | ||||
| - `matrix-bridge-mx-puppet-skype` | - `matrix-bridge-mx-puppet-skype` | ||||
| - `matrix-bot-mjolnir` | - `matrix-bot-mjolnir` | ||||
| - `matrix-bot-honoroit` | |||||
| - `matrix-bot-matrix-reminder-bot` | - `matrix-bot-matrix-reminder-bot` | ||||
| - `matrix-email2matrix` | - `matrix-email2matrix` | ||||
| @@ -27,6 +27,10 @@ matrix.DOMAIN.tld { | |||||
| not path /matrix/static-files/* | not path /matrix/static-files/* | ||||
| } | } | ||||
| @wellknown { | |||||
| path /.well-known/matrix/* | |||||
| } | |||||
| header { | header { | ||||
| # Enable HTTP Strict Transport Security (HSTS) to force clients to always connect via HTTPS | # Enable HTTP Strict Transport Security (HSTS) to force clients to always connect via HTTPS | ||||
| Strict-Transport-Security "max-age=31536000; includeSubDomains; preload" | Strict-Transport-Security "max-age=31536000; includeSubDomains; preload" | ||||
| @@ -69,6 +73,15 @@ matrix.DOMAIN.tld { | |||||
| } | } | ||||
| } | } | ||||
| handle @wellknown { | |||||
| encode zstd gzip | |||||
| root * /matrix/static-files | |||||
| header Cache-Control max-age=14400 | |||||
| header Content-Type application/json | |||||
| header Access-Control-Allow-Origin * | |||||
| file_server | |||||
| } | |||||
| handle { | handle { | ||||
| encode zstd gzip | encode zstd gzip | ||||
| @@ -102,17 +115,17 @@ element.DOMAIN.tld { | |||||
| # tls your@email.com | # tls your@email.com | ||||
| header { | header { | ||||
| # Enable HTTP Strict Transport Security (HSTS) to force clients to always connect via HTTPS | |||||
| Strict-Transport-Security "max-age=31536000; includeSubDomains; preload" | |||||
| # Enable cross-site filter (XSS) and tell browser to block detected attacks | |||||
| X-XSS-Protection "1; mode=block" | |||||
| # Prevent some browsers from MIME-sniffing a response away from the declared Content-Type | |||||
| X-Content-Type-Options "nosniff" | |||||
| # Disallow the site to be rendered within a frame (clickjacking protection) | |||||
| X-Frame-Options "DENY" | |||||
| # X-Robots-Tag | |||||
| X-Robots-Tag "noindex, noarchive, nofollow" | |||||
| } | |||||
| # Enable HTTP Strict Transport Security (HSTS) to force clients to always connect via HTTPS | |||||
| Strict-Transport-Security "max-age=31536000; includeSubDomains; preload" | |||||
| # Enable cross-site filter (XSS) and tell browser to block detected attacks | |||||
| X-XSS-Protection "1; mode=block" | |||||
| # Prevent some browsers from MIME-sniffing a response away from the declared Content-Type | |||||
| X-Content-Type-Options "nosniff" | |||||
| # Disallow the site to be rendered within a frame (clickjacking protection) | |||||
| X-Frame-Options "DENY" | |||||
| # X-Robots-Tag | |||||
| X-Robots-Tag "noindex, noarchive, nofollow" | |||||
| } | |||||
| handle { | handle { | ||||
| encode zstd gzip | encode zstd gzip | ||||
| @@ -10,6 +10,14 @@ | |||||
| # Example value: example.com | # Example value: example.com | ||||
| matrix_domain: YOUR_BARE_DOMAIN_NAME_HERE | matrix_domain: YOUR_BARE_DOMAIN_NAME_HERE | ||||
| # The Matrix homeserver software to install. | |||||
| # See `roles/matrix-base/defaults/main.yml` for valid options. | |||||
| matrix_homeserver_implementation: synapse | |||||
| # A secret used as a base, for generating various other secrets. | |||||
| # You can put any string here, but generating a strong one is preferred (e.g. `pwgen -s 64 1`). | |||||
| matrix_homeserver_generic_secret_key: '' | |||||
| # This is something which is provided to Let's Encrypt when retrieving SSL certificates for domains. | # This is something which is provided to Let's Encrypt when retrieving SSL certificates for domains. | ||||
| # | # | ||||
| # In case SSL renewal fails at some point, you'll also get an email notification there. | # In case SSL renewal fails at some point, you'll also get an email notification there. | ||||
| @@ -20,14 +28,6 @@ matrix_domain: YOUR_BARE_DOMAIN_NAME_HERE | |||||
| # Example value: someone@example.com | # Example value: someone@example.com | ||||
| matrix_ssl_lets_encrypt_support_email: '' | matrix_ssl_lets_encrypt_support_email: '' | ||||
| # A shared secret (between Coturn and Synapse) used for authentication. | |||||
| # You can put any string here, but generating a strong one is preferred (e.g. `pwgen -s 64 1`). | |||||
| matrix_coturn_turn_static_auth_secret: '' | |||||
| # A secret used to protect access keys issued by the server. | |||||
| # You can put any string here, but generating a strong one is preferred (e.g. `pwgen -s 64 1`). | |||||
| matrix_synapse_macaroon_secret_key: '' | |||||
| # A Postgres password to use for the superuser Postgres user (called `matrix` by default). | # A Postgres password to use for the superuser Postgres user (called `matrix` by default). | ||||
| # | # | ||||
| # The playbook creates additional Postgres users and databases (one for each enabled service) | # The playbook creates additional Postgres users and databases (one for each enabled service) | ||||
| @@ -1 +1,6 @@ | |||||
| matrix_awx_enabled: true | matrix_awx_enabled: true | ||||
| # Defaults for 'Customise Website + Access Export' template | |||||
| awx_sftp_auth_method: 'Disabled' | |||||
| awx_sftp_password: '' | |||||
| awx_sftp_public_key: '' | |||||
| @@ -8,9 +8,9 @@ | |||||
| tags: | tags: | ||||
| - always | - always | ||||
| # Renames the variables if needed | |||||
| # Renames or updates the vars.yml if needed | |||||
| - include_tasks: | - include_tasks: | ||||
| file: "rename_variables.yml" | |||||
| file: "update_variables.yml" | |||||
| apply: | apply: | ||||
| tags: always | tags: always | ||||
| when: run_setup|bool and matrix_awx_enabled|bool | when: run_setup|bool and matrix_awx_enabled|bool | ||||
| @@ -29,9 +29,9 @@ | |||||
| when: (awx_purge_mode.find("No local users [recommended]") != -1) or (awx_purge_mode.find("Number of users [slower]") != -1) or (awx_purge_mode.find("Number of events [slower]") != -1) | when: (awx_purge_mode.find("No local users [recommended]") != -1) or (awx_purge_mode.find("Number of users [slower]") != -1) or (awx_purge_mode.find("Number of events [slower]") != -1) | ||||
| register: awx_synapse_container_ip | register: awx_synapse_container_ip | ||||
| - name: Collect access token for @_janitor user | |||||
| - name: Collect access token for @admin-janitor user | |||||
| shell: | | shell: | | ||||
| curl -X POST -d '{"type":"m.login.password", "user":"_janitor", "password":"{{ awx_janitor_user_password }}"}' "{{ awx_synapse_container_ip.stdout }}:{{ matrix_synapse_container_client_api_port }}/_matrix/client/r0/login" | jq '.access_token' | |||||
| curl -X POST -d '{"type":"m.login.password", "user":"admin-janitor", "password":"{{ awx_janitor_user_password }}"}' "{{ awx_synapse_container_ip.stdout }}:{{ matrix_synapse_container_client_api_port }}/_matrix/client/r0/login" | jq '.access_token' | |||||
| when: (awx_purge_mode.find("No local users [recommended]") != -1) or (awx_purge_mode.find("Number of users [slower]") != -1) or (awx_purge_mode.find("Number of events [slower]") != -1) | when: (awx_purge_mode.find("No local users [recommended]") != -1) or (awx_purge_mode.find("Number of users [slower]") != -1) or (awx_purge_mode.find("Number of events [slower]") != -1) | ||||
| register: awx_janitors_token | register: awx_janitors_token | ||||
| no_log: True | no_log: True | ||||
| @@ -21,9 +21,9 @@ | |||||
| shell: "/usr/bin/docker inspect --format '{''{range.NetworkSettings.Networks}''}{''{.IPAddress}''}{''{end}''}' matrix-synapse" | shell: "/usr/bin/docker inspect --format '{''{range.NetworkSettings.Networks}''}{''{.IPAddress}''}{''{end}''}' matrix-synapse" | ||||
| register: awx_synapse_container_ip | register: awx_synapse_container_ip | ||||
| - name: Collect access token for @_janitor user | |||||
| - name: Collect access token for @admin-janitor user | |||||
| shell: | | shell: | | ||||
| curl -XPOST -d '{"type":"m.login.password", "user":"_janitor", "password":"{{ awx_janitor_user_password }}"}' "{{ awx_synapse_container_ip.stdout }}:{{ matrix_synapse_container_client_api_port }}/_matrix/client/r0/login" | jq '.access_token' | |||||
| curl -XPOST -d '{"type":"m.login.password", "user":"admin-janitor", "password":"{{ awx_janitor_user_password }}"}' "{{ awx_synapse_container_ip.stdout }}:{{ matrix_synapse_container_client_api_port }}/_matrix/client/r0/login" | jq '.access_token' | |||||
| register: awx_janitors_token | register: awx_janitors_token | ||||
| no_log: True | no_log: True | ||||
| @@ -1,8 +0,0 @@ | |||||
| --- | |||||
| - name: Rename synapse presence variable | |||||
| delegate_to: 127.0.0.1 | |||||
| replace: | |||||
| path: "/var/lib/awx/projects/clients/{{ member_id }}/{{ subscription_id }}/matrix_vars.yml" | |||||
| regexp: 'matrix_synapse_use_presence' | |||||
| replace: 'matrix_synapse_presence_enabled' | |||||
| @@ -50,12 +50,14 @@ | |||||
| - name: Calculate size of local media repository | - name: Calculate size of local media repository | ||||
| shell: du -sh /matrix/synapse/storage/media-store/local* | shell: du -sh /matrix/synapse/storage/media-store/local* | ||||
| register: awx_local_media_size_stat | register: awx_local_media_size_stat | ||||
| async: 600 | |||||
| ignore_errors: yes | ignore_errors: yes | ||||
| no_log: True | no_log: True | ||||
| - name: Calculate size of remote media repository | - name: Calculate size of remote media repository | ||||
| shell: du -sh /matrix/synapse/storage/media-store/remote* | shell: du -sh /matrix/synapse/storage/media-store/remote* | ||||
| register: awx_remote_media_size_stat | register: awx_remote_media_size_stat | ||||
| async: 600 | |||||
| ignore_errors: yes | ignore_errors: yes | ||||
| no_log: True | no_log: True | ||||
| @@ -12,9 +12,9 @@ | |||||
| - curl | - curl | ||||
| state: present | state: present | ||||
| - name: Collect access token of @_dimension user | |||||
| - name: Collect access token of @admin-dimension user | |||||
| shell: | | shell: | | ||||
| curl -X POST --header 'Content-Type: application/json' -d '{ "identifier": { "type": "m.id.user","user": "_dimension" }, "password": "{{ awx_dimension_user_password }}", "type": "m.login.password"}' 'https://matrix.{{ matrix_domain }}/_matrix/client/r0/login' | jq -c '. | {access_token}' | sed 's/.*\":\"//' | sed 's/\"}//' | |||||
| curl -X POST --header 'Content-Type: application/json' -d '{ "identifier": { "type": "m.id.user","user": "admin-dimension" }, "password": "{{ awx_dimension_user_password }}", "type": "m.login.password"}' 'https://matrix.{{ matrix_domain }}/_matrix/client/r0/login' | jq -c '. | {access_token}' | sed 's/.*\":\"//' | sed 's/\"}//' | |||||
| register: awx_dimension_user_access_token | register: awx_dimension_user_access_token | ||||
| - name: Record Synapse variables locally on AWX | - name: Record Synapse variables locally on AWX | ||||
| @@ -0,0 +1,26 @@ | |||||
| --- | |||||
| - name: Rename synapse presence variable | |||||
| delegate_to: 127.0.0.1 | |||||
| replace: | |||||
| path: "/var/lib/awx/projects/clients/{{ member_id }}/{{ subscription_id }}/matrix_vars.yml" | |||||
| regexp: 'matrix_synapse_use_presence' | |||||
| replace: 'matrix_synapse_presence_enabled' | |||||
| - name: Generate matrix_homeserver_generic_secret_key variable | |||||
| delegate_to: 127.0.0.1 | |||||
| command: | | |||||
| openssl rand -hex 16 | |||||
| register: generic_secret | |||||
| no_log: True | |||||
| when: ( matrix_homeserver_generic_secret_key is undefined ) or ( matrix_homeserver_generic_secret_key | length == 0 ) | |||||
| - name: Add new matrix_homeserver_generic_secret_key variable | |||||
| delegate_to: 127.0.0.1 | |||||
| lineinfile: | |||||
| path: '/var/lib/awx/projects/clients/{{ member_id }}/{{ subscription_id }}/matrix_vars.yml' | |||||
| line: "matrix_homeserver_generic_secret_key: {{ generic_secret.stdout }}" | |||||
| insertbefore: '# Basic Settings End' | |||||
| mode: '0600' | |||||
| state: present | |||||
| when: ( matrix_homeserver_generic_secret_key is undefined ) or ( matrix_homeserver_generic_secret_key | length == 0 ) | |||||
| @@ -7,6 +7,18 @@ | |||||
| # Example value: example.com | # Example value: example.com | ||||
| matrix_domain: ~ | matrix_domain: ~ | ||||
| # This will contain the homeserver implementation that is in use. | |||||
| # Valid values: synapse, dendrite | |||||
| # | |||||
| # By default, we use Synapse, because it's the only full-featured Matrix server at the moment. | |||||
| # | |||||
| # This value automatically influences other variables (`matrix_synapse_enabled`, `matrix_dendrite_enabled`, etc.). | |||||
| # The homeserver implementation of an existing server cannot be changed without data loss. | |||||
| matrix_homeserver_implementation: synapse | |||||
| # This contains a secret, which is used for generating various other secrets later on. | |||||
| matrix_homeserver_generic_secret_key: '' | |||||
| # This is where your data lives and what we set up. | # This is where your data lives and what we set up. | ||||
| # This and the Element FQN (see below) are expected to be on the same server. | # This and the Element FQN (see below) are expected to be on the same server. | ||||
| matrix_server_fqn_matrix: "matrix.{{ matrix_domain }}" | matrix_server_fqn_matrix: "matrix.{{ matrix_domain }}" | ||||
| @@ -21,6 +33,9 @@ matrix_server_fqn_element: "element.{{ matrix_domain }}" | |||||
| # This is where you access the Hydrogen web client from (if enabled via matrix_client_hydrogen_enabled; disabled by default). | # This is where you access the Hydrogen web client from (if enabled via matrix_client_hydrogen_enabled; disabled by default). | ||||
| matrix_server_fqn_hydrogen: "hydrogen.{{ matrix_domain }}" | matrix_server_fqn_hydrogen: "hydrogen.{{ matrix_domain }}" | ||||
| # This is where you access the Cinny web client from (if enabled via matrix_client_cinny_enabled; disabled by default). | |||||
| matrix_server_fqn_cinny: "cinny.{{ matrix_domain }}" | |||||
| # This is where you access the Dimension. | # This is where you access the Dimension. | ||||
| matrix_server_fqn_dimension: "dimension.{{ matrix_domain }}" | matrix_server_fqn_dimension: "dimension.{{ matrix_domain }}" | ||||
| @@ -88,11 +103,16 @@ matrix_ntpd_service: "{{ 'systemd-timesyncd' if (ansible_distribution == 'CentOS | |||||
| matrix_homeserver_url: "https://{{ matrix_server_fqn_matrix }}" | matrix_homeserver_url: "https://{{ matrix_server_fqn_matrix }}" | ||||
| # Specifies where the homeserver is on the container network. | |||||
| # Where this is depends on whether there's a reverse-proxy in front of it, etc. | |||||
| # Specifies where the homeserver's Client-Server API is on the container network. | |||||
| # Where this is depends on whether there's a reverse-proxy in front of the homeserver, which homeserver it is, etc. | |||||
| # This likely gets overriden elsewhere. | # This likely gets overriden elsewhere. | ||||
| matrix_homeserver_container_url: "" | matrix_homeserver_container_url: "" | ||||
| # Specifies where the homeserver's Federation API is on the container network. | |||||
| # Where this is depends on whether there's a reverse-proxy in front of the homeserver, which homeserver it is, etc. | |||||
| # This likely gets overriden elsewhere. | |||||
| matrix_homeserver_container_federation_url: "" | |||||
| matrix_identity_server_url: ~ | matrix_identity_server_url: ~ | ||||
| matrix_integration_manager_rest_url: ~ | matrix_integration_manager_rest_url: ~ | ||||
| @@ -218,6 +238,7 @@ run_synapse_register_user: true | |||||
| run_synapse_update_user_password: true | run_synapse_update_user_password: true | ||||
| run_synapse_import_media_store: true | run_synapse_import_media_store: true | ||||
| run_synapse_rust_synapse_compress_state: true | run_synapse_rust_synapse_compress_state: true | ||||
| run_dendrite_register_user: true | |||||
| run_setup: true | run_setup: true | ||||
| run_self_check: true | run_self_check: true | ||||
| run_start: true | run_start: true | ||||
| @@ -31,4 +31,5 @@ | |||||
| - setup-all | - setup-all | ||||
| - setup-ma1sd | - setup-ma1sd | ||||
| - setup-synapse | - setup-synapse | ||||
| - setup-dendrite | |||||
| - setup-nginx-proxy | - setup-nginx-proxy | ||||
| @@ -1,5 +1,10 @@ | |||||
| --- | --- | ||||
| - name: Fail if invalid homeserver implementation | |||||
| fail: | |||||
| msg: "You need to set a valid homeserver implementation in `matrix_homeserver_implementation`" | |||||
| when: "matrix_homeserver_implementation not in ['synapse', 'dendrite']" | |||||
| # We generally support Ansible 2.7.1 and above. | # We generally support Ansible 2.7.1 and above. | ||||
| - name: Fail if running on Ansible < 2.7.1 | - name: Fail if running on Ansible < 2.7.1 | ||||
| fail: | fail: | ||||
| @@ -28,14 +33,29 @@ | |||||
| - {'old': 'hostname_riot', 'new': 'matrix_server_fqn_element'} | - {'old': 'hostname_riot', 'new': 'matrix_server_fqn_element'} | ||||
| - {'old': 'matrix_server_fqn_riot', 'new': 'matrix_server_fqn_element'} | - {'old': 'matrix_server_fqn_riot', 'new': 'matrix_server_fqn_element'} | ||||
| # We have a dedicated check for this variable, because we'd like to have a custom (friendlier) message. | |||||
| - name: Fail if matrix_homeserver_generic_secret_key is undefined | |||||
| fail: | |||||
| msg: | | |||||
| The `matrix_homeserver_generic_secret_key` variable must be defined and have a non-null and non-empty value. | |||||
| If you're observing this error on a new installation, you should ensure that the `matrix_homeserver_generic_secret_key` is defined. | |||||
| If you're observing this error on an existing homeserver installation, you can fix it easily and in a backward-compatible way by adding | |||||
| `{% raw %}matrix_homeserver_generic_secret_key: "{{ matrix_synapse_macaroon_secret_key }}"{% endraw %}` | |||||
| to your `vars.yml` file. Using another secret value for the new variable is also possible and shouldn't cause any trouble. | |||||
| when: "matrix_homeserver_generic_secret_key is none or matrix_homeserver_generic_secret_key == ''" | |||||
| - name: Fail if required variables are undefined | - name: Fail if required variables are undefined | ||||
| fail: | fail: | ||||
| msg: "The `{{ item }}` variable must be defined and have a non-null value" | |||||
| msg: "The `{{ item.var }}` variable must be defined and have a non-null and non-empty value" | |||||
| with_items: | with_items: | ||||
| - matrix_domain | |||||
| - matrix_server_fqn_matrix | |||||
| - matrix_server_fqn_element | |||||
| when: "item not in vars or vars[item] is none" | |||||
| - {'var': matrix_domain, 'value': "{{ matrix_domain|default('') }}"} | |||||
| - {'var': matrix_server_fqn_matrix, 'value': "{{ matrix_server_fqn_matrix|default('') }}"} | |||||
| - {'var': matrix_server_fqn_element, 'value': "{{ matrix_server_fqn_element|default('') }}"} | |||||
| - {'var': matrix_homeserver_container_url, 'value': "{{ matrix_homeserver_container_url|default('') }}"} | |||||
| - {'var': matrix_homeserver_container_federation_url, 'value': "{{ matrix_homeserver_container_federation_url|default('') }}"} | |||||
| when: "item.value is none or item.value == ''" | |||||
| - name: Fail if uppercase domain used | - name: Fail if uppercase domain used | ||||
| fail: | fail: | ||||
| @@ -4,8 +4,6 @@ | |||||
| pacman: | pacman: | ||||
| name: | name: | ||||
| - python-docker | - python-docker | ||||
| # TODO This needs to be verified. Which version do we need? | |||||
| - fuse3 | |||||
| - python-dnspython | - python-dnspython | ||||
| state: latest | state: latest | ||||
| update_cache: yes | update_cache: yes | ||||
| @@ -21,7 +21,6 @@ | |||||
| yum: | yum: | ||||
| name: | name: | ||||
| - "{{ matrix_ntpd_package }}" | - "{{ matrix_ntpd_package }}" | ||||
| - fuse | |||||
| state: latest | state: latest | ||||
| update_cache: yes | update_cache: yes | ||||
| @@ -28,7 +28,6 @@ | |||||
| yum: | yum: | ||||
| name: | name: | ||||
| - "{{ matrix_ntpd_package }}" | - "{{ matrix_ntpd_package }}" | ||||
| - fuse | |||||
| state: latest | state: latest | ||||
| update_cache: yes | update_cache: yes | ||||
| @@ -44,4 +43,4 @@ | |||||
| pip: | pip: | ||||
| name: docker-py | name: docker-py | ||||
| state: latest | state: latest | ||||
| when: matrix_docker_installation_enabled|bool | |||||
| when: matrix_docker_installation_enabled|bool | |||||
| @@ -29,7 +29,6 @@ | |||||
| apt: | apt: | ||||
| name: | name: | ||||
| - "{{ matrix_ntpd_package }}" | - "{{ matrix_ntpd_package }}" | ||||
| - fuse | |||||
| state: latest | state: latest | ||||
| update_cache: yes | update_cache: yes | ||||
| @@ -29,7 +29,6 @@ | |||||
| apt: | apt: | ||||
| name: | name: | ||||
| - "{{ matrix_ntpd_package }}" | - "{{ matrix_ntpd_package }}" | ||||
| - fuse | |||||
| state: latest | state: latest | ||||
| update_cache: yes | update_cache: yes | ||||
| @@ -0,0 +1,23 @@ | |||||
| # This is for both CentOS 7 and 8 | |||||
| - name: Ensure fuse installed (CentOS) | |||||
| yum: | |||||
| name: | |||||
| - fuse | |||||
| state: latest | |||||
| when: ansible_distribution == 'CentOS' | |||||
| # This is for both Debian and Raspbian | |||||
| - name: Ensure fuse installed (Debian/Raspbian) | |||||
| apt: | |||||
| name: | |||||
| - fuse | |||||
| state: latest | |||||
| when: ansible_os_family == 'Debian' | |||||
| - name: Ensure fuse installed (Archlinux) | |||||
| pacman: | |||||
| name: | |||||
| - fuse3 | |||||
| state: latest | |||||
| when: ansible_distribution == 'Archlinux' | |||||
| @@ -1,9 +0,0 @@ | |||||
| --- | |||||
| - name: Fail if required Matrix Base settings not defined | |||||
| fail: | |||||
| msg: >- | |||||
| You need to define a required configuration setting (`{{ item }}`) for using this playbook. | |||||
| when: "vars[item] == ''" | |||||
| with_items: | |||||
| - "matrix_homeserver_container_url" | |||||
| @@ -1,3 +1,3 @@ | |||||
| # This will contain a list of enabled services that the playbook is managing. | # This will contain a list of enabled services that the playbook is managing. | ||||
| # Each component is expected to append its service name to this list. | # Each component is expected to append its service name to this list. | ||||
| matrix_systemd_services_list: [] | |||||
| matrix_systemd_services_list: [] | |||||
| @@ -203,8 +203,8 @@ matrix_bot_go_neb_services: [] | |||||
| # # Each room will get the notification with the alert rendered with the given template | # # Each room will get the notification with the alert rendered with the given template | ||||
| # rooms: | # rooms: | ||||
| # "!someroomid:domain.tld": | # "!someroomid:domain.tld": | ||||
| # text_template: "{{range .Alerts -}} [{{ .Status }}] {{index .Labels \"alertname\" }}: {{index .Annotations \"description\"}} {{ end -}}" | |||||
| # html_template: "{{range .Alerts -}} {{ $severity := index .Labels \"severity\" }} {{ if eq .Status \"firing\" }} {{ if eq $severity \"critical\"}} <font color='red'><b>[FIRING - CRITICAL]</b></font> {{ else if eq $severity \"warning\"}} <font color='orange'><b>[FIRING - WARNING]</b></font> {{ else }} <b>[FIRING - {{ $severity }}]</b> {{ end }} {{ else }} <font color='green'><b>[RESOLVED]</b></font> {{ end }} {{ index .Labels \"alertname\"}} : {{ index .Annotations \"description\"}} <a href=\"{{ .GeneratorURL }}\">source</a><br/>{{end -}}" | |||||
| # text_template: "{% raw %}{{range .Alerts -}} [{{ .Status }}] {{index .Labels \"alertname\" }}: {{index .Annotations \"description\"}} {{ end -}}{% endraw %}" | |||||
| # html_template: "{% raw %}{{range .Alerts -}} {{ $severity := index .Labels \"severity\" }} {{ if eq .Status \"firing\" }} {{ if eq $severity \"critical\"}} <font color='red'><b>[FIRING - CRITICAL]</b></font> {{ else if eq $severity \"warning\"}} <font color='orange'><b>[FIRING - WARNING]</b></font> {{ else }} <b>[FIRING - {{ $severity }}]</b> {{ end }} {{ else }} <font color='green'><b>[RESOLVED]</b></font> {{ end }} {{ index .Labels \"alertname\"}} : {{ index .Annotations \"description\"}} <a href=\"{{ .GeneratorURL }}\">source</a><br/>{{end -}}{% endraw %}" | |||||
| # msg_type: "m.text" # Must be either `m.text` or `m.notice` | # msg_type: "m.text" # Must be either `m.text` or `m.notice` | ||||
| # Default configuration template which covers the generic use case. | # Default configuration template which covers the generic use case. | ||||
| @@ -39,8 +39,8 @@ ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-bot-go-neb \ | |||||
| {{ matrix_bot_go_neb_docker_image }} \ | {{ matrix_bot_go_neb_docker_image }} \ | ||||
| -c "go-neb /config/config.yaml" | -c "go-neb /config/config.yaml" | ||||
| ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-bot-go-neb 2>/dev/null' | |||||
| ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-bot-go-neb 2>/dev/null' | |||||
| ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-bot-go-neb 2>/dev/null' | |||||
| ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-bot-go-neb 2>/dev/null' | |||||
| Restart=always | Restart=always | ||||
| RestartSec=30 | RestartSec=30 | ||||
| SyslogIdentifier=matrix-bot-go-neb | SyslogIdentifier=matrix-bot-go-neb | ||||
| @@ -0,0 +1,103 @@ | |||||
| # honoroit is a helpdesk bot | |||||
| # See: https://gitlab.com/etke.cc/honoroit | |||||
| matrix_bot_honoroit_enabled: true | |||||
| matrix_bot_honoroit_container_image_self_build: false | |||||
| matrix_bot_honoroit_docker_repo: "https://gitlab.com/etke.cc/honoroit.git" | |||||
| matrix_bot_honoroit_docker_src_files_path: "{{ matrix_base_data_path }}/honoroit/docker-src" | |||||
| matrix_bot_honoroit_version: v0.9.2 | |||||
| matrix_bot_honoroit_docker_image: "{{ matrix_bot_honoroit_docker_image_name_prefix }}honoroit:{{ matrix_bot_honoroit_version }}" | |||||
| matrix_bot_honoroit_docker_image_name_prefix: "{{ 'localhost/' if matrix_bot_honoroit_container_image_self_build else 'registry.gitlab.com/etke.cc/' }}" | |||||
| matrix_bot_honoroit_docker_image_force_pull: "{{ matrix_bot_honoroit_docker_image.endswith(':latest') }}" | |||||
| matrix_bot_honoroit_base_path: "{{ matrix_base_data_path }}/honoroit" | |||||
| matrix_bot_honoroit_config_path: "{{ matrix_bot_honoroit_base_path }}/config" | |||||
| matrix_bot_honoroit_data_path: "{{ matrix_bot_honoroit_base_path }}/data" | |||||
| matrix_bot_honoroit_data_store_path: "{{ matrix_bot_honoroit_data_path }}/store" | |||||
| # A list of extra arguments to pass to the container | |||||
| matrix_bot_honoroit_container_extra_arguments: [] | |||||
| # List of systemd services that matrix-bot-honoroit.service depends on | |||||
| matrix_bot_honoroit_systemd_required_services_list: ['docker.service'] | |||||
| # List of systemd services that matrix-bot-honoroit.service wants | |||||
| matrix_bot_honoroit_systemd_wanted_services_list: [] | |||||
| # Database-related configuration fields. | |||||
| # | |||||
| # To use SQLite, stick to these defaults. | |||||
| # | |||||
| # To use Postgres: | |||||
| # - change the engine (`matrix_bot_honoroit_database_engine: 'postgres'`) | |||||
| # - adjust your database credentials via the `matrix_bot_honoroit_database_*` variables | |||||
| matrix_bot_honoroit_database_engine: 'sqlite' | |||||
| matrix_bot_honoroit_sqlite_database_path_local: "{{ matrix_bot_honoroit_data_path }}/bot.db" | |||||
| matrix_bot_honoroit_sqlite_database_path_in_container: "/data/bot.db" | |||||
| matrix_bot_honoroit_database_username: 'honoroit' | |||||
| matrix_bot_honoroit_database_password: 'some-password' | |||||
| matrix_bot_honoroit_database_hostname: 'matrix-postgres' | |||||
| matrix_bot_honoroit_database_port: 5432 | |||||
| matrix_bot_honoroit_database_name: 'honoroit' | |||||
| matrix_bot_honoroit_database_connection_string: 'postgres://{{ matrix_bot_honoroit_database_username }}:{{ matrix_bot_honoroit_database_password }}@{{ matrix_bot_honoroit_database_hostname }}:{{ matrix_bot_honoroit_database_port }}/{{ matrix_bot_honoroit_database_name }}?sslmode=disable' | |||||
| matrix_bot_honoroit_storage_database: "{{ | |||||
| { | |||||
| 'sqlite': matrix_bot_honoroit_sqlite_database_path_in_container, | |||||
| 'postgres': matrix_bot_honoroit_database_connection_string, | |||||
| }[matrix_bot_honoroit_database_engine] | |||||
| }}" | |||||
| matrix_bot_honoroit_database_dialect: "{{ | |||||
| { | |||||
| 'sqlite': 'sqlite3', | |||||
| 'postgres': 'postgres', | |||||
| }[matrix_bot_honoroit_database_engine] | |||||
| }}" | |||||
| # The bot's username. This user needs to be created manually beforehand. | |||||
| # Also see `matrix_bot_honoroit_password`. | |||||
| matrix_bot_honoroit_login: "honoroit" | |||||
| # The password that the bot uses to authenticate. | |||||
| matrix_bot_honoroit_password: '' | |||||
| matrix_bot_honoroit_homeserver: "{{ matrix_homeserver_container_url }}" | |||||
| # The room ID where bot will create threads | |||||
| matrix_bot_honoroit_roomid: '' | |||||
| # Command prefix | |||||
| matrix_bot_honoroit_prefix: '' | |||||
| # Sentry DSN | |||||
| matrix_bot_honoroit_sentry: '' | |||||
| # Log level | |||||
| matrix_bot_honoroit_loglevel: '' | |||||
| # Text: greetings | |||||
| matrix_bot_honoroit_text_greetings: '' | |||||
| # Text: error | |||||
| matrix_bot_honoroit_text_error: '' | |||||
| # Text: empty room | |||||
| matrix_bot_honoroit_text_emptyroom: '' | |||||
| # Text: done | |||||
| matrix_bot_honoroit_text_done: '' | |||||
| # Additional environment variables to pass to the Honoroit container | |||||
| # | |||||
| # Example: | |||||
| # matrix_bot_honoroit_environment_variables_extension: | | |||||
| # HONOROIT_TEXT_DONE=Done | |||||
| matrix_bot_honoroit_environment_variables_extension: '' | |||||
| @@ -0,0 +1,3 @@ | |||||
| - set_fact: | |||||
| matrix_systemd_services_list: "{{ matrix_systemd_services_list + ['matrix-bot-honoroit.service'] }}" | |||||
| when: matrix_bot_honoroit_enabled|bool | |||||
| @@ -0,0 +1,21 @@ | |||||
| - import_tasks: "{{ role_path }}/tasks/init.yml" | |||||
| tags: | |||||
| - always | |||||
| - import_tasks: "{{ role_path }}/tasks/validate_config.yml" | |||||
| when: "run_setup|bool and matrix_bot_honoroit_enabled|bool" | |||||
| tags: | |||||
| - setup-all | |||||
| - setup-bot-honoroit | |||||
| - import_tasks: "{{ role_path }}/tasks/setup_install.yml" | |||||
| when: "run_setup|bool and matrix_bot_honoroit_enabled|bool" | |||||
| tags: | |||||
| - setup-all | |||||
| - setup-bot-honoroit | |||||
| - import_tasks: "{{ role_path }}/tasks/setup_uninstall.yml" | |||||
| when: "run_setup|bool and not matrix_bot_honoroit_enabled|bool" | |||||
| tags: | |||||
| - setup-all | |||||
| - setup-bot-honoroit | |||||
| @@ -0,0 +1,92 @@ | |||||
| --- | |||||
| - set_fact: | |||||
| matrix_bot_honoroit_requires_restart: false | |||||
| - block: | |||||
| - name: Check if an SQLite database already exists | |||||
| stat: | |||||
| path: "{{ matrix_bot_honoroit_sqlite_database_path_local }}" | |||||
| register: matrix_bot_honoroit_sqlite_database_path_local_stat_result | |||||
| - block: | |||||
| - set_fact: | |||||
| matrix_postgres_db_migration_request: | |||||
| src: "{{ matrix_bot_honoroit_sqlite_database_path_local }}" | |||||
| dst: "{{ matrix_bot_honoroit_database_connection_string }}" | |||||
| caller: "{{ role_path|basename }}" | |||||
| engine_variable_name: 'matrix_bot_honoroit_database_engine' | |||||
| engine_old: 'sqlite' | |||||
| systemd_services_to_stop: ['matrix-bot-honoroit.service'] | |||||
| - import_tasks: "{{ role_path }}/../matrix-postgres/tasks/util/migrate_db_to_postgres.yml" | |||||
| - set_fact: | |||||
| matrix_bot_honoroit_requires_restart: true | |||||
| when: "matrix_bot_honoroit_sqlite_database_path_local_stat_result.stat.exists|bool" | |||||
| when: "matrix_bot_honoroit_database_engine == 'postgres'" | |||||
| - name: Ensure honoroit paths exist | |||||
| file: | |||||
| path: "{{ item.path }}" | |||||
| state: directory | |||||
| mode: 0750 | |||||
| owner: "{{ matrix_user_username }}" | |||||
| group: "{{ matrix_user_groupname }}" | |||||
| with_items: | |||||
| - { path: "{{ matrix_bot_honoroit_config_path }}", when: true } | |||||
| - { path: "{{ matrix_bot_honoroit_data_path }}", when: true } | |||||
| - { path: "{{ matrix_bot_honoroit_data_store_path }}", when: true } | |||||
| - { path: "{{ matrix_bot_honoroit_docker_src_files_path }}", when: true} | |||||
| when: "item.when|bool" | |||||
| - name: Ensure honoroit environment variables file created | |||||
| template: | |||||
| src: "{{ role_path }}/templates/env.j2" | |||||
| dest: "{{ matrix_bot_honoroit_config_path }}/env" | |||||
| mode: 0640 | |||||
| - name: Ensure honoroit image is pulled | |||||
| docker_image: | |||||
| name: "{{ matrix_bot_honoroit_docker_image }}" | |||||
| source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}" | |||||
| force_source: "{{ matrix_bot_honoroit_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_bot_honoroit_docker_image_force_pull }}" | |||||
| when: "not matrix_bot_honoroit_container_image_self_build|bool" | |||||
| - name: Ensure honoroit repository is present on self-build | |||||
| git: | |||||
| repo: "{{ matrix_bot_honoroit_docker_repo }}" | |||||
| dest: "{{ matrix_bot_honoroit_docker_src_files_path }}" | |||||
| force: "yes" | |||||
| register: matrix_bot_honoroit_git_pull_results | |||||
| when: "matrix_bot_honoroit_container_image_self_build|bool" | |||||
| - name: Ensure honoroit image is built | |||||
| docker_image: | |||||
| name: "{{ matrix_bot_honoroit_docker_image }}" | |||||
| source: build | |||||
| force_source: "{{ matrix_bot_honoroit_git_pull_results.changed 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_mailer_git_pull_results.changed }}" | |||||
| build: | |||||
| dockerfile: Dockerfile | |||||
| path: "{{ matrix_bot_honoroit_docker_src_files_path }}" | |||||
| pull: yes | |||||
| when: "matrix_bot_honoroit_container_image_self_build|bool" | |||||
| - name: Ensure matrix-bot-honoroit.service installed | |||||
| template: | |||||
| src: "{{ role_path }}/templates/systemd/matrix-bot-honoroit.service.j2" | |||||
| dest: "{{ matrix_systemd_path }}/matrix-bot-honoroit.service" | |||||
| mode: 0644 | |||||
| register: matrix_bot_honoroit_systemd_service_result | |||||
| - name: Ensure systemd reloaded after matrix-bot-honoroit.service installation | |||||
| service: | |||||
| daemon_reload: yes | |||||
| when: "matrix_bot_honoroit_systemd_service_result.changed|bool" | |||||
| - name: Ensure matrix-bot-honoroit.service restarted, if necessary | |||||
| service: | |||||
| name: "matrix-bot-honoroit.service" | |||||
| state: restarted | |||||
| when: "matrix_bot_honoroit_requires_restart|bool" | |||||
| @@ -0,0 +1,36 @@ | |||||
| --- | |||||
| - name: Check existence of matrix-honoroit service | |||||
| stat: | |||||
| path: "{{ matrix_systemd_path }}/matrix-bot-honoroit.service" | |||||
| register: matrix_bot_honoroit_service_stat | |||||
| - name: Ensure matrix-honoroit is stopped | |||||
| service: | |||||
| name: matrix-bot-honoroit | |||||
| state: stopped | |||||
| enabled: no | |||||
| daemon_reload: yes | |||||
| register: stopping_result | |||||
| when: "matrix_bot_honoroit_service_stat.stat.exists|bool" | |||||
| - name: Ensure matrix-bot-honoroit.service doesn't exist | |||||
| file: | |||||
| path: "{{ matrix_systemd_path }}/matrix-bot-honoroit.service" | |||||
| state: absent | |||||
| when: "matrix_bot_honoroit_service_stat.stat.exists|bool" | |||||
| - name: Ensure systemd reloaded after matrix-bot-honoroit.service removal | |||||
| service: | |||||
| daemon_reload: yes | |||||
| when: "matrix_bot_honoroit_service_stat.stat.exists|bool" | |||||
| - name: Ensure Matrix honoroit paths don't exist | |||||
| file: | |||||
| path: "{{ matrix_bot_honoroit_base_path }}" | |||||
| state: absent | |||||
| - name: Ensure honoroit Docker image doesn't exist | |||||
| docker_image: | |||||
| name: "{{ matrix_bot_honoroit_docker_image }}" | |||||
| state: absent | |||||
| @@ -0,0 +1,10 @@ | |||||
| --- | |||||
| - name: Fail if required settings not defined | |||||
| fail: | |||||
| msg: >- | |||||
| You need to define a required configuration setting (`{{ item }}`). | |||||
| when: "vars[item] == ''" | |||||
| with_items: | |||||
| - "matrix_bot_honoroit_password" | |||||
| - "matrix_bot_honoroit_roomid" | |||||
| @@ -0,0 +1,15 @@ | |||||
| HONOROIT_LOGIN={{ matrix_bot_honoroit_login }} | |||||
| HONOROIT_PASSWORD={{ matrix_bot_honoroit_password }} | |||||
| HONOROIT_HOMESERVER={{ matrix_bot_honoroit_homeserver }} | |||||
| HONOROIT_ROOMID={{ matrix_bot_honoroit_roomid }} | |||||
| HONOROIT_DB_DSN={{ matrix_bot_honoroit_database_connection_string }} | |||||
| HONOROIT_DB_DIALECT={{ matrix_bot_honoroit_database_dialect }} | |||||
| HONOROIT_PREFIX={{ matrix_bot_honoroit_prefix }} | |||||
| HONOROIT_SENTRY={{ matrix_bot_honoroit_sentry }} | |||||
| HONOROIT_LOGLEVEL={{ matrix_bot_honoroit_loglevel }} | |||||
| HONOROIT_TEXT_GREETINGS={{ matrix_bot_honoroit_text_greetings }} | |||||
| HONOROIT_TEXT_ERROR={{ matrix_bot_honoroit_text_error }} | |||||
| HONOROIT_TEXT_EMPTYROOM={{ matrix_bot_honoroit_text_emptyroom }} | |||||
| HONOROIT_TEXT_DONE={{ matrix_bot_honoroit_text_done }} | |||||
| {{ matrix_bot_honoroit_environment_variables_extension }} | |||||
| @@ -0,0 +1,39 @@ | |||||
| #jinja2: lstrip_blocks: "True" | |||||
| [Unit] | |||||
| Description=Matrix helpdesk bot | |||||
| {% for service in matrix_bot_honoroit_systemd_required_services_list %} | |||||
| Requires={{ service }} | |||||
| After={{ service }} | |||||
| {% endfor %} | |||||
| {% for service in matrix_bot_honoroit_systemd_wanted_services_list %} | |||||
| Wants={{ 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-bot-honoroit 2>/dev/null' | |||||
| ExecStartPre=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-bot-honoroit 2>/dev/null' | |||||
| ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-bot-honoroit \ | |||||
| --log-driver=none \ | |||||
| --user={{ matrix_user_uid }}:{{ matrix_user_gid }} \ | |||||
| --cap-drop=ALL \ | |||||
| --read-only \ | |||||
| --network={{ matrix_docker_network }} \ | |||||
| --env-file={{ matrix_bot_honoroit_config_path }}/env \ | |||||
| --mount type=bind,src={{ matrix_bot_honoroit_data_path }},dst=/data \ | |||||
| {% for arg in matrix_bot_honoroit_container_extra_arguments %} | |||||
| {{ arg }} \ | |||||
| {% endfor %} | |||||
| {{ matrix_bot_honoroit_docker_image }} | |||||
| ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-bot-honoroit 2>/dev/null' | |||||
| ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-bot-honoroit 2>/dev/null' | |||||
| Restart=always | |||||
| RestartSec=30 | |||||
| SyslogIdentifier=matrix-bot-honoroit | |||||
| [Install] | |||||
| WantedBy=multi-user.target | |||||
| @@ -3,7 +3,7 @@ | |||||
| matrix_bot_matrix_reminder_bot_enabled: true | matrix_bot_matrix_reminder_bot_enabled: true | ||||
| matrix_bot_matrix_reminder_bot_container_self_build: false | |||||
| matrix_bot_matrix_reminder_bot_container_image_self_build: false | |||||
| matrix_bot_matrix_reminder_bot_docker_repo: "https://github.com/anoadragon453/matrix-reminder-bot.git" | matrix_bot_matrix_reminder_bot_docker_repo: "https://github.com/anoadragon453/matrix-reminder-bot.git" | ||||
| matrix_bot_matrix_reminder_bot_docker_src_files_path: "{{ matrix_base_data_path }}/matrix-reminder-bot/docker-src" | matrix_bot_matrix_reminder_bot_docker_src_files_path: "{{ matrix_base_data_path }}/matrix-reminder-bot/docker-src" | ||||
| @@ -46,7 +46,7 @@ | |||||
| source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}" | source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}" | ||||
| force_source: "{{ matrix_bot_matrix_reminder_bot_docker_image_force_pull if ansible_version.major > 2 or ansible_version.minor >= 8 else omit }}" | force_source: "{{ matrix_bot_matrix_reminder_bot_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_bot_matrix_reminder_bot_docker_image_force_pull }}" | force: "{{ omit if ansible_version.major > 2 or ansible_version.minor >= 8 else matrix_bot_matrix_reminder_bot_docker_image_force_pull }}" | ||||
| when: "not matrix_bot_matrix_reminder_bot_container_self_build|bool" | |||||
| when: "not matrix_bot_matrix_reminder_bot_container_image_self_build|bool" | |||||
| - name: Ensure matrix-reminder-bot repository is present on self-build | - name: Ensure matrix-reminder-bot repository is present on self-build | ||||
| git: | git: | ||||
| @@ -54,7 +54,7 @@ | |||||
| dest: "{{ matrix_bot_matrix_reminder_bot_docker_src_files_path }}" | dest: "{{ matrix_bot_matrix_reminder_bot_docker_src_files_path }}" | ||||
| force: "yes" | force: "yes" | ||||
| register: matrix_bot_matrix_reminder_bot_git_pull_results | register: matrix_bot_matrix_reminder_bot_git_pull_results | ||||
| when: "matrix_bot_matrix_reminder_bot_container_self_build|bool" | |||||
| when: "matrix_bot_matrix_reminder_bot_container_image_self_build|bool" | |||||
| - name: Ensure matrix-reminder-bot image is built | - name: Ensure matrix-reminder-bot image is built | ||||
| docker_image: | docker_image: | ||||
| @@ -66,7 +66,7 @@ | |||||
| dockerfile: docker/Dockerfile | dockerfile: docker/Dockerfile | ||||
| path: "{{ matrix_bot_matrix_reminder_bot_docker_src_files_path }}" | path: "{{ matrix_bot_matrix_reminder_bot_docker_src_files_path }}" | ||||
| pull: yes | pull: yes | ||||
| when: "matrix_bot_matrix_reminder_bot_container_self_build|bool" | |||||
| when: "matrix_bot_matrix_reminder_bot_container_image_self_build|bool" | |||||
| - name: Ensure matrix-reminder-bot config installed | - name: Ensure matrix-reminder-bot config installed | ||||
| copy: | copy: | ||||
| @@ -8,3 +8,12 @@ | |||||
| with_items: | with_items: | ||||
| - "matrix_bot_matrix_reminder_bot_matrix_user_password" | - "matrix_bot_matrix_reminder_bot_matrix_user_password" | ||||
| - "matrix_bot_matrix_reminder_bot_reminders_timezone" | - "matrix_bot_matrix_reminder_bot_reminders_timezone" | ||||
| - name: (Deprecation) Catch and report renamed settings | |||||
| fail: | |||||
| msg: >- | |||||
| Your configuration contains a variable, which now has a different name. | |||||
| Please change your configuration to rename the variable (`{{ item.old }}` -> `{{ item.new }}`). | |||||
| when: "item.old in vars" | |||||
| with_items: | |||||
| - {'old': 'matrix_bot_matrix_reminder_bot_container_self_build', 'new': 'matrix_bot_matrix_reminder_bot_container_image_self_build'} | |||||
| @@ -32,8 +32,8 @@ ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-bot-matrix-rem | |||||
| {{ matrix_bot_matrix_reminder_bot_docker_image }} \ | {{ matrix_bot_matrix_reminder_bot_docker_image }} \ | ||||
| -c "matrix-reminder-bot /config/config.yaml" | -c "matrix-reminder-bot /config/config.yaml" | ||||
| ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-bot-matrix-reminder-bot 2>/dev/null' | |||||
| ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-bot-matrix-reminder-bot 2>/dev/null' | |||||
| ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-bot-matrix-reminder-bot 2>/dev/null' | |||||
| ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-bot-matrix-reminder-bot 2>/dev/null' | |||||
| Restart=always | Restart=always | ||||
| RestartSec=30 | RestartSec=30 | ||||
| SyslogIdentifier=matrix-bot-matrix-reminder-bot | SyslogIdentifier=matrix-bot-matrix-reminder-bot | ||||
| @@ -32,8 +32,8 @@ ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-bot-mjolnir \ | |||||
| {% endfor %} | {% endfor %} | ||||
| {{ matrix_bot_mjolnir_docker_image }} | {{ matrix_bot_mjolnir_docker_image }} | ||||
| ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-bot-mjolnir 2>/dev/null' | |||||
| ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-bot-mjolnir 2>/dev/null' | |||||
| ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-bot-mjolnir 2>/dev/null' | |||||
| ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-bot-mjolnir 2>/dev/null' | |||||
| Restart=always | Restart=always | ||||
| RestartSec=30 | RestartSec=30 | ||||
| SyslogIdentifier=matrix-bot-mjolnir | SyslogIdentifier=matrix-bot-mjolnir | ||||
| @@ -35,8 +35,8 @@ ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-appservice-dis | |||||
| {{ matrix_appservice_discord_docker_image }} \ | {{ matrix_appservice_discord_docker_image }} \ | ||||
| node /build/src/discordas.js -p 9005 -c /cfg/config.yaml -f /cfg/registration.yaml | node /build/src/discordas.js -p 9005 -c /cfg/config.yaml -f /cfg/registration.yaml | ||||
| ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-appservice-discord 2>/dev/null' | |||||
| ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-appservice-discord 2>/dev/null' | |||||
| ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-appservice-discord 2>/dev/null' | |||||
| ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-appservice-discord 2>/dev/null' | |||||
| Restart=always | Restart=always | ||||
| RestartSec=30 | RestartSec=30 | ||||
| SyslogIdentifier=matrix-appservice-discord | SyslogIdentifier=matrix-appservice-discord | ||||
| @@ -3,7 +3,7 @@ | |||||
| matrix_appservice_irc_enabled: true | matrix_appservice_irc_enabled: true | ||||
| matrix_appservice_irc_container_self_build: false | |||||
| matrix_appservice_irc_container_image_self_build: false | |||||
| matrix_appservice_irc_docker_repo: "https://github.com/matrix-org/matrix-appservice-irc.git" | matrix_appservice_irc_docker_repo: "https://github.com/matrix-org/matrix-appservice-irc.git" | ||||
| matrix_appservice_irc_docker_src_files_path: "{{ matrix_base_data_path }}/appservice-irc/docker-src" | matrix_appservice_irc_docker_src_files_path: "{{ matrix_base_data_path }}/appservice-irc/docker-src" | ||||
| @@ -3,7 +3,7 @@ | |||||
| - name: Fail if trying to self-build on Ansible < 2.8 | - name: Fail if trying to self-build on Ansible < 2.8 | ||||
| fail: | fail: | ||||
| msg: "To self-build the Element image, you should use Ansible 2.8 or higher. See docs/ansible.md" | msg: "To self-build the Element 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_appservice_irc_container_self_build and matrix_appservice_irc_enabled" | |||||
| when: "ansible_version.major == 2 and ansible_version.minor < 8 and matrix_appservice_irc_container_image_self_build and matrix_appservice_irc_enabled" | |||||
| # If the matrix-synapse role is not used, `matrix_synapse_role_executed` won't exist. | # If the matrix-synapse role is not used, `matrix_synapse_role_executed` won't exist. | ||||
| # We don't want to fail in such cases. | # We don't want to fail in such cases. | ||||
| @@ -11,7 +11,7 @@ | |||||
| - { path: "{{ matrix_appservice_irc_base_path }}", when: true } | - { path: "{{ matrix_appservice_irc_base_path }}", when: true } | ||||
| - { path: "{{ matrix_appservice_irc_config_path }}", when: true } | - { path: "{{ matrix_appservice_irc_config_path }}", when: true } | ||||
| - { path: "{{ matrix_appservice_irc_data_path }}", when: true } | - { path: "{{ matrix_appservice_irc_data_path }}", when: true } | ||||
| - { path: "{{ matrix_appservice_irc_docker_src_files_path }}", when: "{{ matrix_appservice_irc_container_self_build }}" } | |||||
| - { path: "{{ matrix_appservice_irc_docker_src_files_path }}", when: "{{ matrix_appservice_irc_container_image_self_build }}" } | |||||
| when: item.when|bool | when: item.when|bool | ||||
| - name: Check if an old passkey file already exists | - name: Check if an old passkey file already exists | ||||
| @@ -61,7 +61,7 @@ | |||||
| source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}" | source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}" | ||||
| force_source: "{{ matrix_appservice_irc_docker_image_force_pull if ansible_version.major > 2 or ansible_version.minor >= 8 else omit }}" | force_source: "{{ matrix_appservice_irc_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_appservice_irc_docker_image_force_pull }}" | force: "{{ omit if ansible_version.major > 2 or ansible_version.minor >= 8 else matrix_appservice_irc_docker_image_force_pull }}" | ||||
| when: "matrix_appservice_irc_enabled|bool and not matrix_appservice_irc_container_self_build|bool" | |||||
| when: "matrix_appservice_irc_enabled|bool and not matrix_appservice_irc_container_image_self_build|bool" | |||||
| - name: Ensure matrix-appservice-irc repository is present when self-building | - name: Ensure matrix-appservice-irc repository is present when self-building | ||||
| git: | git: | ||||
| @@ -69,7 +69,7 @@ | |||||
| dest: "{{ matrix_appservice_irc_docker_src_files_path }}" | dest: "{{ matrix_appservice_irc_docker_src_files_path }}" | ||||
| force: "yes" | force: "yes" | ||||
| register: matrix_appservice_irc_git_pull_results | register: matrix_appservice_irc_git_pull_results | ||||
| when: "matrix_appservice_irc_enabled|bool and matrix_appservice_irc_container_self_build|bool" | |||||
| when: "matrix_appservice_irc_enabled|bool and matrix_appservice_irc_container_image_self_build|bool" | |||||
| - name: Ensure matrix-appservice-irc Docker image is built | - name: Ensure matrix-appservice-irc Docker image is built | ||||
| docker_image: | docker_image: | ||||
| @@ -81,7 +81,7 @@ | |||||
| dockerfile: Dockerfile | dockerfile: Dockerfile | ||||
| path: "{{ matrix_appservice_irc_docker_src_files_path }}" | path: "{{ matrix_appservice_irc_docker_src_files_path }}" | ||||
| pull: yes | pull: yes | ||||
| when: "matrix_appservice_irc_enabled|bool and matrix_appservice_irc_container_self_build|bool and matrix_appservice_irc_git_pull_results.changed" | |||||
| when: "matrix_appservice_irc_enabled|bool and matrix_appservice_irc_container_image_self_build|bool and matrix_appservice_irc_git_pull_results.changed" | |||||
| - name: Ensure Matrix Appservice IRC config installed | - name: Ensure Matrix Appservice IRC config installed | ||||
| copy: | copy: | ||||
| @@ -33,3 +33,4 @@ | |||||
| when: "item.old in vars" | when: "item.old in vars" | ||||
| with_items: | with_items: | ||||
| - {'old': 'matrix_appservice_irc_container_expose_client_server_api_port', 'new': '<superseded by matrix_appservice_irc_container_http_host_bind_port>'} | - {'old': 'matrix_appservice_irc_container_expose_client_server_api_port', 'new': '<superseded by matrix_appservice_irc_container_http_host_bind_port>'} | ||||
| - {'old': 'matrix_appservice_irc_container_self_build', 'new': 'matrix_appservice_irc_container_image_self_build'} | |||||
| @@ -36,8 +36,8 @@ ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-appservice-irc | |||||
| {{ matrix_appservice_irc_docker_image }} \ | {{ matrix_appservice_irc_docker_image }} \ | ||||
| -c 'node app.js -c /config/config.yaml -f /config/registration.yaml -p 9999' | -c 'node app.js -c /config/config.yaml -f /config/registration.yaml -p 9999' | ||||
| ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-appservice-irc 2>/dev/null' | |||||
| ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-appservice-irc 2>/dev/null' | |||||
| ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-appservice-irc 2>/dev/null' | |||||
| ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-appservice-irc 2>/dev/null' | |||||
| Restart=always | Restart=always | ||||
| RestartSec=30 | RestartSec=30 | ||||
| SyslogIdentifier=matrix-appservice-irc | SyslogIdentifier=matrix-appservice-irc | ||||
| @@ -3,11 +3,11 @@ | |||||
| matrix_appservice_slack_enabled: true | matrix_appservice_slack_enabled: true | ||||
| matrix_appservice_slack_container_self_build: false | |||||
| matrix_appservice_slack_container_image_self_build: false | |||||
| matrix_appservice_slack_docker_repo: "https://github.com/matrix-org/matrix-appservice-slack.git" | matrix_appservice_slack_docker_repo: "https://github.com/matrix-org/matrix-appservice-slack.git" | ||||
| matrix_appservice_slack_docker_src_files_path: "{{ matrix_base_data_path }}/appservice-slack/docker-src" | matrix_appservice_slack_docker_src_files_path: "{{ matrix_base_data_path }}/appservice-slack/docker-src" | ||||
| matrix_appservice_slack_version: release-1.8.0 | |||||
| matrix_appservice_slack_version: release-1.10.0 | |||||
| matrix_appservice_slack_docker_image: "{{ matrix_container_global_registry_prefix }}matrixdotorg/matrix-appservice-slack:{{ matrix_appservice_slack_version }}" | matrix_appservice_slack_docker_image: "{{ matrix_container_global_registry_prefix }}matrixdotorg/matrix-appservice-slack:{{ matrix_appservice_slack_version }}" | ||||
| matrix_appservice_slack_docker_image_force_pull: "{{ matrix_appservice_slack_docker_image.endswith(':latest') }}" | matrix_appservice_slack_docker_image_force_pull: "{{ matrix_appservice_slack_docker_image.endswith(':latest') }}" | ||||
| @@ -3,7 +3,7 @@ | |||||
| - name: Fail if trying to self-build on Ansible < 2.8 | - name: Fail if trying to self-build on Ansible < 2.8 | ||||
| fail: | fail: | ||||
| msg: "To self-build the Element image, you should use Ansible 2.8 or higher. See docs/ansible.md" | msg: "To self-build the Element 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_appservice_slack_container_self_build and matrix_appservice_slack_enabled" | |||||
| when: "ansible_version.major == 2 and ansible_version.minor < 8 and matrix_appservice_slack_container_image_self_build and matrix_appservice_slack_enabled" | |||||
| # If the matrix-synapse role is not used, `matrix_synapse_role_executed` won't exist. | # If the matrix-synapse role is not used, `matrix_synapse_role_executed` won't exist. | ||||
| # We don't want to fail in such cases. | # We don't want to fail in such cases. | ||||
| @@ -44,7 +44,7 @@ | |||||
| msg: >- | msg: >- | ||||
| Trying to append Slack Appservice's reverse-proxying configuration to matrix-nginx-proxy, | Trying to append Slack Appservice's reverse-proxying configuration to matrix-nginx-proxy, | ||||
| but it's pointless since the matrix-nginx-proxy role had already executed. | but it's pointless since the matrix-nginx-proxy role had already executed. | ||||
| To fix this, please change the order of roles in your plabook, | |||||
| To fix this, please change the order of roles in your playbook, | |||||
| so that the matrix-nginx-proxy role would run after the matrix-bridge-appservice-slack role. | so that the matrix-nginx-proxy role would run after the matrix-bridge-appservice-slack role. | ||||
| when: matrix_nginx_proxy_role_executed|default(False)|bool | when: matrix_nginx_proxy_role_executed|default(False)|bool | ||||
| @@ -11,7 +11,7 @@ | |||||
| - { path: "{{ matrix_appservice_slack_base_path }}", when: true } | - { path: "{{ matrix_appservice_slack_base_path }}", when: true } | ||||
| - { path: "{{ matrix_appservice_slack_config_path }}", when: true } | - { path: "{{ matrix_appservice_slack_config_path }}", when: true } | ||||
| - { path: "{{ matrix_appservice_slack_data_path }}", when: true } | - { path: "{{ matrix_appservice_slack_data_path }}", when: true } | ||||
| - { path: "{{ matrix_appservice_slack_docker_src_files_path }}", when: "{{ matrix_appservice_slack_container_self_build }}" } | |||||
| - { path: "{{ matrix_appservice_slack_docker_src_files_path }}", when: "{{ matrix_appservice_slack_container_image_self_build }}" } | |||||
| when: item.when|bool | when: item.when|bool | ||||
| - set_fact: | - set_fact: | ||||
| @@ -37,7 +37,7 @@ | |||||
| source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}" | source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}" | ||||
| force_source: "{{ matrix_appservice_slack_docker_image_force_pull if ansible_version.major > 2 or ansible_version.minor >= 8 else omit }}" | force_source: "{{ matrix_appservice_slack_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_appservice_slack_docker_image_force_pull }}" | force: "{{ omit if ansible_version.major > 2 or ansible_version.minor >= 8 else matrix_appservice_slack_docker_image_force_pull }}" | ||||
| when: "not matrix_appservice_slack_container_self_build|bool" | |||||
| when: "not matrix_appservice_slack_container_image_self_build|bool" | |||||
| - name: Ensure matrix-appservice-slack repository is present when self-building | - name: Ensure matrix-appservice-slack repository is present when self-building | ||||
| git: | git: | ||||
| @@ -45,7 +45,7 @@ | |||||
| dest: "{{ matrix_appservice_slack_docker_src_files_path }}" | dest: "{{ matrix_appservice_slack_docker_src_files_path }}" | ||||
| force: "yes" | force: "yes" | ||||
| register: matrix_appservice_slack_git_pull_results | register: matrix_appservice_slack_git_pull_results | ||||
| when: "matrix_appservice_slack_container_self_build|bool" | |||||
| when: "matrix_appservice_slack_container_image_self_build|bool" | |||||
| - name: Ensure matrix-appservice-slack Docker image is built | - name: Ensure matrix-appservice-slack Docker image is built | ||||
| docker_image: | docker_image: | ||||
| @@ -57,7 +57,7 @@ | |||||
| dockerfile: Dockerfile | dockerfile: Dockerfile | ||||
| path: "{{ matrix_appservice_slack_docker_src_files_path }}" | path: "{{ matrix_appservice_slack_docker_src_files_path }}" | ||||
| pull: yes | pull: yes | ||||
| when: "matrix_appservice_slack_container_self_build|bool and matrix_appservice_slack_git_pull_results.changed" | |||||
| when: "matrix_appservice_slack_container_image_self_build|bool and matrix_appservice_slack_git_pull_results.changed" | |||||
| - name: Ensure Matrix Appservice Slack config installed | - name: Ensure Matrix Appservice Slack config installed | ||||
| copy: | copy: | ||||
| @@ -11,3 +11,12 @@ | |||||
| - "matrix_appservice_slack_homeserver_url" | - "matrix_appservice_slack_homeserver_url" | ||||
| - "matrix_appservice_slack_homeserver_token" | - "matrix_appservice_slack_homeserver_token" | ||||
| - "matrix_appservice_slack_id_token" | - "matrix_appservice_slack_id_token" | ||||
| - name: (Deprecation) Catch and report renamed settings | |||||
| fail: | |||||
| msg: >- | |||||
| Your configuration contains a variable, which now has a different name. | |||||
| Please change your configuration to rename the variable (`{{ item.old }}` -> `{{ item.new }}`). | |||||
| when: "item.old in vars" | |||||
| with_items: | |||||
| - {'old': 'matrix_appservice_slack_container_self_build', 'new': 'matrix_appservice_slack_container_image_self_build'} | |||||
| @@ -5,9 +5,9 @@ bot_username: "{{ matrix_appservice_slack_bot_name }}" | |||||
| username_prefix: {{ matrix_appservice_slack_user_prefix }} | username_prefix: {{ matrix_appservice_slack_user_prefix }} | ||||
| homeserver: | homeserver: | ||||
| media_url: "{{ matrix_appservice_slack_homeserver_media_url }}" | |||||
| url: "{{ matrix_appservice_slack_homeserver_url }}" | |||||
| server_name: "{{ matrix_domain }}" | server_name: "{{ matrix_domain }}" | ||||
| url: "{{ matrix_appservice_slack_homeserver_url }}" | |||||
| media_url: "{{ matrix_appservice_slack_homeserver_media_url }}" | |||||
| {% if matrix_appservice_slack_database_engine == 'nedb' %} | {% if matrix_appservice_slack_database_engine == 'nedb' %} | ||||
| dbdir: "/data" | dbdir: "/data" | ||||
| @@ -35,8 +35,8 @@ ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-appservice-sla | |||||
| {{ matrix_appservice_slack_docker_image }} \ | {{ matrix_appservice_slack_docker_image }} \ | ||||
| node app.js -p {{matrix_appservice_slack_matrix_port}} -c /config/config.yaml -f /config/slack-registration.yaml | node app.js -p {{matrix_appservice_slack_matrix_port}} -c /config/config.yaml -f /config/slack-registration.yaml | ||||
| ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-appservice-slack 2>/dev/null' | |||||
| ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-appservice-slack 2>/dev/null' | |||||
| ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-appservice-slack 2>/dev/null' | |||||
| ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-appservice-slack 2>/dev/null' | |||||
| Restart=always | Restart=always | ||||
| RestartSec=30 | RestartSec=30 | ||||
| SyslogIdentifier=matrix-appservice-slack | SyslogIdentifier=matrix-appservice-slack | ||||
| @@ -1,15 +1,15 @@ | |||||
| # matrix-appservice-webhooks is a Matrix <-> webhook bridge | # matrix-appservice-webhooks is a Matrix <-> webhook bridge | ||||
| # See: https://github.com/turt2live/matrix-appservice-webhooks | |||||
| # See: https://github.com/redoonetworks/matrix-appservice-webhooks | |||||
| matrix_appservice_webhooks_enabled: true | matrix_appservice_webhooks_enabled: true | ||||
| matrix_appservice_webhooks_container_image_self_build: false | matrix_appservice_webhooks_container_image_self_build: false | ||||
| matrix_appservice_webhooks_container_image_self_build_repo: "https://github.com/turt2live/matrix-appservice-webhooks" | |||||
| matrix_appservice_webhooks_container_image_self_build_repo: "https://github.com/redoonetworks/matrix-appservice-webhooks" | |||||
| matrix_appservice_webhooks_container_image_self_build_repo_version: "{{ 'master' if matrix_appservice_webhooks_version == 'latest' else matrix_appservice_webhooks_version }}" | matrix_appservice_webhooks_container_image_self_build_repo_version: "{{ 'master' if matrix_appservice_webhooks_version == 'latest' else matrix_appservice_webhooks_version }}" | ||||
| matrix_appservice_webhooks_container_image_self_build_repo_dockerfile_path: "Dockerfile" | matrix_appservice_webhooks_container_image_self_build_repo_dockerfile_path: "Dockerfile" | ||||
| matrix_appservice_webhooks_version: latest | |||||
| matrix_appservice_webhooks_docker_image: "{{ matrix_appservice_webhooks_docker_image_name_prefix }}turt2live/matrix-appservice-webhooks:{{ matrix_appservice_webhooks_version }}" | |||||
| matrix_appservice_webhooks_version: v1.0.3-01 | |||||
| matrix_appservice_webhooks_docker_image: "{{ matrix_appservice_webhooks_docker_image_name_prefix }}redoonetworks/matrix-appservice-webhooks:{{ matrix_appservice_webhooks_version }}" | |||||
| matrix_appservice_webhooks_docker_image_name_prefix: "{{ 'localhost/' if matrix_appservice_webhooks_container_image_self_build else matrix_container_global_registry_prefix }}" | matrix_appservice_webhooks_docker_image_name_prefix: "{{ 'localhost/' if matrix_appservice_webhooks_container_image_self_build else matrix_container_global_registry_prefix }}" | ||||
| matrix_appservice_webhooks_docker_image_force_pull: "{{ matrix_appservice_webhooks_docker_image.endswith(':latest') }}" | matrix_appservice_webhooks_docker_image_force_pull: "{{ matrix_appservice_webhooks_docker_image.endswith(':latest') }}" | ||||
| @@ -37,7 +37,7 @@ | |||||
| msg: >- | msg: >- | ||||
| Trying to append webhooks Appservice's reverse-proxying configuration to matrix-nginx-proxy, | Trying to append webhooks Appservice's reverse-proxying configuration to matrix-nginx-proxy, | ||||
| but it's pointless since the matrix-nginx-proxy role had already executed. | but it's pointless since the matrix-nginx-proxy role had already executed. | ||||
| To fix this, please change the order of roles in your plabook, | |||||
| To fix this, please change the order of roles in your playbook, | |||||
| so that the matrix-nginx-proxy role would run after the matrix-bridge-appservice-webhooks role. | so that the matrix-nginx-proxy role would run after the matrix-bridge-appservice-webhooks role. | ||||
| when: matrix_nginx_proxy_role_executed|default(False)|bool | when: matrix_nginx_proxy_role_executed|default(False)|bool | ||||
| @@ -35,8 +35,8 @@ ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-appservice-web | |||||
| {{ matrix_appservice_webhooks_docker_image }} \ | {{ matrix_appservice_webhooks_docker_image }} \ | ||||
| node index.js -p {{ matrix_appservice_webhooks_matrix_port }} -c /config/config.yaml -f /config/webhooks-registration.yaml | node index.js -p {{ matrix_appservice_webhooks_matrix_port }} -c /config/config.yaml -f /config/webhooks-registration.yaml | ||||
| ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-appservice-webhooks 2>/dev/null' | |||||
| ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-appservice-webhooks 2>/dev/null' | |||||
| ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-appservice-webhooks 2>/dev/null' | |||||
| ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-appservice-webhooks 2>/dev/null' | |||||
| Restart=always | Restart=always | ||||
| RestartSec=30 | RestartSec=30 | ||||
| SyslogIdentifier=matrix-appservice-webhooks | SyslogIdentifier=matrix-appservice-webhooks | ||||
| @@ -3,14 +3,22 @@ | |||||
| matrix_beeper_linkedin_enabled: true | matrix_beeper_linkedin_enabled: true | ||||
| matrix_beeper_linkedin_version: v0.5.1 | |||||
| matrix_beeper_linkedin_version: v0.5.2 | |||||
| # See: https://gitlab.com/beeper/linkedin/container_registry | # See: https://gitlab.com/beeper/linkedin/container_registry | ||||
| matrix_beeper_linkedin_docker_image: "registry.gitlab.com/beeper/linkedin:{{ matrix_beeper_linkedin_version }}-amd64" | |||||
| matrix_beeper_linkedin_docker_image_force_pull: "{{ matrix_beeper_linkedin_docker_image.endswith(':latest-amd64') }}" | |||||
| matrix_beeper_linkedin_docker_image: "{{ matrix_beeper_linkedin_docker_image_name_prefix }}beeper/linkedin:{{ matrix_beeper_linkedin_docker_image_tag }}" | |||||
| matrix_beeper_linkedin_docker_image_force_pull: "{{ matrix_beeper_linkedin_docker_image_tag.startswith('latest') }}" | |||||
| matrix_beeper_linkedin_docker_image_name_prefix: "{{ 'localhost/' if matrix_beeper_linkedin_container_image_self_build else 'registry.gitlab.com/' }}" | |||||
| matrix_beeper_linkedin_docker_image_tag: "{{ 'latest' if matrix_beeper_linkedin_version == 'master' else matrix_beeper_linkedin_version }}-{{ matrix_architecture }}" | |||||
| matrix_beeper_linkedin_container_image_self_build: false | |||||
| matrix_beeper_linkedin_container_image_self_build_repo: "https://gitlab.com/beeper/linkedin" | |||||
| matrix_beeper_linkedin_container_image_self_build_branch: "{{ matrix_beeper_linkedin_version }}" | |||||
| matrix_beeper_linkedin_base_path: "{{ matrix_base_data_path }}/beeper-linkedin" | matrix_beeper_linkedin_base_path: "{{ matrix_base_data_path }}/beeper-linkedin" | ||||
| matrix_beeper_linkedin_config_path: "{{ matrix_beeper_linkedin_base_path }}/config" | matrix_beeper_linkedin_config_path: "{{ matrix_beeper_linkedin_base_path }}/config" | ||||
| matrix_beeper_linkedin_data_path: "{{ matrix_beeper_linkedin_base_path }}/data" | matrix_beeper_linkedin_data_path: "{{ matrix_beeper_linkedin_base_path }}/data" | ||||
| matrix_beeper_linkedin_docker_src_files_path: "{{ matrix_beeper_linkedin_base_path }}/docker-src" | |||||
| matrix_beeper_linkedin_homeserver_address: "{{ matrix_homeserver_container_url }}" | matrix_beeper_linkedin_homeserver_address: "{{ matrix_homeserver_container_url }}" | ||||
| matrix_beeper_linkedin_homeserver_domain: "{{ matrix_domain }}" | matrix_beeper_linkedin_homeserver_domain: "{{ matrix_domain }}" | ||||
| @@ -7,6 +7,20 @@ | |||||
| msg: >- | msg: >- | ||||
| The matrix-bridge-beeper-linkedin role needs to execute before the matrix-synapse role. | The matrix-bridge-beeper-linkedin role needs to execute before the matrix-synapse role. | ||||
| when: "matrix_synapse_role_executed|default(False)" | when: "matrix_synapse_role_executed|default(False)" | ||||
| - name: Ensure Beeper LinkedIn paths exists | |||||
| file: | |||||
| path: "{{ item.path }}" | |||||
| state: directory | |||||
| mode: 0750 | |||||
| owner: "{{ matrix_user_username }}" | |||||
| group: "{{ matrix_user_groupname }}" | |||||
| with_items: | |||||
| - { path: "{{ matrix_beeper_linkedin_base_path }}", when: true } | |||||
| - { path: "{{ matrix_beeper_linkedin_config_path }}", when: true } | |||||
| - { path: "{{ matrix_beeper_linkedin_data_path }}", when: true } | |||||
| - { path: "{{ matrix_beeper_linkedin_docker_src_files_path }}", when: "{{ matrix_beeper_linkedin_container_image_self_build }}" } | |||||
| when: "item.when|bool" | |||||
| - name: Ensure Beeper LinkedIn image is pulled | - name: Ensure Beeper LinkedIn image is pulled | ||||
| docker_image: | docker_image: | ||||
| @@ -14,18 +28,42 @@ | |||||
| source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}" | source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}" | ||||
| force_source: "{{ matrix_beeper_linkedin_docker_image_force_pull if ansible_version.major > 2 or ansible_version.minor >= 8 else omit }}" | force_source: "{{ matrix_beeper_linkedin_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_beeper_linkedin_docker_image_force_pull }}" | force: "{{ omit if ansible_version.major > 2 or ansible_version.minor >= 8 else matrix_beeper_linkedin_docker_image_force_pull }}" | ||||
| when: "not matrix_beeper_linkedin_container_image_self_build|bool" | |||||
| - name: Ensure Beeper LinkedIn paths exists | |||||
| file: | |||||
| path: "{{ item }}" | |||||
| state: directory | |||||
| mode: 0750 | |||||
| owner: "{{ matrix_user_username }}" | |||||
| group: "{{ matrix_user_groupname }}" | |||||
| with_items: | |||||
| - "{{ matrix_beeper_linkedin_base_path }}" | |||||
| - "{{ matrix_beeper_linkedin_config_path }}" | |||||
| - "{{ matrix_beeper_linkedin_data_path }}" | |||||
| - block: | |||||
| - name: Ensure Beeper LinkedIn repository is present on self-build | |||||
| git: | |||||
| repo: "{{ matrix_beeper_linkedin_container_image_self_build_repo }}" | |||||
| dest: "{{ matrix_beeper_linkedin_docker_src_files_path }}" | |||||
| version: "{{ matrix_beeper_linkedin_container_image_self_build_branch }}" | |||||
| force: "yes" | |||||
| register: matrix_beeper_linkedin_git_pull_results | |||||
| # Building the container image (using the default Dockerfile) requires that a docker-requirements.txt file be generated. | |||||
| # See: https://gitlab.com/beeper/linkedin/-/blob/94442db17ccb9769b377cdb8e4bf1cb3955781d7/.gitlab-ci.yml#L30-40 | |||||
| - name: Ensure docker-requirements.txt is generated before building Beeper LinkedIn Docker Image | |||||
| command: | | |||||
| {{ matrix_host_command_docker }} run \ | |||||
| --rm \ | |||||
| --entrypoint=/bin/sh \ | |||||
| --mount type=bind,src={{ matrix_beeper_linkedin_docker_src_files_path }},dst=/work \ | |||||
| -w /work \ | |||||
| docker.io/python:3.9.6-buster \ | |||||
| -c "pip install poetry && poetry export --without-hashes -E e2be -E images -E metrics | sed 's/==.*//g' > docker-requirements.txt" | |||||
| - name: Ensure Beeper LinkedIn Docker image is built | |||||
| docker_image: | |||||
| name: "{{ matrix_beeper_linkedin_docker_image }}" | |||||
| source: build | |||||
| force_source: "{{ matrix_beeper_linkedin_git_pull_results.changed 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_beeper_linkedin_git_pull_results.changed }}" | |||||
| build: | |||||
| dockerfile: Dockerfile | |||||
| path: "{{ matrix_beeper_linkedin_docker_src_files_path }}" | |||||
| pull: yes | |||||
| args: | |||||
| TARGETARCH: "{{ matrix_architecture }}" | |||||
| when: "matrix_beeper_linkedin_container_image_self_build|bool" | |||||
| - name: Ensure beeper-linkedin config.yaml installed | - name: Ensure beeper-linkedin config.yaml installed | ||||
| copy: | copy: | ||||
| @@ -32,8 +32,8 @@ ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-beeper-linkedi | |||||
| {{ matrix_beeper_linkedin_docker_image }} \ | {{ matrix_beeper_linkedin_docker_image }} \ | ||||
| python3 -m linkedin_matrix -c /data/config.yaml -r /data/registration.yaml | python3 -m linkedin_matrix -c /data/config.yaml -r /data/registration.yaml | ||||
| ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-beeper-linkedin 2>/dev/null' | |||||
| ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-beeper-linkedin 2>/dev/null' | |||||
| ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-beeper-linkedin 2>/dev/null' | |||||
| ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-beeper-linkedin 2>/dev/null' | |||||
| Restart=always | Restart=always | ||||
| RestartSec=30 | RestartSec=30 | ||||
| SyslogIdentifier=matrix-beeper-linkedin | SyslogIdentifier=matrix-beeper-linkedin | ||||
| @@ -3,7 +3,7 @@ | |||||
| matrix_heisenbridge_enabled: true | matrix_heisenbridge_enabled: true | ||||
| matrix_heisenbridge_version: 1.7.1 | |||||
| matrix_heisenbridge_version: 1.10.0 | |||||
| matrix_heisenbridge_docker_image: "{{ matrix_container_global_registry_prefix }}hif1/heisenbridge:{{ matrix_heisenbridge_version }}" | matrix_heisenbridge_docker_image: "{{ matrix_container_global_registry_prefix }}hif1/heisenbridge:{{ matrix_heisenbridge_version }}" | ||||
| matrix_heisenbridge_docker_image_force_pull: "{{ matrix_heisenbridge_docker_image.endswith(':latest') }}" | matrix_heisenbridge_docker_image_force_pull: "{{ matrix_heisenbridge_docker_image.endswith(':latest') }}" | ||||
| @@ -41,8 +41,8 @@ ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-heisenbridge \ | |||||
| --listen-port 9898 \ | --listen-port 9898 \ | ||||
| {{ matrix_heisenbridge_homeserver_url }} | {{ matrix_heisenbridge_homeserver_url }} | ||||
| ExecStop=-{{ matrix_host_command_docker }} kill matrix-heisenbridge | |||||
| ExecStop=-{{ matrix_host_command_docker }} rm matrix-heisenbridge | |||||
| ExecStopPost=-{{ matrix_host_command_docker }} kill matrix-heisenbridge | |||||
| ExecStopPost=-{{ matrix_host_command_docker }} rm matrix-heisenbridge | |||||
| Restart=always | Restart=always | ||||
| RestartSec=30 | RestartSec=30 | ||||
| SyslogIdentifier=matrix-heisenbridge | SyslogIdentifier=matrix-heisenbridge | ||||
| @@ -32,8 +32,8 @@ ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-mautrix-facebo | |||||
| {{ matrix_mautrix_facebook_docker_image }} \ | {{ matrix_mautrix_facebook_docker_image }} \ | ||||
| python3 -m mautrix_facebook -c /config/config.yaml --no-update | python3 -m mautrix_facebook -c /config/config.yaml --no-update | ||||
| ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-mautrix-facebook 2>/dev/null' | |||||
| ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-mautrix-facebook 2>/dev/null' | |||||
| ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-mautrix-facebook 2>/dev/null' | |||||
| ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-mautrix-facebook 2>/dev/null' | |||||
| Restart=always | Restart=always | ||||
| RestartSec=30 | RestartSec=30 | ||||
| SyslogIdentifier=matrix-mautrix-facebook | SyslogIdentifier=matrix-mautrix-facebook | ||||
| @@ -28,7 +28,7 @@ | |||||
| msg: >- | msg: >- | ||||
| Trying to append Mautrix googlechat's reverse-proxying configuration to matrix-nginx-proxy, | Trying to append Mautrix googlechat's reverse-proxying configuration to matrix-nginx-proxy, | ||||
| but it's pointless since the matrix-nginx-proxy role had already executed. | but it's pointless since the matrix-nginx-proxy role had already executed. | ||||
| To fix this, please change the order of roles in your plabook, | |||||
| To fix this, please change the order of roles in your playbook, | |||||
| so that the matrix-nginx-proxy role would run after the matrix-bridge-mautrix-googlechat role. | so that the matrix-nginx-proxy role would run after the matrix-bridge-mautrix-googlechat role. | ||||
| when: matrix_nginx_proxy_role_executed|default(False)|bool | when: matrix_nginx_proxy_role_executed|default(False)|bool | ||||
| @@ -33,8 +33,8 @@ ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-mautrix-google | |||||
| {{ matrix_mautrix_googlechat_docker_image }} \ | {{ matrix_mautrix_googlechat_docker_image }} \ | ||||
| python3 -m mautrix_googlechat -c /config/config.yaml --no-update | python3 -m mautrix_googlechat -c /config/config.yaml --no-update | ||||
| ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-mautrix-googlechat 2>/dev/null' | |||||
| ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-mautrix-googlechat 2>/dev/null' | |||||
| ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-mautrix-googlechat 2>/dev/null' | |||||
| ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-mautrix-googlechat 2>/dev/null' | |||||
| Restart=always | Restart=always | ||||
| RestartSec=30 | RestartSec=30 | ||||
| SyslogIdentifier=matrix-mautrix-googlechat | SyslogIdentifier=matrix-mautrix-googlechat | ||||
| @@ -28,7 +28,7 @@ | |||||
| msg: >- | msg: >- | ||||
| Trying to append Mautrix Hangouts's reverse-proxying configuration to matrix-nginx-proxy, | Trying to append Mautrix Hangouts's reverse-proxying configuration to matrix-nginx-proxy, | ||||
| but it's pointless since the matrix-nginx-proxy role had already executed. | but it's pointless since the matrix-nginx-proxy role had already executed. | ||||
| To fix this, please change the order of roles in your plabook, | |||||
| To fix this, please change the order of roles in your playbook, | |||||
| so that the matrix-nginx-proxy role would run after the matrix-bridge-mautrix-hangouts role. | so that the matrix-nginx-proxy role would run after the matrix-bridge-mautrix-hangouts role. | ||||
| when: matrix_nginx_proxy_role_executed|default(False)|bool | when: matrix_nginx_proxy_role_executed|default(False)|bool | ||||
| @@ -44,8 +44,8 @@ ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-mautrix-hangou | |||||
| {{ matrix_mautrix_hangouts_docker_image }} \ | {{ matrix_mautrix_hangouts_docker_image }} \ | ||||
| python3 -m mautrix_hangouts -c /config/config.yaml --no-update | python3 -m mautrix_hangouts -c /config/config.yaml --no-update | ||||
| ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-mautrix-hangouts 2>/dev/null' | |||||
| ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-mautrix-hangouts 2>/dev/null' | |||||
| ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-mautrix-hangouts 2>/dev/null' | |||||
| ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-mautrix-hangouts 2>/dev/null' | |||||
| Restart=always | Restart=always | ||||
| RestartSec=30 | RestartSec=30 | ||||
| SyslogIdentifier=matrix-mautrix-hangouts | SyslogIdentifier=matrix-mautrix-hangouts | ||||
| @@ -6,7 +6,7 @@ matrix_mautrix_instagram_enabled: true | |||||
| matrix_mautrix_instagram_container_image_self_build: false | matrix_mautrix_instagram_container_image_self_build: false | ||||
| matrix_mautrix_instagram_container_image_self_build_repo: "https://github.com/mautrix/instagram.git" | matrix_mautrix_instagram_container_image_self_build_repo: "https://github.com/mautrix/instagram.git" | ||||
| matrix_mautrix_instagram_version: latest | |||||
| matrix_mautrix_instagram_version: v0.1.2 | |||||
| # See: https://mau.dev/tulir/mautrix-instagram/container_registry | # See: https://mau.dev/tulir/mautrix-instagram/container_registry | ||||
| matrix_mautrix_instagram_docker_image: "{{ matrix_mautrix_instagram_docker_image_name_prefix }}mautrix/instagram:{{ matrix_mautrix_instagram_version }}" | matrix_mautrix_instagram_docker_image: "{{ matrix_mautrix_instagram_docker_image_name_prefix }}mautrix/instagram:{{ matrix_mautrix_instagram_version }}" | ||||
| matrix_mautrix_instagram_docker_image_name_prefix: "{{ 'localhost/' if matrix_mautrix_instagram_container_image_self_build else 'dock.mau.dev/' }}" | matrix_mautrix_instagram_docker_image_name_prefix: "{{ 'localhost/' if matrix_mautrix_instagram_container_image_self_build else 'dock.mau.dev/' }}" | ||||
| @@ -43,7 +43,7 @@ appservice: | |||||
| bot_username: {{ matrix_mautrix_instagram_appservice_bot_username|to_json }} | bot_username: {{ matrix_mautrix_instagram_appservice_bot_username|to_json }} | ||||
| # Display name and avatar for bot. Set to "remove" to remove display name/avatar, leave empty | # Display name and avatar for bot. Set to "remove" to remove display name/avatar, leave empty | ||||
| # to leave display name/avatar as-is. | # to leave display name/avatar as-is. | ||||
| bot_displayname: instagram bridge bot | |||||
| bot_displayname: Instagram bridge bot | |||||
| bot_avatar: mxc://maunium.net/JxjlbZUlCPULEeHZSwleUXQv | bot_avatar: mxc://maunium.net/JxjlbZUlCPULEeHZSwleUXQv | ||||
| # Community ID for bridged users (changes registration file) and rooms. | # Community ID for bridged users (changes registration file) and rooms. | ||||
| @@ -32,8 +32,8 @@ ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-mautrix-instag | |||||
| {{ matrix_mautrix_instagram_docker_image }} \ | {{ matrix_mautrix_instagram_docker_image }} \ | ||||
| python3 -m mautrix_instagram -c /config/config.yaml --no-update | python3 -m mautrix_instagram -c /config/config.yaml --no-update | ||||
| ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-mautrix-instagram 2>/dev/null' | |||||
| ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-mautrix-instagram 2>/dev/null' | |||||
| ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-mautrix-instagram 2>/dev/null' | |||||
| ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-mautrix-instagram 2>/dev/null' | |||||
| Restart=always | Restart=always | ||||
| RestartSec=30 | RestartSec=30 | ||||
| SyslogIdentifier=matrix-mautrix-instagram | SyslogIdentifier=matrix-mautrix-instagram | ||||
| @@ -3,17 +3,17 @@ | |||||
| matrix_mautrix_signal_enabled: true | matrix_mautrix_signal_enabled: true | ||||
| matrix_mautrix_signal_container_self_build: false | |||||
| matrix_mautrix_signal_container_image_self_build: false | |||||
| matrix_mautrix_signal_docker_repo: "https://mau.dev/mautrix/signal.git" | matrix_mautrix_signal_docker_repo: "https://mau.dev/mautrix/signal.git" | ||||
| matrix_mautrix_signal_docker_src_files_path: "{{ matrix_base_data_path }}/mautrix-signal/docker-src" | matrix_mautrix_signal_docker_src_files_path: "{{ matrix_base_data_path }}/mautrix-signal/docker-src" | ||||
| matrix_mautrix_signal_version: latest | |||||
| matrix_mautrix_signal_daemon_version: latest | |||||
| matrix_mautrix_signal_version: v0.2.2 | |||||
| matrix_mautrix_signal_daemon_version: 0.16.1 | |||||
| # See: https://mau.dev/mautrix/signal/container_registry | # See: https://mau.dev/mautrix/signal/container_registry | ||||
| matrix_mautrix_signal_docker_image: "dock.mau.dev/mautrix/signal:{{ matrix_mautrix_signal_version }}" | matrix_mautrix_signal_docker_image: "dock.mau.dev/mautrix/signal:{{ matrix_mautrix_signal_version }}" | ||||
| matrix_mautrix_signal_docker_image_force_pull: "{{ matrix_mautrix_signal_docker_image.endswith(':latest') }}" | matrix_mautrix_signal_docker_image_force_pull: "{{ matrix_mautrix_signal_docker_image.endswith(':latest') }}" | ||||
| matrix_mautrix_signal_daemon_container_self_build: false | |||||
| matrix_mautrix_signal_daemon_container_image_self_build: false | |||||
| matrix_mautrix_signal_daemon_docker_repo: "https://mau.dev/maunium/signald.git" | matrix_mautrix_signal_daemon_docker_repo: "https://mau.dev/maunium/signald.git" | ||||
| matrix_mautrix_signal_daemon_docker_src_files_path: "{{ matrix_base_data_path }}/mautrix-signald/docker-src" | matrix_mautrix_signal_daemon_docker_src_files_path: "{{ matrix_base_data_path }}/mautrix-signald/docker-src" | ||||
| @@ -14,7 +14,7 @@ | |||||
| source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}" | source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}" | ||||
| force_source: "{{ matrix_mautrix_signal_docker_image_force_pull if ansible_version.major > 2 or ansible_version.minor >= 8 else omit }}" | force_source: "{{ matrix_mautrix_signal_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_mautrix_signal_docker_image_force_pull }}" | force: "{{ omit if ansible_version.major > 2 or ansible_version.minor >= 8 else matrix_mautrix_signal_docker_image_force_pull }}" | ||||
| when: "not matrix_mautrix_signal_container_self_build|bool" | |||||
| when: "not matrix_mautrix_signal_container_image_self_build|bool" | |||||
| - name: Ensure Mautrix Signal repository is present on self-build | - name: Ensure Mautrix Signal repository is present on self-build | ||||
| @@ -23,19 +23,19 @@ | |||||
| dest: "{{ matrix_mautrix_signal_docker_src_files_path }}" | dest: "{{ matrix_mautrix_signal_docker_src_files_path }}" | ||||
| force: "yes" | force: "yes" | ||||
| register: matrix_mautrix_signal_git_pull_results | register: matrix_mautrix_signal_git_pull_results | ||||
| when: "matrix_mautrix_signal_container_self_build|bool" | |||||
| when: "matrix_mautrix_signal_container_image_self_build|bool" | |||||
| - name: Ensure Mautrix Signal image is built | - name: Ensure Mautrix Signal image is built | ||||
| docker_image: | docker_image: | ||||
| name: "{{ matrix_mautrix_signal_docker_image }}" | name: "{{ matrix_mautrix_signal_docker_image }}" | ||||
| source: build | source: build | ||||
| force_source: "{{ matrix_mautrix_signal_git_pull_results.changed if ansible_version.major > 2 or ansible_version.minor >= 8 else omit }}" | force_source: "{{ matrix_mautrix_signal_git_pull_results.changed 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_mailer_git_pull_results.changed }}" | |||||
| force: "{{ omit if ansible_version.major > 2 or ansible_version.minor >= 8 else matrix_mautrix_signal_git_pull_results.changed }}" | |||||
| build: | build: | ||||
| dockerfile: Dockerfile | dockerfile: Dockerfile | ||||
| path: "{{ matrix_mautrix_signal_docker_src_files_path }}" | path: "{{ matrix_mautrix_signal_docker_src_files_path }}" | ||||
| pull: yes | pull: yes | ||||
| when: "matrix_mautrix_signal_container_self_build|bool" | |||||
| when: "matrix_mautrix_signal_container_image_self_build|bool" | |||||
| - name: Ensure Mautrix Signal Daemon image is pulled | - name: Ensure Mautrix Signal Daemon image is pulled | ||||
| @@ -44,7 +44,7 @@ | |||||
| source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}" | source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}" | ||||
| force_source: "{{ matrix_mautrix_signal_daemon_docker_image_force_pull if ansible_version.major > 2 or ansible_version.minor >= 8 else omit }}" | force_source: "{{ matrix_mautrix_signal_daemon_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_mautrix_signal_daemon_docker_image_force_pull }}" | force: "{{ omit if ansible_version.major > 2 or ansible_version.minor >= 8 else matrix_mautrix_signal_daemon_docker_image_force_pull }}" | ||||
| when: matrix_mautrix_signal_enabled and not matrix_mautrix_signal_daemon_container_self_build|bool | |||||
| when: matrix_mautrix_signal_enabled and not matrix_mautrix_signal_daemon_container_image_self_build|bool | |||||
| register: matrix_mautrix_signal_daemon_pull_results | register: matrix_mautrix_signal_daemon_pull_results | ||||
| - name: Ensure Mautrix Signal Daemon repository is present on self-build | - name: Ensure Mautrix Signal Daemon repository is present on self-build | ||||
| @@ -53,19 +53,19 @@ | |||||
| dest: "{{ matrix_mautrix_signal_daemon_docker_src_files_path }}" | dest: "{{ matrix_mautrix_signal_daemon_docker_src_files_path }}" | ||||
| force: "yes" | force: "yes" | ||||
| register: matrix_mautrix_signal_daemon_git_pull_results | register: matrix_mautrix_signal_daemon_git_pull_results | ||||
| when: "matrix_mautrix_signal_daemon_container_self_build|bool" | |||||
| when: "matrix_mautrix_signal_daemon_container_image_self_build|bool" | |||||
| - name: Ensure Mautrix Signal Daemon image is built | - name: Ensure Mautrix Signal Daemon image is built | ||||
| docker_image: | docker_image: | ||||
| name: "{{ matrix_mautrix_signal_daemon_docker_image }}" | name: "{{ matrix_mautrix_signal_daemon_docker_image }}" | ||||
| source: build | source: build | ||||
| force_source: "{{ matrix_mautrix_signal_daemon_git_pull_results.changed if ansible_version.major > 2 or ansible_version.minor >= 8 else omit }}" | force_source: "{{ matrix_mautrix_signal_daemon_git_pull_results.changed 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_mailer_git_pull_results.changed }}" | |||||
| force: "{{ omit if ansible_version.major > 2 or ansible_version.minor >= 8 else matrix_mautrix_signal_daemon_git_pull_results.changed }}" | |||||
| build: | build: | ||||
| dockerfile: Dockerfile | dockerfile: Dockerfile | ||||
| path: "{{ matrix_mautrix_signal_daemon_docker_src_files_path }}" | path: "{{ matrix_mautrix_signal_daemon_docker_src_files_path }}" | ||||
| pull: yes | pull: yes | ||||
| when: "matrix_mautrix_signal_daemon_container_self_build|bool" | |||||
| when: "matrix_mautrix_signal_daemon_container_image_self_build|bool" | |||||
| - name: Ensure Mautrix Signal paths exist | - name: Ensure Mautrix Signal paths exist | ||||
| file: | file: | ||||
| @@ -26,3 +26,5 @@ | |||||
| - {'old': 'matrix_mautrix_signal_db_port', 'new': 'matrix_mautrix_signal_database_port'} | - {'old': 'matrix_mautrix_signal_db_port', 'new': 'matrix_mautrix_signal_database_port'} | ||||
| - {'old': 'matrix_mautrix_signal_db_url', 'new': 'matrix_mautrix_signal_database_connection_string'} | - {'old': 'matrix_mautrix_signal_db_url', 'new': 'matrix_mautrix_signal_database_connection_string'} | ||||
| - {'old': 'matrix_mautrix_signal_configuration_permissions', 'new': '<superseded by matrix_mautrix_signal_configuration_extension_yaml>'} | - {'old': 'matrix_mautrix_signal_configuration_permissions', 'new': '<superseded by matrix_mautrix_signal_configuration_extension_yaml>'} | ||||
| - {'old': 'matrix_mautrix_signal_container_self_build', 'new': 'matrix_mautrix_signal_container_image_self_build'} | |||||
| - {'old': 'matrix_mautrix_signal_daemon_container_self_build', 'new': 'matrix_mautrix_signal_daemon_container_image_self_build'} | |||||
| @@ -30,8 +30,8 @@ ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-mautrix-signal | |||||
| -v {{ matrix_mautrix_signal_daemon_path }}:/signald:z \ | -v {{ matrix_mautrix_signal_daemon_path }}:/signald:z \ | ||||
| {{ matrix_mautrix_signal_daemon_docker_image }} | {{ matrix_mautrix_signal_daemon_docker_image }} | ||||
| ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-mautrix-signal-daemon 2>/dev/null' | |||||
| ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-mautrix-signal-daemon 2>/dev/null' | |||||
| ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-mautrix-signal-daemon 2>/dev/null' | |||||
| ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-mautrix-signal-daemon 2>/dev/null' | |||||
| Restart=always | Restart=always | ||||
| RestartSec=30 | RestartSec=30 | ||||
| @@ -26,6 +26,7 @@ ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-mautrix-signal | |||||
| --user={{ matrix_user_uid }}:{{ matrix_user_gid }} \ | --user={{ matrix_user_uid }}:{{ matrix_user_gid }} \ | ||||
| --cap-drop=ALL \ | --cap-drop=ALL \ | ||||
| --read-only \ | --read-only \ | ||||
| --tmpfs /tmp \ | |||||
| {% if matrix_mautrix_signal_container_http_host_bind_port %} | {% if matrix_mautrix_signal_container_http_host_bind_port %} | ||||
| -p {{ matrix_mautrix_signal_container_http_host_bind_port }}:29328 \ | -p {{ matrix_mautrix_signal_container_http_host_bind_port }}:29328 \ | ||||
| {% endif %} | {% endif %} | ||||
| @@ -37,8 +38,8 @@ ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-mautrix-signal | |||||
| {{ matrix_mautrix_signal_docker_image }} \ | {{ matrix_mautrix_signal_docker_image }} \ | ||||
| python3 -m mautrix_signal -c /config/config.yaml --no-update | python3 -m mautrix_signal -c /config/config.yaml --no-update | ||||
| ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-mautrix-signal 2>/dev/null' | |||||
| ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-mautrix-signal 2>/dev/null' | |||||
| ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-mautrix-signal 2>/dev/null' | |||||
| ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-mautrix-signal 2>/dev/null' | |||||
| Restart=always | Restart=always | ||||
| RestartSec=30 | RestartSec=30 | ||||
| @@ -3,17 +3,17 @@ | |||||
| matrix_mautrix_telegram_enabled: true | matrix_mautrix_telegram_enabled: true | ||||
| matrix_telegram_lottieconverter_container_self_build: false | |||||
| matrix_telegram_lottieconverter_container_self_build_mask_arch: false | |||||
| matrix_telegram_lottieconverter_container_image_self_build: false | |||||
| matrix_telegram_lottieconverter_container_image_self_build_mask_arch: false | |||||
| matrix_telegram_lottieconverter_docker_repo: "https://mau.dev/tulir/lottieconverter.git" | matrix_telegram_lottieconverter_docker_repo: "https://mau.dev/tulir/lottieconverter.git" | ||||
| matrix_telegram_lottieconverter_docker_src_files_path: "{{ matrix_base_data_path }}/lotticonverter/docker-src" | matrix_telegram_lottieconverter_docker_src_files_path: "{{ matrix_base_data_path }}/lotticonverter/docker-src" | ||||
| matrix_telegram_lottieconverter_docker_image: "dock.mau.dev/tulir/lottieconverter:alpine-3.14" # needs to be ajusted according to FROM clause of Dockerfile of mautrix-telegram | |||||
| matrix_telegram_lottieconverter_docker_image: "dock.mau.dev/tulir/lottieconverter:alpine-3.15" # needs to be ajusted according to FROM clause of Dockerfile of mautrix-telegram | |||||
| matrix_mautrix_telegram_container_self_build: false | |||||
| matrix_mautrix_telegram_container_image_self_build: false | |||||
| matrix_mautrix_telegram_docker_repo: "https://mau.dev/mautrix/telegram.git" | matrix_mautrix_telegram_docker_repo: "https://mau.dev/mautrix/telegram.git" | ||||
| matrix_mautrix_telegram_docker_src_files_path: "{{ matrix_base_data_path }}/mautrix-telegram/docker-src" | matrix_mautrix_telegram_docker_src_files_path: "{{ matrix_base_data_path }}/mautrix-telegram/docker-src" | ||||
| matrix_mautrix_telegram_version: v0.10.2 | |||||
| matrix_mautrix_telegram_version: v0.11.1 | |||||
| # See: https://mau.dev/mautrix/telegram/container_registry | # See: https://mau.dev/mautrix/telegram/container_registry | ||||
| matrix_mautrix_telegram_docker_image: "dock.mau.dev/mautrix/telegram:{{ matrix_mautrix_telegram_version }}" | matrix_mautrix_telegram_docker_image: "dock.mau.dev/mautrix/telegram:{{ matrix_mautrix_telegram_version }}" | ||||
| matrix_mautrix_telegram_docker_image_force_pull: "{{ matrix_mautrix_telegram_docker_image.endswith(':latest') }}" | matrix_mautrix_telegram_docker_image_force_pull: "{{ matrix_mautrix_telegram_docker_image.endswith(':latest') }}" | ||||
| @@ -130,3 +130,8 @@ matrix_mautrix_telegram_registration_yaml: | | |||||
| de.sorunome.msc2409.push_ephemeral: true | de.sorunome.msc2409.push_ephemeral: true | ||||
| matrix_mautrix_telegram_registration: "{{ matrix_mautrix_telegram_registration_yaml|from_yaml }}" | matrix_mautrix_telegram_registration: "{{ matrix_mautrix_telegram_registration_yaml|from_yaml }}" | ||||
| # Templates for defining MXID's and displaynames for users and rooms. | |||||
| matrix_mautrix_telegram_username_template: 'telegram_{userid}' | |||||
| matrix_mautrix_telegram_alias_template: 'telegram_{groupname}' | |||||
| matrix_mautrix_telegram_displayname_template: '{displayname} (Telegram)' | |||||
| @@ -3,7 +3,7 @@ | |||||
| - name: Fail if trying to self-build on Ansible < 2.8 | - name: Fail if trying to self-build on Ansible < 2.8 | ||||
| fail: | fail: | ||||
| msg: "To self-build the Element image, you should use Ansible 2.8 or higher. See docs/ansible.md" | msg: "To self-build the Element 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_mautrix_telegram_container_self_build and matrix_mautrix_telegram_enabled" | |||||
| when: "ansible_version.major == 2 and ansible_version.minor < 8 and matrix_mautrix_telegram_container_image_self_build and matrix_mautrix_telegram_enabled" | |||||
| - set_fact: | - set_fact: | ||||
| matrix_systemd_services_list: "{{ matrix_systemd_services_list + ['matrix-mautrix-telegram.service'] }}" | matrix_systemd_services_list: "{{ matrix_systemd_services_list + ['matrix-mautrix-telegram.service'] }}" | ||||
| @@ -28,7 +28,7 @@ | |||||
| msg: >- | msg: >- | ||||
| Trying to append Mautrix Telegram's reverse-proxying configuration to matrix-nginx-proxy, | Trying to append Mautrix Telegram's reverse-proxying configuration to matrix-nginx-proxy, | ||||
| but it's pointless since the matrix-nginx-proxy role had already executed. | but it's pointless since the matrix-nginx-proxy role had already executed. | ||||
| To fix this, please change the order of roles in your plabook, | |||||
| To fix this, please change the order of roles in your playbook, | |||||
| so that the matrix-nginx-proxy role would run after the matrix-bridge-mautrix-telegram role. | so that the matrix-nginx-proxy role would run after the matrix-bridge-mautrix-telegram role. | ||||
| when: matrix_nginx_proxy_role_executed|default(False)|bool | when: matrix_nginx_proxy_role_executed|default(False)|bool | ||||
| @@ -45,7 +45,7 @@ | |||||
| - { path: "{{ matrix_mautrix_telegram_base_path }}", when: true } | - { path: "{{ matrix_mautrix_telegram_base_path }}", when: true } | ||||
| - { path: "{{ matrix_mautrix_telegram_config_path }}", when: true } | - { path: "{{ matrix_mautrix_telegram_config_path }}", when: true } | ||||
| - { path: "{{ matrix_mautrix_telegram_data_path }}", when: true } | - { path: "{{ matrix_mautrix_telegram_data_path }}", when: true } | ||||
| - { path: "{{ matrix_mautrix_telegram_docker_src_files_path }}", when: "{{ matrix_mautrix_telegram_container_self_build }}" } | |||||
| - { path: "{{ matrix_mautrix_telegram_docker_src_files_path }}", when: "{{ matrix_mautrix_telegram_container_image_self_build }}" } | |||||
| when: item.when|bool | when: item.when|bool | ||||
| - name: Ensure Mautrix Telegram image is pulled | - name: Ensure Mautrix Telegram image is pulled | ||||
| @@ -54,7 +54,7 @@ | |||||
| source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}" | source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}" | ||||
| force_source: "{{ matrix_mautrix_telegram_docker_image_force_pull if ansible_version.major > 2 or ansible_version.minor >= 8 else omit }}" | force_source: "{{ matrix_mautrix_telegram_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_mautrix_telegram_docker_image_force_pull }}" | force: "{{ omit if ansible_version.major > 2 or ansible_version.minor >= 8 else matrix_mautrix_telegram_docker_image_force_pull }}" | ||||
| when: "not matrix_mautrix_telegram_container_self_build|bool" | |||||
| when: "not matrix_mautrix_telegram_container_image_self_build|bool" | |||||
| - name: Ensure lottieconverter is present when self-building | - name: Ensure lottieconverter is present when self-building | ||||
| git: | git: | ||||
| @@ -62,7 +62,7 @@ | |||||
| dest: "{{ matrix_telegram_lottieconverter_docker_src_files_path }}" | dest: "{{ matrix_telegram_lottieconverter_docker_src_files_path }}" | ||||
| force: "yes" | force: "yes" | ||||
| register: matrix_telegram_lottieconverter_git_pull_results | register: matrix_telegram_lottieconverter_git_pull_results | ||||
| when: "matrix_telegram_lottieconverter_container_self_build|bool and matrix_mautrix_telegram_container_self_build|bool" | |||||
| when: "matrix_telegram_lottieconverter_container_image_self_build|bool and matrix_mautrix_telegram_container_image_self_build|bool" | |||||
| - name: Ensure lottieconverter Docker image is built | - name: Ensure lottieconverter Docker image is built | ||||
| docker_image: | docker_image: | ||||
| @@ -74,7 +74,7 @@ | |||||
| dockerfile: Dockerfile | dockerfile: Dockerfile | ||||
| path: "{{ matrix_telegram_lottieconverter_docker_src_files_path }}" | path: "{{ matrix_telegram_lottieconverter_docker_src_files_path }}" | ||||
| pull: yes | pull: yes | ||||
| when: "matrix_telegram_lottieconverter_container_self_build|bool and matrix_telegram_lottieconverter_git_pull_results.changed and matrix_mautrix_telegram_container_self_build|bool" | |||||
| when: "matrix_telegram_lottieconverter_container_image_self_build|bool and matrix_telegram_lottieconverter_git_pull_results.changed and matrix_mautrix_telegram_container_image_self_build|bool" | |||||
| - name: Ensure matrix-mautrix-telegram repository is present when self-building | - name: Ensure matrix-mautrix-telegram repository is present when self-building | ||||
| git: | git: | ||||
| @@ -82,7 +82,7 @@ | |||||
| dest: "{{ matrix_mautrix_telegram_docker_src_files_path }}" | dest: "{{ matrix_mautrix_telegram_docker_src_files_path }}" | ||||
| force: "yes" | force: "yes" | ||||
| register: matrix_mautrix_telegram_git_pull_results | register: matrix_mautrix_telegram_git_pull_results | ||||
| when: "matrix_mautrix_telegram_container_self_build|bool" | |||||
| when: "matrix_mautrix_telegram_container_image_self_build|bool" | |||||
| - name: Ensure matrix-mautrix-telegram Docker image is built | - name: Ensure matrix-mautrix-telegram Docker image is built | ||||
| docker_image: | docker_image: | ||||
| @@ -93,10 +93,10 @@ | |||||
| build: | build: | ||||
| dockerfile: Dockerfile | dockerfile: Dockerfile | ||||
| path: "{{ matrix_mautrix_telegram_docker_src_files_path }}" | path: "{{ matrix_mautrix_telegram_docker_src_files_path }}" | ||||
| pull: "{{ not matrix_telegram_lottieconverter_container_self_build_mask_arch|bool }}" | |||||
| pull: "{{ not matrix_telegram_lottieconverter_container_image_self_build_mask_arch|bool }}" | |||||
| args: | args: | ||||
| TARGETARCH: "" | TARGETARCH: "" | ||||
| when: "matrix_mautrix_telegram_container_self_build|bool and matrix_mautrix_telegram_git_pull_results.changed" | |||||
| when: "matrix_mautrix_telegram_container_image_self_build|bool and matrix_mautrix_telegram_git_pull_results.changed" | |||||
| - name: Check if an old database file already exists | - name: Check if an old database file already exists | ||||
| stat: | stat: | ||||
| @@ -20,3 +20,6 @@ | |||||
| when: "item.old in vars" | when: "item.old in vars" | ||||
| with_items: | with_items: | ||||
| - {'old': 'matrix_mautrix_telegram_container_exposed_port_number', 'new': '<superseded by matrix_mautrix_telegram_container_http_host_bind_port>'} | - {'old': 'matrix_mautrix_telegram_container_exposed_port_number', 'new': '<superseded by matrix_mautrix_telegram_container_http_host_bind_port>'} | ||||
| - {'old': 'matrix_mautrix_telegram_container_self_build', 'new': 'matrix_mautrix_telegram_container_image_self_build'} | |||||
| - {'old': 'matrix_telegram_lottieconverter_container_self_build', 'new': 'matrix_mautrix_telegram_container_image_self_build'} | |||||
| - {'old': 'matrix_telegram_lottieconverter_container_self_build_mask_arch', 'new': 'matrix_telegram_lottieconverter_container_image_self_build_mask_arch'} | |||||
| @@ -69,13 +69,16 @@ appservice: | |||||
| bridge: | bridge: | ||||
| # Localpart template of MXIDs for Telegram users. | # Localpart template of MXIDs for Telegram users. | ||||
| # {userid} is replaced with the user ID of the Telegram user. | # {userid} is replaced with the user ID of the Telegram user. | ||||
| username_template: "telegram_{userid}" | |||||
| # Default: telegram_{userid} | |||||
| username_template: {{ matrix_mautrix_telegram_username_template|to_json }} | |||||
| # Localpart template of room aliases for Telegram portal rooms. | # Localpart template of room aliases for Telegram portal rooms. | ||||
| # {groupname} is replaced with the name part of the public channel/group invite link ( https://t.me/{} ) | # {groupname} is replaced with the name part of the public channel/group invite link ( https://t.me/{} ) | ||||
| alias_template: "telegram_{groupname}" | |||||
| # Default: telegram_{groupname} | |||||
| alias_template: {{ matrix_mautrix_telegram_alias_template|to_json }} | |||||
| # Displayname template for Telegram users. | # Displayname template for Telegram users. | ||||
| # {displayname} is replaced with the display name of the Telegram user. | # {displayname} is replaced with the display name of the Telegram user. | ||||
| displayname_template: "{displayname} (Telegram)" | |||||
| # Default: {displayname} (Telegram) | |||||
| displayname_template: {{ matrix_mautrix_telegram_displayname_template|to_json }} | |||||
| # Set the preferred order of user identifiers which to use in the Matrix puppet display name. | # Set the preferred order of user identifiers which to use in the Matrix puppet display name. | ||||
| # In the (hopefully unlikely) scenario that none of the given keys are found, the numeric user | # In the (hopefully unlikely) scenario that none of the given keys are found, the numeric user | ||||
| @@ -222,17 +225,6 @@ bridge: | |||||
| # notices from users listed here will be bridged. | # notices from users listed here will be bridged. | ||||
| exceptions: [] | exceptions: [] | ||||
| # Some config options related to Telegram message deduplication. | |||||
| # The default values are usually fine, but some debug messages/warnings might recommend you | |||||
| # change these. | |||||
| deduplication: | |||||
| # Whether or not to check the database if the message about to be sent is a duplicate. | |||||
| pre_db_check: false | |||||
| # The number of latest events to keep when checking for duplicates. | |||||
| # You might need to increase this on high-traffic bridge instances. | |||||
| cache_queue_length: 20 | |||||
| # The formats to use when sending messages to Telegram via the relay bot. | # The formats to use when sending messages to Telegram via the relay bot. | ||||
| # | # | ||||
| # Telegram doesn't have built-in emotes, so the m.emote format is also used for non-relaybot users. | # Telegram doesn't have built-in emotes, so the m.emote format is also used for non-relaybot users. | ||||
| @@ -15,15 +15,6 @@ Type=simple | |||||
| Environment="HOME={{ matrix_systemd_unit_home_path }}" | Environment="HOME={{ matrix_systemd_unit_home_path }}" | ||||
| ExecStartPre=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-mautrix-telegram 2>/dev/null' | ExecStartPre=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-mautrix-telegram 2>/dev/null' | ||||
| ExecStartPre=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-mautrix-telegram 2>/dev/null' | ExecStartPre=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-mautrix-telegram 2>/dev/null' | ||||
| ExecStartPre={{ matrix_host_command_docker }} run --rm --name matrix-mautrix-telegram-db \ | |||||
| --log-driver=none \ | |||||
| --user={{ matrix_user_uid }}:{{ matrix_user_gid }} \ | |||||
| --cap-drop=ALL \ | |||||
| --network={{ matrix_docker_network }} \ | |||||
| -v {{ matrix_mautrix_telegram_config_path }}:/config:z \ | |||||
| -v {{ matrix_mautrix_telegram_data_path }}:/data:z \ | |||||
| {{ matrix_mautrix_telegram_docker_image }} \ | |||||
| alembic -x config=/config/config.yaml upgrade head | |||||
| # Intentional delay, so that the homeserver (we likely depend on) can manage to start. | # Intentional delay, so that the homeserver (we likely depend on) can manage to start. | ||||
| ExecStartPre={{ matrix_host_command_sleep }} 5 | ExecStartPre={{ matrix_host_command_sleep }} 5 | ||||
| @@ -44,8 +35,8 @@ ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-mautrix-telegr | |||||
| {{ matrix_mautrix_telegram_docker_image }} \ | {{ matrix_mautrix_telegram_docker_image }} \ | ||||
| python3 -m mautrix_telegram -c /config/config.yaml --no-update | python3 -m mautrix_telegram -c /config/config.yaml --no-update | ||||
| ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-mautrix-telegram 2>/dev/null' | |||||
| ExecStop=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-mautrix-telegram 2>/dev/null' | |||||
| ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-mautrix-telegram 2>/dev/null' | |||||
| ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-mautrix-telegram 2>/dev/null' | |||||
| Restart=always | Restart=always | ||||
| RestartSec=30 | RestartSec=30 | ||||
| SyslogIdentifier=matrix-mautrix-telegram | SyslogIdentifier=matrix-mautrix-telegram | ||||
| @@ -0,0 +1,103 @@ | |||||
| # mautrix-twitter is a Matrix <-> Twitter bridge | |||||
| # See: https://github.com/mautrix/twitter | |||||
| matrix_mautrix_twitter_enabled: true | |||||
| matrix_mautrix_twitter_container_image_self_build: false | |||||
| matrix_mautrix_twitter_container_image_self_build_repo: "https://github.com/mautrix/twitter.git" | |||||
| matrix_mautrix_twitter_version: v0.1.3 | |||||
| # See: https://mau.dev/tulir/mautrix-twitter/container_registry | |||||
| matrix_mautrix_twitter_docker_image: "{{ matrix_mautrix_twitter_docker_image_name_prefix }}mautrix/twitter:{{ matrix_mautrix_twitter_version }}" | |||||
| matrix_mautrix_twitter_docker_image_name_prefix: "{{ 'localhost/' if matrix_mautrix_twitter_container_image_self_build else 'dock.mau.dev/' }}" | |||||
| matrix_mautrix_twitter_docker_image_force_pull: "{{ matrix_mautrix_twitter_docker_image.endswith(':latest') }}" | |||||
| matrix_mautrix_twitter_base_path: "{{ matrix_base_data_path }}/mautrix-twitter" | |||||
| matrix_mautrix_twitter_config_path: "{{ matrix_mautrix_twitter_base_path }}/config" | |||||
| matrix_mautrix_twitter_data_path: "{{ matrix_mautrix_twitter_base_path }}/data" | |||||
| matrix_mautrix_twitter_docker_src_files_path: "{{ matrix_mautrix_twitter_base_path }}/docker-src" | |||||
| matrix_mautrix_twitter_homeserver_address: "{{ matrix_homeserver_container_url }}" | |||||
| matrix_mautrix_twitter_homeserver_domain: '{{ matrix_domain }}' | |||||
| matrix_mautrix_twitter_appservice_address: 'http://matrix-mautrix-twitter:29327' | |||||
| # A list of extra arguments to pass to the container | |||||
| matrix_mautrix_twitter_container_extra_arguments: [] | |||||
| # List of systemd services that matrix-mautrix-twitter.service depends on. | |||||
| matrix_mautrix_twitter_systemd_required_services_list: ['docker.service'] | |||||
| # List of systemd services that matrix-mautrix-twitter.service wants | |||||
| matrix_mautrix_twitter_systemd_wanted_services_list: [] | |||||
| matrix_mautrix_twitter_appservice_token: '' | |||||
| matrix_mautrix_twitter_homeserver_token: '' | |||||
| # Database-related configuration fields. | |||||
| # | |||||
| # To use Postgres: | |||||
| # - adjust your database credentials via the `matrix_mautrix_twitter_postgres_*` variables | |||||
| matrix_mautrix_twitter_database_engine: 'postgres' | |||||
| matrix_mautrix_twitter_database_username: 'matrix_mautrix_twitter' | |||||
| matrix_mautrix_twitter_database_password: 'some-password' | |||||
| matrix_mautrix_twitter_database_hostname: 'matrix-postgres' | |||||
| matrix_mautrix_twitter_database_port: 5432 | |||||
| matrix_mautrix_twitter_database_name: 'matrix_mautrix_twitter' | |||||
| matrix_mautrix_twitter_database_connection_string: 'postgres://{{ matrix_mautrix_twitter_database_username }}:{{ matrix_mautrix_twitter_database_password }}@{{ matrix_mautrix_twitter_database_hostname }}:{{ matrix_mautrix_twitter_database_port }}/{{ matrix_mautrix_twitter_database_name }}' | |||||
| matrix_mautrix_twitter_appservice_database: "{{ | |||||
| { | |||||
| 'postgres': matrix_mautrix_twitter_database_connection_string, | |||||
| }[matrix_mautrix_twitter_database_engine] | |||||
| }}" | |||||
| # Can be set to enable automatic double-puppeting via Shared Secret Auth (https://github.com/devture/matrix-synapse-shared-secret-auth). | |||||
| matrix_mautrix_twitter_login_shared_secret: '' | |||||
| matrix_mautrix_twitter_bridge_login_shared_secret_map: "{{ {matrix_mautrix_twitter_homeserver_domain: matrix_mautrix_twitter_login_shared_secret} if matrix_mautrix_twitter_login_shared_secret else {} }}" | |||||
| matrix_mautrix_twitter_appservice_bot_username: twitterbot | |||||
| # Default 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_mautrix_twitter_configuration_extension_yaml`) | |||||
| # or completely replace this variable with your own template. | |||||
| matrix_mautrix_twitter_configuration_yaml: "{{ lookup('template', 'templates/config.yaml.j2') }}" | |||||
| matrix_mautrix_twitter_configuration_extension_yaml: | | |||||
| # Your custom YAML configuration goes here. | |||||
| # This configuration extends the default starting configuration (`matrix_mautrix_twitter_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_mautrix_twitter_configuration_yaml`. | |||||
| matrix_mautrix_twitter_configuration_extension: "{{ matrix_mautrix_twitter_configuration_extension_yaml|from_yaml if matrix_mautrix_twitter_configuration_extension_yaml|from_yaml is mapping else {} }}" | |||||
| # Holds the final configuration (a combination of the default and its extension). | |||||
| # You most likely don't need to touch this variable. Instead, see `matrix_mautrix_twitter_configuration_yaml`. | |||||
| matrix_mautrix_twitter_configuration: "{{ matrix_mautrix_twitter_configuration_yaml|from_yaml|combine(matrix_mautrix_twitter_configuration_extension, recursive=True) }}" | |||||
| matrix_mautrix_twitter_registration_yaml: | | |||||
| id: twitter | |||||
| as_token: "{{ matrix_mautrix_twitter_appservice_token }}" | |||||
| hs_token: "{{ matrix_mautrix_twitter_homeserver_token }}" | |||||
| namespaces: | |||||
| users: | |||||
| - exclusive: true | |||||
| regex: '^@twitter_.+:{{ matrix_mautrix_twitter_homeserver_domain|regex_escape }}$' | |||||
| - exclusive: true | |||||
| regex: '^@{{ matrix_mautrix_twitter_appservice_bot_username|regex_escape }}:{{ matrix_mautrix_twitter_homeserver_domain|regex_escape }}$' | |||||
| url: {{ matrix_mautrix_twitter_appservice_address }} | |||||
| # See https://github.com/tulir/mautrix-signal/issues/43 | |||||
| sender_localpart: _bot_{{ matrix_mautrix_twitter_appservice_bot_username }} | |||||
| rate_limited: false | |||||
| de.sorunome.msc2409.push_ephemeral: true | |||||
| matrix_mautrix_twitter_registration: "{{ matrix_mautrix_twitter_registration_yaml|from_yaml }}" | |||||
| @@ -0,0 +1,23 @@ | |||||
| - set_fact: | |||||
| matrix_systemd_services_list: "{{ matrix_systemd_services_list + ['matrix-mautrix-twitter.service'] }}" | |||||
| when: matrix_mautrix_twitter_enabled|bool | |||||
| # If the matrix-synapse role is not used, these variables may not exist. | |||||
| - set_fact: | |||||
| matrix_synapse_container_extra_arguments: > | |||||
| {{ matrix_synapse_container_extra_arguments|default([]) }} | |||||
| + | |||||
| ["--mount type=bind,src={{ matrix_mautrix_twitter_config_path }}/registration.yaml,dst=/matrix-mautrix-twitter-registration.yaml,ro"] | |||||
| matrix_synapse_app_service_config_files: > | |||||
| {{ matrix_synapse_app_service_config_files|default([]) }} | |||||
| + | |||||
| {{ ["/matrix-mautrix-twitter-registration.yaml"] }} | |||||
| when: matrix_mautrix_twitter_enabled|bool | |||||
| # ansible lower than 2.8, does not support docker_image build parameters | |||||
| # for self buildig it is explicitly needed, so we rather fail here | |||||
| - name: Fail if running on Ansible lower than 2.8 and trying self building | |||||
| fail: | |||||
| msg: "To self build Mautrix Twitter image, you should usa ansible 2.8 or higher. E.g. pip contains such packages." | |||||
| when: "ansible_version.major == 2 and ansible_version.minor < 8 and matrix_mautrix_twitter_container_image_self_build" | |||||
| @@ -0,0 +1,21 @@ | |||||
| - import_tasks: "{{ role_path }}/tasks/init.yml" | |||||
| tags: | |||||
| - always | |||||
| - import_tasks: "{{ role_path }}/tasks/validate_config.yml" | |||||
| when: "run_setup|bool and matrix_mautrix_twitter_enabled|bool" | |||||
| tags: | |||||
| - setup-all | |||||
| - setup-mautrix-twitter | |||||
| - import_tasks: "{{ role_path }}/tasks/setup_install.yml" | |||||
| when: "run_setup|bool and matrix_mautrix_twitter_enabled|bool" | |||||
| tags: | |||||
| - setup-all | |||||
| - setup-mautrix-twitter | |||||
| - import_tasks: "{{ role_path }}/tasks/setup_uninstall.yml" | |||||
| when: "run_setup|bool and not matrix_mautrix_twitter_enabled|bool" | |||||
| tags: | |||||
| - setup-all | |||||
| - setup-mautrix-twitter | |||||
| @@ -0,0 +1,88 @@ | |||||
| --- | |||||
| # If the matrix-synapse role is not used, `matrix_synapse_role_executed` won't exist. | |||||
| # We don't want to fail in such cases. | |||||
| - name: Fail if matrix-synapse role already executed | |||||
| fail: | |||||
| msg: >- | |||||
| The matrix-bridge-mautrix-twitter role needs to execute before the matrix-synapse role. | |||||
| when: "matrix_synapse_role_executed|default(False)" | |||||
| - set_fact: | |||||
| matrix_mautrix_twitter_requires_restart: false | |||||
| - name: Ensure Mautrix Twitter image is pulled | |||||
| docker_image: | |||||
| name: "{{ matrix_mautrix_twitter_docker_image }}" | |||||
| source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}" | |||||
| force_source: "{{ matrix_mautrix_twitter_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_mautrix_twitter_docker_image_force_pull }}" | |||||
| when: matrix_mautrix_twitter_enabled|bool and not matrix_mautrix_twitter_container_image_self_build | |||||
| - name: Ensure Mautrix Twitter paths exist | |||||
| file: | |||||
| path: "{{ item.path }}" | |||||
| state: directory | |||||
| mode: 0750 | |||||
| owner: "{{ matrix_user_username }}" | |||||
| group: "{{ matrix_user_groupname }}" | |||||
| with_items: | |||||
| - { path: "{{ matrix_mautrix_twitter_base_path }}", when: true } | |||||
| - { path: "{{ matrix_mautrix_twitter_config_path }}", when: true } | |||||
| - { path: "{{ matrix_mautrix_twitter_data_path }}", when: true } | |||||
| - { path: "{{ matrix_mautrix_twitter_docker_src_files_path }}", when: "{{ matrix_mautrix_twitter_container_image_self_build }}" } | |||||
| when: item.when|bool | |||||
| - name: Ensure Mautrix Twitter repository is present on self-build | |||||
| git: | |||||
| repo: "{{ matrix_mautrix_twitter_container_image_self_build_repo }}" | |||||
| dest: "{{ matrix_mautrix_twitter_docker_src_files_path }}" | |||||
| # version: "{{ matrix_coturn_docker_image.split(':')[1] }}" | |||||
| force: "yes" | |||||
| register: matrix_mautrix_twitter_git_pull_results | |||||
| when: "matrix_mautrix_twitter_enabled|bool and matrix_mautrix_twitter_container_image_self_build" | |||||
| - name: Ensure Mautrix Twitter Docker image is built | |||||
| docker_image: | |||||
| name: "{{ matrix_mautrix_twitter_docker_image }}" | |||||
| source: build | |||||
| force_source: "{{ matrix_mautrix_twitter_git_pull_results.changed }}" | |||||
| build: | |||||
| dockerfile: Dockerfile | |||||
| path: "{{ matrix_mautrix_twitter_docker_src_files_path }}" | |||||
| pull: yes | |||||
| when: "matrix_mautrix_twitter_enabled|bool and matrix_mautrix_twitter_container_image_self_build|bool" | |||||
| - name: Ensure mautrix-twitter config.yaml installed | |||||
| copy: | |||||
| content: "{{ matrix_mautrix_twitter_configuration|to_nice_yaml }}" | |||||
| dest: "{{ matrix_mautrix_twitter_config_path }}/config.yaml" | |||||
| mode: 0644 | |||||
| owner: "{{ matrix_user_username }}" | |||||
| group: "{{ matrix_user_groupname }}" | |||||
| - name: Ensure mautrix-twitter registration.yaml installed | |||||
| copy: | |||||
| content: "{{ matrix_mautrix_twitter_registration|to_nice_yaml }}" | |||||
| dest: "{{ matrix_mautrix_twitter_config_path }}/registration.yaml" | |||||
| mode: 0644 | |||||
| owner: "{{ matrix_user_username }}" | |||||
| group: "{{ matrix_user_groupname }}" | |||||
| - name: Ensure matrix-mautrix-twitter.service installed | |||||
| template: | |||||
| src: "{{ role_path }}/templates/systemd/matrix-mautrix-twitter.service.j2" | |||||
| dest: "{{ matrix_systemd_path }}/matrix-mautrix-twitter.service" | |||||
| mode: 0644 | |||||
| register: matrix_mautrix_twitter_systemd_service_result | |||||
| - name: Ensure systemd reloaded after matrix-mautrix-twitter.service installation | |||||
| service: | |||||
| daemon_reload: yes | |||||
| when: "matrix_mautrix_twitter_systemd_service_result.changed" | |||||
| - name: Ensure matrix-mautrix-twitter.service restarted, if necessary | |||||
| service: | |||||
| name: "matrix-mautrix-twitter.service" | |||||
| state: restarted | |||||
| when: "matrix_mautrix_twitter_requires_restart|bool" | |||||
| @@ -0,0 +1,24 @@ | |||||
| --- | |||||
| - name: Check existence of matrix-mautrix-twitter service | |||||
| stat: | |||||
| path: "{{ matrix_systemd_path }}/matrix-mautrix-twitter.service" | |||||
| register: matrix_mautrix_twitter_service_stat | |||||
| - name: Ensure matrix-mautrix-twitter is stopped | |||||
| service: | |||||
| name: matrix-mautrix-twitter | |||||
| state: stopped | |||||
| daemon_reload: yes | |||||
| when: "matrix_mautrix_twitter_service_stat.stat.exists" | |||||
| - name: Ensure matrix-mautrix-twitter.service doesn't exist | |||||
| file: | |||||
| path: "{{ matrix_systemd_path }}/matrix-mautrix-twitter.service" | |||||
| state: absent | |||||
| when: "matrix_mautrix_twitter_service_stat.stat.exists" | |||||
| - name: Ensure systemd reloaded after matrix-mautrix-twitter.service removal | |||||
| service: | |||||
| daemon_reload: yes | |||||
| when: "matrix_mautrix_twitter_service_stat.stat.exists" | |||||
| @@ -0,0 +1,18 @@ | |||||
| --- | |||||
| - name: Fail if required settings not defined | |||||
| fail: | |||||
| msg: >- | |||||
| You need to define a required configuration setting (`{{ item }}`). | |||||
| when: "vars[item] == ''" | |||||
| with_items: | |||||
| - "matrix_mautrix_twitter_appservice_token" | |||||
| - "matrix_mautrix_twitter_homeserver_token" | |||||
| - name: Fail if database is not defined | |||||
| fail: | |||||
| msg: >- | |||||
| You need to define a need to set `matrix_mautrix_twitter_database_engine: postgres` and redefine the other `matrix_mautrix_twitter_database_*` variables | |||||
| when: "vars[item] == ''" | |||||
| with_items: | |||||
| - "matrix_mautrix_twitter_database_engine" | |||||
| @@ -0,0 +1,209 @@ | |||||
| #jinja2: lstrip_blocks: "True" | |||||
| # Homeserver details | |||||
| homeserver: | |||||
| # The address that this appservice can use to connect to the homeserver. | |||||
| address: {{ matrix_mautrix_twitter_homeserver_address }} | |||||
| # The domain of the homeserver (for MXIDs, etc). | |||||
| domain: {{ matrix_mautrix_twitter_homeserver_domain }} | |||||
| # Whether or not to verify the SSL certificate of the homeserver. | |||||
| # Only applies if address starts with https:// | |||||
| verify_ssl: true | |||||
| asmux: false | |||||
| # Application service host/registration related details | |||||
| # Changing these values requires regeneration of the registration. | |||||
| appservice: | |||||
| # The address that the homeserver can use to connect to this appservice. | |||||
| address: {{ matrix_mautrix_twitter_appservice_address }} | |||||
| # When using https:// the TLS certificate and key files for the address. | |||||
| tls_cert: false | |||||
| tls_key: false | |||||
| # The hostname and port where this appservice should listen. | |||||
| hostname: 0.0.0.0 | |||||
| port: 29327 | |||||
| # The maximum body size of appservice API requests (from the homeserver) in mebibytes | |||||
| # Usually 1 is enough, but on high-traffic bridges you might need to increase this to avoid 413s | |||||
| max_body_size: 1 | |||||
| # The full URI to the database. Only Postgres is currently supported. | |||||
| database: {{ matrix_mautrix_twitter_appservice_database|to_json }} | |||||
| # Additional arguments for asyncpg.create_pool() | |||||
| # https://magicstack.github.io/asyncpg/current/api/index.html#asyncpg.pool.create_pool | |||||
| database_opts: | |||||
| min_size: 5 | |||||
| max_size: 10 | |||||
| # Provisioning API part of the web server for automated portal creation and fetching information. | |||||
| # Used by things like mautrix-manager (https://github.com/tulir/mautrix-manager). | |||||
| provisioning: | |||||
| # Whether or not the provisioning API should be enabled. | |||||
| enabled: true | |||||
| # The prefix to use in the provisioning API endpoints. | |||||
| prefix: /_matrix/provision/v1 | |||||
| # The shared secret to authorize users of the API. | |||||
| # Set to "generate" to generate and save a new token. | |||||
| shared_secret: generate | |||||
| # The unique ID of this appservice. | |||||
| id: twitter | |||||
| # Username of the appservice bot. | |||||
| bot_username: {{ matrix_mautrix_twitter_appservice_bot_username|to_json }} | |||||
| # Display name and avatar for bot. Set to "remove" to remove display name/avatar, leave empty | |||||
| # to leave display name/avatar as-is. | |||||
| bot_displayname: Twitter bridge bot | |||||
| bot_avatar: mxc://maunium.net/HVHcnusJkQcpVcsVGZRELLCn | |||||
| # Community ID for bridged users (changes registration file) and rooms. | |||||
| # Must be created manually. | |||||
| # | |||||
| # Example: "+twitter:example.com". Set to false to disable. | |||||
| community_id: false | |||||
| # Whether or not to receive ephemeral events via appservice transactions. | |||||
| # Requires MSC2409 support (i.e. Synapse 1.22+). | |||||
| # You should disable bridge -> sync_with_custom_puppets when this is enabled. | |||||
| ephemeral_events: false | |||||
| # Authentication tokens for AS <-> HS communication. Autogenerated; do not modify. | |||||
| as_token: "{{ matrix_mautrix_twitter_appservice_token }}" | |||||
| hs_token: "{{ matrix_mautrix_twitter_homeserver_token }}" | |||||
| # Prometheus telemetry config. Requires prometheus-client to be installed. | |||||
| metrics: | |||||
| enabled: false | |||||
| listen_port: 8000 | |||||
| # Bridge config | |||||
| bridge: | |||||
| # Localpart template of MXIDs for Twitter users. | |||||
| # {userid} is replaced with the user ID of the Twitter user. | |||||
| username_template: "twitter_{userid}" | |||||
| # Displayname template for Twitter users. | |||||
| # {displayname} is replaced with the display name of the Twitter user. | |||||
| # {username} is replaced with the username of the Twitter user. | |||||
| displayname_template: "{displayname} (Twitter)" | |||||
| # Maximum length of displayname | |||||
| displayname_max_length: 100 | |||||
| # Number of conversations to sync (and create portals for) on login. | |||||
| # Set 0 to disable automatic syncing. | |||||
| initial_conversation_sync: 10 | |||||
| # Whether or not to use /sync to get read receipts and typing notifications | |||||
| # when double puppeting is enabled | |||||
| sync_with_custom_puppets: true | |||||
| # Whether or not to update the m.direct account data event when double puppeting is enabled. | |||||
| # Note that updating the m.direct event is not atomic (except with mautrix-asmux) | |||||
| # and is therefore prone to race conditions. | |||||
| sync_direct_chat_list: false | |||||
| # Allow using double puppeting from any server with a valid client .well-known file. | |||||
| double_puppet_allow_discovery: false | |||||
| # Servers to allow double puppeting from, even if double_puppet_allow_discovery is false. | |||||
| double_puppet_server_map: {} | |||||
| # Shared secret for https://github.com/devture/matrix-synapse-shared-secret-auth | |||||
| # | |||||
| # If set, custom puppets will be enabled automatically for local users | |||||
| # instead of users having to find an access token and run `login-matrix` | |||||
| # manually. | |||||
| # If using this for other servers than the bridge's server, | |||||
| # you must also set the URL in the double_puppet_server_map. | |||||
| login_shared_secret_map: {{ matrix_mautrix_twitter_bridge_login_shared_secret_map|to_json }} | |||||
| # Whether or not created rooms should have federation enabled. | |||||
| # If false, created portal rooms will never be federated. | |||||
| federate_rooms: true | |||||
| # Settings for backfilling messages from Twitter. | |||||
| # | |||||
| # Missed message backfilling is currently based on receiving them from the Twitter polling API, | |||||
| # rather than manually asking for messages in each conversation. Due to this, there's no way to | |||||
| # set a limit for missed message backfilling. | |||||
| backfill: | |||||
| # Whether or not the Twitter users of logged in Matrix users should be | |||||
| # invited to private chats when backfilling history from Twitter. This is | |||||
| # usually needed to prevent rate limits and to allow timestamp massaging. | |||||
| invite_own_puppet: true | |||||
| # Maximum number of messages to backfill initially. | |||||
| # Set to 0 to disable backfilling when creating portal. | |||||
| initial_limit: 0 | |||||
| # If using double puppeting, should notifications be disabled | |||||
| # while the initial backfill is in progress? | |||||
| disable_notifications: true | |||||
| # End-to-bridge encryption support options. You must install the e2be optional dependency for | |||||
| # this to work. See https://github.com/tulir/mautrix-telegram/wiki/End‐to‐bridge-encryption | |||||
| encryption: | |||||
| # Allow encryption, work in group chat rooms with e2ee enabled | |||||
| allow: false | |||||
| # Default to encryption, force-enable encryption in all portals the bridge creates | |||||
| # This will cause the bridge bot to be in private chats for the encryption to work properly. | |||||
| default: false | |||||
| # Options for automatic key sharing. | |||||
| key_sharing: | |||||
| # Enable key sharing? If enabled, key requests for rooms where users are in will be fulfilled. | |||||
| # You must use a client that supports requesting keys from other users to use this feature. | |||||
| allow: false | |||||
| # Require the requesting device to have a valid cross-signing signature? | |||||
| # This doesn't require that the bridge has verified the device, only that the user has verified it. | |||||
| # Not yet implemented. | |||||
| require_cross_signing: false | |||||
| # Require devices to be verified by the bridge? | |||||
| # Verification by the bridge is not yet implemented. | |||||
| require_verification: true | |||||
| # Whether or not to explicitly set the avatar and room name for private | |||||
| # chat portal rooms. This will be implicitly enabled if encryption.default is true. | |||||
| private_chat_portal_meta: false | |||||
| # Whether or not the bridge should send a read receipt from the bridge bot when a message has | |||||
| # been sent to Twitter. | |||||
| delivery_receipts: false | |||||
| # Whether or not delivery errors should be reported as messages in the Matrix room. | |||||
| delivery_error_reports: false | |||||
| # Whether or not non-fatal polling errors should send notices to the notice room. | |||||
| temporary_disconnect_notices: true | |||||
| # Number of seconds to sleep more than the previous error when a polling error occurs. | |||||
| # Growth is capped at 15 minutes. | |||||
| error_sleep: 5 | |||||
| # Maximum number of polling errors before giving up. Set to -1 to retry forever. | |||||
| max_poll_errors: 12 | |||||
| # Set this to true to tell the bridge to re-send m.bridge events to all rooms on the next run. | |||||
| # This field will automatically be changed back to false after it, | |||||
| # except if the config file is not writable. | |||||
| resend_bridge_info: false | |||||
| # The prefix for commands. Only required in non-management rooms. | |||||
| command_prefix: "!tw" | |||||
| # Permissions for using the bridge. | |||||
| # Permitted values: | |||||
| # user - Use the bridge with puppeting. | |||||
| # admin - Use and administrate the bridge. | |||||
| # Permitted keys: | |||||
| # * - All Matrix users | |||||
| # domain - All users on that homeserver | |||||
| # mxid - Specific user | |||||
| permissions: | |||||
| '{{ matrix_mautrix_twitter_homeserver_domain }}': user | |||||
| # Python logging configuration. | |||||
| # | |||||
| # See section 16.7.2 of the Python documentation for more info: | |||||
| # https://docs.python.org/3.6/library/logging.config.html#configuration-dictionary-schema | |||||
| logging: | |||||
| version: 1 | |||||
| formatters: | |||||
| colored: | |||||
| (): mautrix_twitter.util.ColorFormatter | |||||
| format: "[%(asctime)s] [%(levelname)s@%(name)s] %(message)s" | |||||
| normal: | |||||
| format: "[%(asctime)s] [%(levelname)s@%(name)s] %(message)s" | |||||
| handlers: | |||||
| console: | |||||
| class: logging.StreamHandler | |||||
| formatter: colored | |||||
| loggers: | |||||
| mau: | |||||
| level: DEBUG | |||||
| aiohttp: | |||||
| level: INFO | |||||
| root: | |||||
| level: DEBUG | |||||
| handlers: [console] | |||||
| @@ -0,0 +1,42 @@ | |||||
| #jinja2: lstrip_blocks: "True" | |||||
| [Unit] | |||||
| Description=Matrix Mautrix Twitter bridge | |||||
| {% for service in matrix_mautrix_twitter_systemd_required_services_list %} | |||||
| Requires={{ service }} | |||||
| After={{ service }} | |||||
| {% endfor %} | |||||
| {% for service in matrix_mautrix_twitter_systemd_wanted_services_list %} | |||||
| Wants={{ 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-mautrix-twitter 2>/dev/null' | |||||
| ExecStartPre=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-mautrix-twitter 2>/dev/null' | |||||
| # Intentional delay, so that the homeserver (we likely depend on) can manage to start. | |||||
| ExecStartPre={{ matrix_host_command_sleep }} 5 | |||||
| ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-mautrix-twitter \ | |||||
| --log-driver=none \ | |||||
| --user={{ matrix_user_uid }}:{{ matrix_user_gid }} \ | |||||
| --cap-drop=ALL \ | |||||
| --network={{ matrix_docker_network }} \ | |||||
| -v {{ matrix_mautrix_twitter_config_path }}:/config:z \ | |||||
| -v {{ matrix_mautrix_twitter_data_path }}:/data:z \ | |||||
| {% for arg in matrix_mautrix_twitter_container_extra_arguments %} | |||||
| {{ arg }} \ | |||||
| {% endfor %} | |||||
| {{ matrix_mautrix_twitter_docker_image }} \ | |||||
| python3 -m mautrix_twitter -c /config/config.yaml --no-update | |||||
| ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} kill matrix-mautrix-twitter 2>/dev/null' | |||||
| ExecStopPost=-{{ matrix_host_command_sh }} -c '{{ matrix_host_command_docker }} rm matrix-mautrix-twitter 2>/dev/null' | |||||
| Restart=always | |||||
| RestartSec=30 | |||||
| SyslogIdentifier=matrix-mautrix-twitter | |||||
| [Install] | |||||
| WantedBy=multi-user.target | |||||