finallycoffee/matrix-docker-ansible-deploy
finallycoffee/matrix-docker-ansible-deploy
5
1
Fork 0
Code Issues Pull Requests Releases Wiki Activity
55f869254b
matrix-docker-ansible-deploy/docs/configuring-playbook.md

229 lines
12 KiB
Markdown
Raw Normal View History

Minor wording improvements
2018-08-15 07:19:31 +00:00
# Configuring the Ansible playbook
Split README into a bunch of files in docs/
2018-08-08 07:07:02 +00:00
Improve documentation about getting the playbook
2019-03-10 15:02:17 +00:00
To configure the playbook, you need to have done the following things:
Split README into a bunch of files in docs/
2018-08-08 07:07:02 +00:00
Improve documentation about getting the playbook
2019-03-10 15:02:17 +00:00
- have a server where Matrix services will run
- [configured your DNS records](configuring-dns.md)
- [retrieved the playbook's source code](getting-the-playbook.md) to your computer
You can then follow these steps inside the playbook directory:
Split README into a bunch of files in docs/
2018-08-08 07:07:02 +00:00
Update configuring-playbook.md `mkdir` with multiple subdirs needs `-p`
2024-02-04 17:31:32 +00:00
1. create a directory to hold your configuration (`mkdir -p inventory/host_vars/matrix.<your-domain>`)
Split README into a bunch of files in docs/
2018-08-08 07:07:02 +00:00
Make steps in configuring-playbook.md numbered instead of bullet points which make it more difficult to tell whether or not you completed all of the steps
2021-03-06 18:35:12 +00:00
1. copy the sample configuration file (`cp examples/vars.yml inventory/host_vars/matrix.<your-domain>/vars.yml`)
Split README into a bunch of files in docs/
2018-08-08 07:07:02 +00:00
Update configuring-playbook.md
2023-04-27 05:12:09 +00:00
1. edit the configuration file (`inventory/host_vars/matrix.<your-domain>/vars.yml`) to your liking. You may also take a look at the various `roles/*/ROLE_NAME_HERE/defaults/main.yml` files and see if there's something you'd like to copy over and override in your `vars.yml` configuration file.
Split README into a bunch of files in docs/
2018-08-08 07:07:02 +00:00
Make steps in configuring-playbook.md numbered instead of bullet points which make it more difficult to tell whether or not you completed all of the steps
2021-03-06 18:35:12 +00:00
1. copy the sample inventory hosts file (`cp examples/hosts inventory/hosts`)
Split README into a bunch of files in docs/
2018-08-08 07:07:02 +00:00
Make steps in configuring-playbook.md numbered instead of bullet points which make it more difficult to tell whether or not you completed all of the steps
2021-03-06 18:35:12 +00:00
1. edit the inventory hosts file (`inventory/hosts`) to your liking
Split README into a bunch of files in docs/
2018-08-08 07:07:02 +00:00
Remove inventory/ directory tree to allow people to manage it as a git repository (etc.) Related to https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/3086
2024-01-09 17:08:43 +00:00
2. (optional, advanced) you may wish to keep your `inventory` directory under version control with [git](https://git-scm.com/) or any other version-control system.
3. (optional, advanced) to run Ansible against multiple servers with different `sudo` credentials, you can copy the sample inventory hosts yaml file for each of your hosts: (`cp examples/host.yml inventory/my_host1.yml` …) and use the [`ansible-all-hosts.sh`](../bin/ansible-all-hosts.sh) script [in the installation step](installing.md).
Split README into a bunch of files in docs/
2018-08-08 07:07:02 +00:00
For a basic Matrix installation, that's all you need.
For a more custom setup, see the [Other configuration options](#other-configuration-options) below.
When you're done with all the configuration you'd like to do, continue with [Installing](installing.md).
## Other configuration options
Split additional configuration options in groups It's too many configuration options to keep them in a single list. Trying to put some order.
2019-04-19 06:54:18 +00:00
### Additional useful services
Add documentation about Telemetry configuration
2018-11-01 16:21:38 +00:00
Add notes about Dimension being unmaintained Related to https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/2806
2023-08-16 06:17:32 +00:00
- [Setting up the Dimension Integration Manager](configuring-playbook-dimension.md) (optional; [unmaintained](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/2806#issuecomment-1673559299); after [installing](installing.md))
Add support for controlling Matrix federation
2018-10-25 15:02:04 +00:00
Add Jitsi reference to Configuring Playbook docs page
2020-03-24 16:26:52 +00:00
- [Setting up the Jitsi video-conferencing platform](configuring-playbook-jitsi.md) (optional)
docs/configuring-playbook: Add link to etherpad configuration
2022-10-15 20:17:58 +00:00
- [Setting up Etherpad](configuring-playbook-etherpad.md) (optional)
Improve "things to do after installation" docs section
2021-01-26 15:19:28 +00:00
- [Setting up Dynamic DNS](configuring-playbook-dynamic-dns.md) (optional)
Split additional configuration options in groups It's too many configuration options to keep them in a single list. Trying to put some order.
2019-04-19 06:54:18 +00:00
Announce Prometheus/Grafana
2021-02-12 12:02:53 +00:00
- [Enabling metrics and graphs (Prometheus, Grafana) for your Matrix server](configuring-playbook-prometheus-grafana.md) (optional)
Split additional configuration options in groups It's too many configuration options to keep them in a single list. Trying to put some order.
2019-04-19 06:54:18 +00:00
### Core service adjustments
Add email-sending support
2018-08-14 11:11:41 +00:00
Document Conduit installation Fixes https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/2076
2022-10-27 06:48:49 +00:00
- Homeserver configuration:
- [Configuring Synapse](configuring-playbook-synapse.md), if you're going with the default/recommended homeserver implementation (optional)
- [Configuring Conduit](configuring-playbook-conduit.md), if you've switched to the [Conduit](https://conduit.rs) homeserver implementation (optional)
Make Synapse configuration extensible
2019-08-22 06:49:22 +00:00
add auto join option to dendrite config (#2255) * add auto join option to dendrite config * added auto_join_rooms: variable * added "configuring dendrite" entry * created dendite configuration documentation * fixed config path * Update docs/configuring-playbook-dendrite.md Co-authored-by: Slavi Pantaleev <slavi@devture.com> * Update docs/configuring-playbook-dendrite.md Co-authored-by: Slavi Pantaleev <slavi@devture.com> * Update docs/configuring-playbook-dendrite.md Co-authored-by: Slavi Pantaleev <slavi@devture.com> * Update docs/configuring-playbook-dendrite.md Co-authored-by: Slavi Pantaleev <slavi@devture.com> * Update docs/configuring-playbook-dendrite.md Co-authored-by: Slavi Pantaleev <slavi@devture.com> * Update roles/custom/matrix-dendrite/defaults/main.yml Co-authored-by: Slavi Pantaleev <slavi@devture.com> * correction Co-authored-by: Slavi Pantaleev <slavi@devture.com>
2022-11-20 08:11:21 +00:00
- [Configuring Dendrite](configuring-playbook-dendrite.md), if you've switched to the [Dendrite](https://matrix-org.github.io/dendrite) homeserver implementation (optional)
Riot is now Element Fixes #586 (Github Issue)
2020-07-17 08:31:20 +00:00
- [Configuring Element](configuring-playbook-client-element.md) (optional)
Make Riot-web configuration extensible Fixes #71 (Github Issue).
2019-08-25 07:37:05 +00:00
Announce matrix-media-repo Related to https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/2783
2023-07-17 19:37:53 +00:00
- [Storing Matrix media files using matrix-media-repo](configuring-playbook-matrix-media-repo.md) (optional)
Improve wording a bit
2018-08-08 07:10:16 +00:00
- [Storing Matrix media files on Amazon S3](configuring-playbook-s3.md) (optional)
Split README into a bunch of files in docs/
2018-08-08 07:07:02 +00:00
- [Using an external PostgreSQL server](configuring-playbook-external-postgres.md) (optional)
Add support for 2 more SSL certificate retrieval methods Adds support for managing certificates manually and for having the playbook generate self-signed certificates for you. With this, Let's Encrypt usage is no longer required. Fixes Github issue #50.
2018-12-23 09:00:12 +00:00
- [Adjusting SSL certificate retrieval](configuring-playbook-ssl-certificates.md) (optional, advanced)
Add support for serving base domain via matrix-nginx-proxy
2019-03-12 20:27:18 +00:00
- [Serving your base domain using this playbook's nginx server](configuring-playbook-base-domain-serving.md) (optional)
Switch default reverse-proxy to Traefik, force reverse-proxy choice on existing users
2023-02-26 14:14:05 +00:00
- [Configure the Traefik reverse-proxy](configuring-playbook-traefik.md) (optional, advanced)
add ngnix-status to config add doc
2019-04-17 11:42:09 +00:00
Switch default reverse-proxy to Traefik, force reverse-proxy choice on existing users
2023-02-26 14:14:05 +00:00
- [Using your own webserver, instead of this playbook's default reverse-proxy](configuring-playbook-own-webserver.md) (optional, advanced)
Add matrix-synapse-rest-auth support
2018-08-17 06:02:12 +00:00
Add TURN server configuration documentation
2019-04-19 06:57:41 +00:00
- [Adjusting TURN server configuration](configuring-playbook-turn.md) (optional, advanced)
Split additional configuration options in groups It's too many configuration options to keep them in a single list. Trying to put some order.
2019-04-19 06:54:18 +00:00
### Server connectivity
- [Enabling Telemetry for your Matrix server](configuring-playbook-telemetry.md) (optional)
- [Controlling Matrix federation](configuring-playbook-federation.md) (optional)
- [Adjusting email-sending settings](configuring-playbook-email.md) (optional)
Announce Hydrogen support Related to https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/1055
2021-05-21 10:50:45 +00:00
- [Setting up Hydrogen](configuring-playbook-client-hydrogen.md) - a new lightweight matrix client with legacy and mobile browser support (optional)
Do not install the ma1sd identity server by default As mentioned in the changelog, this is a breaking change.
2022-03-17 15:58:59 +00:00
added matrix-client-cinny
2022-01-05 16:33:21 +00:00
- [Setting up Cinny](configuring-playbook-client-cinny.md) - a web client focusing primarily on simple, elegant and secure interface (optional)
Announce Hydrogen support Related to https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/1055
2021-05-21 10:50:45 +00:00
Announce SchildiChat Related to: https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/2851
2023-08-31 10:42:34 +00:00
- [Setting up SchildiChat](configuring-playbook-client-schildichat.md) - a web client based on [Element](https://element.io/) with some extras and tweaks (optional)
Split additional configuration options in groups It's too many configuration options to keep them in a single list. Trying to put some order.
2019-04-19 06:54:18 +00:00
### Authentication and user-related
Do not install the ma1sd identity server by default As mentioned in the changelog, this is a breaking change.
2022-03-17 15:58:59 +00:00
- [Setting up an ma1sd Identity Server](configuring-playbook-ma1sd.md) (optional)
Add synapse-admin support Fixes #562 (Github Issue)
2020-07-22 05:10:26 +00:00
- [Setting up Synapse Admin](configuring-playbook-synapse-admin.md) (optional)
Add matrix-registration support
2020-09-01 10:46:05 +00:00
- [Setting up matrix-registration](configuring-playbook-matrix-registration.md) (optional)
Annotate certain features as optional/advanced We've had some people get confused into installing Matrix Corporal and having pain with that. With this documentation change, we try to make it clearer that it's an advanced feature not to be touched unless you know what you're doing. On a similar note, we also make sure other things are properly labeled as "(optional)" and/or "(advanced)".
2018-11-26 05:23:42 +00:00
- [Setting up the REST authentication password provider module](configuring-playbook-rest-auth.md) (optional, advanced)
Add support for matrix-synapse-shared-secret-auth
2018-08-20 14:11:55 +00:00
Annotate certain features as optional/advanced We've had some people get confused into installing Matrix Corporal and having pain with that. With this documentation change, we try to make it clearer that it's an advanced feature not to be touched unless you know what you're doing. On a similar note, we also make sure other things are properly labeled as "(optional)" and/or "(advanced)".
2018-11-26 05:23:42 +00:00
- [Setting up the Shared Secret Auth password provider module](configuring-playbook-shared-secret-auth.md) (optional, advanced)
Add support for matrix-corporal
2018-08-21 10:34:34 +00:00
Add LDAP auth password provider documentation and changelog description
2018-11-28 09:21:03 +00:00
- [Setting up the LDAP password provider module](configuring-playbook-ldap-auth.md) (optional, advanced)
Add documentation to readme/list of services Signed-off-by: Julian-Samuel Gebühr <julian-samuel@gebuehr.net>
2022-09-16 17:15:33 +00:00
- [Setting up the ldap-registration-proxy](configuring-playbook-matrix-ldap-registration-proxy.md) (optional, advanced)
Add support for Synapse Simple Antispam Fixes #255 (Github Issue).
2019-09-09 05:13:06 +00:00
- [Setting up Synapse Simple Antispam](configuring-playbook-synapse-simple-antispam.md) (optional, advanced)
Annotate certain features as optional/advanced We've had some people get confused into installing Matrix Corporal and having pain with that. With this documentation change, we try to make it clearer that it's an advanced feature not to be touched unless you know what you're doing. On a similar note, we also make sure other things are properly labeled as "(optional)" and/or "(advanced)".
2018-11-26 05:23:42 +00:00
- [Setting up Matrix Corporal](configuring-playbook-matrix-corporal.md) (optional, advanced)
Update README
2018-09-07 20:35:04 +00:00
Add Pantalaimon support This is actually authored by Julian Foad here (https://lab.trax.im/matrix/matrix-docker-ansible-deploy), but was in need of a rebase and various adjustments caused by huge playbook refactoring that landed in the past months. This rework is completely untested. Fixes https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/266
2024-03-24 16:25:19 +00:00
- [Setting up Matrix User Verification Service](configuring-playbook-user-verification-service.md) (optional, advanced)
- [Setting up Pantalaimon (E2EE aware proxy daemon)](configuring-playbook-pantalaimon.md) (optional, advanced)
Announce Matrix Authentication Support for Jitsi Related to https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/2375
2023-02-10 12:26:38 +00:00
Split additional configuration options in groups It's too many configuration options to keep them in a single list. Trying to put some order.
2019-04-19 06:54:18 +00:00
### Bridging other networks
Add Mautrix Discord Bridge
2022-07-22 14:55:44 +00:00
- [Setting up Mautrix Discord bridging](configuring-playbook-bridge-mautrix-discord.md) (optional)
Update documentation
2018-10-26 16:44:58 +00:00
- [Setting up Mautrix Telegram bridging](configuring-playbook-bridge-mautrix-telegram.md) (optional)
Announce maurtix-slack Related to https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/2227
2023-01-11 08:38:54 +00:00
- [Setting up Mautrix Slack bridging](configuring-playbook-bridge-mautrix-slack.md) (optional)
Added Google Messager Bridge (#2794) * intial commit * changed * Reorderd * merge old changes * added changes to matrix_servers * Remove duplicate discord * Update main.yml * added google message to configuring-playbook.md * Changed docs to add new changes * Changed bug? * Removed problem j2 values * Rename a service files * change how password hash string * Changed port number * Change how the local part works * Revert "Merge pull request #8 from shreyasajj/wsproxy" This reverts commit bb1b8fc67ca39f63ca77e70077be99cb2b32c4de, reversing changes made to cce6ba5f9d74f89172488afc8b1ef124031de8c1. --------- Co-authored-by: Shreyas Ajjarapu <github.tzarina@aleeas.com>
2023-07-21 11:33:52 +00:00
- [Setting up Mautrix Google Messages bridging](configuring-playbook-bridge-mautrix-gmessages.md) (optional)
Updated "Controlling Matrix federation" link Missing file ending results in 404
2018-11-03 23:30:17 +00:00
- [Setting up Mautrix Whatsapp bridging](configuring-playbook-bridge-mautrix-whatsapp.md) (optional)
Add support for matrix-appservice-irc
2019-01-31 05:37:23 +00:00
Add support for bridging to Facebook Messenger and Instagram via mautrix-meta Related to: https://github.com/mautrix/facebook/issues/332 Fixes: https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/3138
2024-02-19 08:13:36 +00:00
- [Setting up Instagram bridging via Mautrix Meta](configuring-playbook-bridge-mautrix-meta-instagram.md) (optional)
- [Setting up Messenger bridging via Mautrix Meta](configuring-playbook-bridge-mautrix-meta-messenger.md) (optional)
- ~~[Setting up Mautrix Facebook bridging](configuring-playbook-bridge-mautrix-facebook.md)~~ - consider bridging to Facebook/Messenger using the new [mautrix-meta-messenger](./configuring-playbook-bridge-mautrix-meta-messenger.md) bridge (optional)
Add mautrix-facebook doc
2019-05-08 14:33:09 +00:00
Update changelog and documentation
2019-08-21 04:24:58 +00:00
- [Setting up Mautrix Hangouts bridging](configuring-playbook-bridge-mautrix-hangouts.md) (optional)
Added Mautrix Google Chat
2021-10-12 11:45:04 +00:00
- [Setting up Mautrix Google Chat bridging](configuring-playbook-bridge-mautrix-googlechat.md) (optional)
Add support for bridging to Facebook Messenger and Instagram via mautrix-meta Related to: https://github.com/mautrix/facebook/issues/332 Fixes: https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/3138
2024-02-19 08:13:36 +00:00
- ~~[Setting up Mautrix Instagram bridging](configuring-playbook-bridge-mautrix-instagram.md)~~ - consider bridging to Instagram using the new [mautrix-meta-instagram](./configuring-playbook-bridge-mautrix-meta-instagram.md) bridge (optional)
update informational files.
2021-02-19 18:37:36 +00:00
Update documentation to include mautrix-twitter Playbook config copied from mautrix-facebook and altered accordingly.
2021-04-11 06:45:27 +00:00
- [Setting up Mautrix Twitter bridging](configuring-playbook-bridge-mautrix-twitter.md) (optional)
added docs
2020-10-25 17:44:19 +00:00
- [Setting up Mautrix Signal bridging](configuring-playbook-bridge-mautrix-signal.md) (optional)
Announce mautrix-wsproxy support Related to https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/2261
2023-08-23 12:11:08 +00:00
- [Setting up Mautrix wsproxy for bridging Android SMS or Apple iMessage](configuring-playbook-bridge-mautrix-wsproxy.md) (optional)
Add support for matrix-appservice-irc
2019-01-31 05:37:23 +00:00
- [Setting up Appservice IRC bridging](configuring-playbook-bridge-appservice-irc.md) (optional)
Add matrix-appservice-discord bridge Bridge is setup to work on the matrix side with this, but the discord invite link is not automatically generated.
2019-03-03 17:22:52 +00:00
- [Setting up Appservice Discord bridging](configuring-playbook-bridge-appservice-discord.md) (optional)
Added Slack role
2019-06-10 14:52:48 +00:00
- [Setting up Appservice Slack bridging](configuring-playbook-bridge-appservice-slack.md) (optional)
Merge branch 'master' into master
2019-08-21 04:34:20 +00:00
Announce Appservice Webhooks support Related to #339 (Github Pull Request).
2020-01-14 14:02:37 +00:00
- [Setting up Appservice Webhooks bridging](configuring-playbook-bridge-appservice-webhooks.md) (optional)
Add matrix-appservice-kakaotalk support Adds support for: https://src.miscworks.net/fair/matrix-appservice-kakaotalk This is pretty similar to https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/1977 which just appeared, but has mostly been done independently. I've taken some inspiration and did some fixups based on that PR. Thanks to https://github.com/hnarjis for taking the time to contribute! Notable differences between this branch compared to that PR: - better naming and documentation around the "configuration" variables - no unnecessary (5 sec.) intentional delay when starting `matrix-appservice-kakaotalk-node.service` - stores configuration in `config/`, not in `data/` - passes configuration as read-only and starts the bridge with (`--no-update`) to ensure no changes are made to it - starts containers more securely - with `matrix:matrix` user:group (not `root`) and reduced capabilities (`--cap-drop=ALL`) - uses `tcp` for communication between the "node" and the appservice (simpler than sharing unix sockets) - `registration.yaml` which is closer to the one generated by `matrix-appservice-kakaotalk` (no `de.sorunome.msc2409.push_ephemeral` stuff, etc.) - `registration.yaml` which is more customizable (customizable bot username and prefix for puppets - see `matrix_appservice_kakaotalk_appservice_bot_username` and `matrix_appservice_kakaotalk_user_prefix`) - less fragile and more extensible bridge permissions configuration via `matrix_appservice_kakaotalk_bridge_permissions`. Doing `{% if matrix_admin %}` in the bridge configuration sometimes causes syntax problems (I hit some myself) and is not ideal. Other bridges should be redone as well. - configurable command prefix for the bridge, instead of hardcoding `!kt` (see `matrix_appservice_kakaotalk_command_prefix`) - logging that is more consistent with the rest of the playbook (console / journald only, no logging to files), as well as configurable log level (via `matrix_appservice_kakaotalk_logging_level`) - somewhat more detailed documentation (`docs/configuring-playbook-bridge-appservice-kakaotalk.md`) - removed some dead code (data relocation tasks from `tasks/setup_install.yml`, as well as likely unnecessary SQLite -> Postgres migration)
2022-07-25 11:34:21 +00:00
- [Setting up Appservice Kakaotalk bridging](configuring-playbook-bridge-appservice-kakaotalk.md) (optional)
- [Setting up Beeper LinkedIn bridging](configuring-playbook-bridge-beeper-linkedin.md) (optional)
Update changelog and configuring-playbook.md This announces matrix-hookshot support that got added in https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/1505
2022-02-01 12:07:43 +00:00
- [Setting up matrix-hookshot](configuring-playbook-bridge-hookshot.md) - a bridge between Matrix and multiple project management services, such as [GitHub](https://github.com), [GitLab](https://about.gitlab.com) and [JIRA](https://www.atlassian.com/software/jira). (optional)
Update recommended Skype bridge
2022-07-15 16:49:47 +00:00
- ~~[Setting up MX Puppet Skype bridging](configuring-playbook-bridge-mx-puppet-skype.md)~~ (optional) - this component has been broken for a long time, so it has been removed from the playbook. Consider [Setting up Go Skype Bridge bridging](configuring-playbook-bridge-go-skype-bridge.md)
Announce Skype bridging
2020-04-09 06:33:30 +00:00
Announce mx-puppet-slack support Related to #454 (Github Pull Request).
2020-04-23 15:03:36 +00:00
- [Setting up MX Puppet Slack bridging](configuring-playbook-bridge-mx-puppet-slack.md) (optional)
Announce mx-puppet-instagram and mx-puppet-twitter support Related to #551 and #555 (Github Pull Requests).
2020-06-30 14:51:56 +00:00
- [Setting up MX Puppet Instagram bridging](configuring-playbook-bridge-mx-puppet-instagram.md) (optional)
- [Setting up MX Puppet Twitter bridging](configuring-playbook-bridge-mx-puppet-twitter.md) (optional)
Announce mx-puppet-discord bridging support Related to #540 (Github Pull Request).
2020-07-01 16:01:14 +00:00
- [Setting up MX Puppet Discord bridging](configuring-playbook-bridge-mx-puppet-discord.md) (optional)
Add docs
2021-02-13 15:55:54 +00:00
- [Setting up MX Puppet GroupMe bridging](configuring-playbook-bridge-mx-puppet-groupme.md) (optional)
Announce mx-puppet-steam bridging support Related to #557 (Github Pull Request).
2020-07-03 09:10:57 +00:00
- [Setting up MX Puppet Steam bridging](configuring-playbook-bridge-mx-puppet-steam.md) (optional)
Add Go Skype Bridge Based on mautrix-whatsapp, as that's what the bridge software is based on.
2022-06-12 21:29:43 +00:00
- [Setting up Go Skype Bridge bridging](configuring-playbook-bridge-go-skype-bridge.md) (optional)
Add Email2Matrix support
2019-08-05 10:06:49 +00:00
- [Setting up Email2Matrix](configuring-playbook-email2matrix.md) (optional)
matrix-sms-bridge: added docs, added seperate service for database, pr comments
2020-05-23 11:14:24 +00:00
Announce Postmoogle email bridge bot Related to https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/2043
2022-08-23 11:16:07 +00:00
- [Setting up Postmoogle email bridging](configuring-playbook-bot-postmoogle.md) (optional)
Relocate docs page for consistency
2020-09-01 10:47:58 +00:00
- [Setting up Matrix SMS bridging](configuring-playbook-bridge-matrix-bridge-sms.md) (optional)
Add support for matrix-reminder-bot
2020-07-20 11:13:08 +00:00
Add Heisenbridge
2021-05-12 12:24:39 +00:00
- [Setting up Heisenbridge bouncer-style IRC bridging](configuring-playbook-bridge-heisenbridge.md) (optional)
Add support for WeChat bridging This is based on the PR (https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/3241) by Tobias Diez (https://github.com/tobiasdiez). I've refactored some parts, made it more configurable, polished it up, and it's integrated into the playbook now. Both the WeChat bridge and WeChat agent appear to be working. The WeChat bridge joins rooms and responds as expected. That said, end-to-end testing (actually bridging to a WeChat account) has not been done yet. Fixes https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/701 Fixes https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/3092 This is sponsored https://etke.cc/ work related to https://gitlab.com/etke.cc/ansible/-/issues/2 Squashed commit of the following: commit fdd37f02472a0b83d61b4fac80650442f90e7629 Author: Slavi Pantaleev <slavi@devture.com> Date: Mon Jun 3 21:05:53 2024 +0300 Add documentation for WeChat bridge commit 8426fc8b95bb160ea7f9659bd45bc59cf1326614 Author: Slavi Pantaleev <slavi@devture.com> Date: Mon Jun 3 20:59:42 2024 +0300 Rename directory for matrix_wechat_agent_container_src_files_path commit da200df82bbc9153d307095dd90e4769c400ea1e Author: Slavi Pantaleev <slavi@devture.com> Date: Mon Jun 3 20:58:26 2024 +0300 Make WeChat listen_secret configurable and auto-configured via matrix_homeserver_generic_secret_key commit 4022cb1355828ac16af7d9228cb1066962bb35f5 Author: Slavi Pantaleev <slavi@devture.com> Date: Mon Jun 3 20:54:56 2024 +0300 Refactor install.yml for WeChat a bit (using blocks, etc.) commit d07a39b4c4f6b93d04204e13e384086d5a242d52 Author: Slavi Pantaleev <slavi@devture.com> Date: Mon Jun 3 20:52:35 2024 +0300 Rename WeChat Agent configuration file This makes it more clear that it belongs to the agent. Otherwise, `config.yaml` and `configure.yaml` make you wonder. commit ccca72f8d1e602f7c42f4bd552193afa153c9b9d Author: Slavi Pantaleev <slavi@devture.com> Date: Mon Jun 3 20:49:06 2024 +0300 Move WeChat agent configuration to a template commit a4047d94d8877b4095712dfc76ac3082a1edca28 Author: Slavi Pantaleev <slavi@devture.com> Date: Mon Jun 3 20:47:17 2024 +0300 Mount WeChat config as readonly and instruct bridge to not update it commit bc0e89f345bf14bbdbfd574bb60d93918c2ac053 Author: Slavi Pantaleev <slavi@devture.com> Date: Mon Jun 3 20:46:33 2024 +0300 Sync WeChat config with upstream Brings up-to-date with: https://github.com/duo/matrix-wechat/commits/0.2.4/example-config.yaml commit a46f5b9cbc8bf16042685a18c77d25a606bc8232 Author: Slavi Pantaleev <slavi@devture.com> Date: Mon Jun 3 19:48:17 2024 +0300 Rename some files commit 3877679040cffc4ca6cccfa21a7335f8f796f06e Author: Slavi Pantaleev <slavi@devture.com> Date: Mon Jun 3 19:47:10 2024 +0300 Update WeChat logging config This brings it up-to-date with what mautrix-go uses. Otherwise, on startup we see: > Migrating legacy log config .. and it gets migrated to what we've done here. commit e3e95ab234651867c7a975a08455549b31db4172 Author: Slavi Pantaleev <slavi@devture.com> Date: Mon Jun 3 19:43:37 2024 +0300 Make sure matrix-wechat-agent runs as 1000:1000 It needs to write stuff to `/home/user/.vnc`. `/home/user` is owned by `user:group` (`1000:1000`), so it cannot run any other way. Previously, if the `matrix` user was uid=1000 by chance, it would work, but that's pure luck. commit 4d5748ae9b84c81d6b48b0a41b790339d9ac4724 Author: Slavi Pantaleev <slavi@devture.com> Date: Mon Jun 3 18:57:09 2024 +0300 Pin wechat and wechat-agent versions commit 40d40009f19ebceed4126146cbb510a2c95af671 Author: Slavi Pantaleev <slavi@devture.com> Date: Mon Jun 3 18:53:58 2024 +0300 docker_image -> container_image for WeChat bridge commit cc33aff592541913070d13288d17b04ed6243176 Author: Slavi Pantaleev <slavi@devture.com> Date: Mon Jun 3 18:00:25 2024 +0300 docker_src -> container_src in WeChat bridge commit 42e6ae9a6483c8ca6d53b8052058d41d90d93797 Author: Slavi Pantaleev <slavi@devture.com> Date: Mon Jun 3 17:54:24 2024 +0300 matrix_go_wechat_ -> matrix_wechat_ The bridge is written in Go, but does not include Go anywhere in its name. As such, it's mostly useless to use `matrix_go_wechat` as the prefix. commit d6662a69d1916d215d5184320c36d2ef73afd3e9 Author: Tobias Diez <code@tobiasdiez.de> Date: Mon Mar 25 10:55:16 2024 +0800 Add wechat bridge
2024-06-03 18:06:19 +00:00
- [Setting up WeChat bridging](configuring-playbook-bridge-wechat.md) (optional)
Add support for matrix-reminder-bot
2020-07-20 11:13:08 +00:00
### Bots
Announce matrix-bot-chatgpt Related to https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/2386
2023-01-10 15:31:21 +00:00
- [Setting up matrix-bot-chatgpt](configuring-playbook-bot-chatgpt.md) - a bot through which you can talk to the [ChatGPT](https://openai.com/blog/chatgpt/) model(optional)
Update documentation with more chatgpt mentions
2023-01-10 15:22:54 +00:00
Announce Mjolnir bot support Related to https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/962
2021-04-03 07:52:35 +00:00
- [Setting up matrix-reminder-bot](configuring-playbook-bot-matrix-reminder-bot.md) - a bot to remind you about stuff (optional)
Announce Go-NEB support
2021-03-16 05:54:26 +00:00
Link to Buscarron bot from configuring docs page Related to https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/1782
2022-04-25 07:37:35 +00:00
- [Setting up matrix-registration-bot](configuring-playbook-bot-matrix-registration-bot.md) - a bot to create and manage registration tokens to invite users (optional)
Add docs Unrelated to the original branch I added the matrix-registration bot as it was missing in the readme
2022-07-11 11:28:23 +00:00
- [Setting up maubot](configuring-playbook-bot-maubot.md) - a plugin-based Matrix bot system (optional)
added honoroit
2022-01-06 18:30:10 +00:00
- [Setting up honoroit](configuring-playbook-bot-honoroit.md) - a helpdesk bot (optional)
Announce Mjolnir bot support Related to https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/962
2021-04-03 07:52:35 +00:00
- [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)
Add Sygnal support Fixes https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/683
2021-03-20 11:31:34 +00:00
Announce Matrix Authentication Support for Jitsi Related to https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/2375
2023-02-10 12:26:38 +00:00
- [Setting up Draupnir](configuring-playbook-bot-draupnir.md) - a moderation tool/bot, forked from Mjolnir and maintained by its former leader developer (optional)
Announce Draupnir support Related to https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/2451
2023-02-10 09:52:25 +00:00
Add support for D4A/Draupnir For All to the playbook. (#3204) * Draupnir for all Role * Draupnir for all Documentation * Pin D4A to Develop until D4A patches are in a release. * Update D4A Docs to mention pros and cons of D4A mode compared to normal * Change Documentation to mention a fixed simpler provisioning flow. Use of /plain allows us to bypass the bugs encountered during the development of this role with clients attempting to escape our wildcards causing the grief that led to using curl. This reworded commit does still explain you can automatically inject stuff into the room if you wanted to. * Emphasise the State of D4A mode * Link to Draupnir-for-all docs and tweak the docs some * Link to Draupnir-for-all from Draupnir documentation page * Announce Draupnir-for-all --------- Co-authored-by: Slavi Pantaleev <slavi@devture.com>
2024-03-05 14:09:52 +00:00
- [Setting up Draupnir for all](configuring-playbook-appservice-draupnir-for-all.md) - like the [Draupnir bot](configuring-playbook-bot-draupnir.md) mentioned above, but running in appservice mode and supporting multiple instances (optional)
Link to Buscarron bot from configuring docs page Related to https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/1782
2022-04-25 07:37:35 +00:00
- [Setting up Buscarron](configuring-playbook-bot-buscarron.md) - a bot you can use to send any form (HTTP POST, HTML) to a (encrypted) Matrix room (optional)
Add Sygnal support Fixes https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/683
2021-03-20 11:31:34 +00:00
Announce borg backup support Related to: - https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/1727 - https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/1754 - https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/1755 - https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/467
2022-04-19 16:29:41 +00:00
### Backups
- [Setting up borg backup](configuring-playbook-backup-borg.md) - a full Matrix server backup solution, including the Postgres database (optional)
- [Setting up postgres backup](configuring-playbook-postgres-backup.md) - a Postgres-database backup solution (note: does not include other files) (optional)
Add Sygnal support Fixes https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/683
2021-03-20 11:31:34 +00:00
### Other specialized services
Announce matrix-synapse-auto-compressor
2023-03-12 08:55:08 +00:00
- [Setting up synapse-auto-compressor](configuring-playbook-synapse-auto-compressor.md) for compressing the database on Synapse homeservers (optional)
Announce sliding-sync support Related to https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/2515
2023-03-07 10:22:04 +00:00
- [Setting up the Sliding Sync Proxy](configuring-playbook-sliding-sync-proxy.md) for clients which require Sliding Sync support (like Element X) (optional)
Add Sygnal support Fixes https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/683
2021-03-20 11:31:34 +00:00
- [Setting up the Sygnal push gateway](configuring-playbook-sygnal.md) (optional)
matrix-ntfy: documentation
2022-06-27 21:20:02 +00:00
- [Setting up the ntfy push notifications server](configuring-playbook-ntfy.md) (optional)
Add documentation to readme/list of services Signed-off-by: Julian-Samuel Gebühr <julian-samuel@gebuehr.net>
2022-09-16 17:15:33 +00:00
Cactus comments (#2089) * Add construct for cactus comments role * Adjust config files * Add docker self build to defaults * Adjust tasks * Fix smaller syntax errors * Fix env argument * Add tmp path to allow container writing there Background why I did this: https://docs.gunicorn.org/en/stable/settings.html#worker-tmp-dir * Change port back to 5000 as not configurable in container * Try to add appservice config file for synapse to use * Inject appservice file * Correct copied variable name * Comment out unused app service file injection would need mounting the appservice file to the synapse container i guess * Move role before synapse to be able to inject during runtime * Remove unused parts * Change default user id to mirror official docs * Add docs * Update roles/matrix-cactus-comments/tasks/setup_install.yml Co-authored-by: Slavi Pantaleev <slavi@devture.com> * Update roles/matrix-cactus-comments/templates/cactus_appservice.yaml.j2 Co-authored-by: Slavi Pantaleev <slavi@devture.com> * Generate secrets if necessary, adjust docs * Rename cactusbot userid * Shorten salt strings Co-authored-by: Slavi Pantaleev <slavi@devture.com> * Use tmpfs instead of persistent mount * Remove proxy option as it is nonsense * Add download and serving of cc-client files * Add documentation on client * Clarify docs a bit * Add nginx proxy to required services Signed-off-by: Julian-Samuel Gebühr <julian-samuel@gebuehr.net> * Use container address Signed-off-by: Julian-Samuel Gebühr <julian-samuel@gebuehr.net> * Correct comment of user id Signed-off-by: Julian-Samuel Gebühr <julian-samuel@gebuehr.net> * Use releases or local distributed client Signed-off-by: Julian-Samuel Gebühr <julian-samuel@gebuehr.net> * Move homeserver url to defaults Signed-off-by: Julian-Samuel Gebühr <julian-samuel@gebuehr.net> * Correct truth value Signed-off-by: Julian-Samuel Gebühr <julian-samuel@gebuehr.net> * Add documentation of variables Co-authored-by: Slavi Pantaleev <slavi@devture.com> * Tabs vs. spaces Co-authored-by: Slavi Pantaleev <slavi@devture.com> * Make nginx root configurable Signed-off-by: Julian-Samuel Gebühr <julian-samuel@gebuehr.net> * Complete ake nginx root configurable Signed-off-by: Julian-Samuel Gebühr <julian-samuel@gebuehr.net> * Fix file permission Signed-off-by: Julian-Samuel Gebühr <julian-samuel@gebuehr.net> * Fix lint errors Signed-off-by: Julian-Samuel Gebühr <julian-samuel@gebuehr.net> Signed-off-by: Julian-Samuel Gebühr <julian-samuel@gebuehr.net> Co-authored-by: Slavi Pantaleev <slavi@devture.com>
2022-09-09 11:37:52 +00:00
- [Setting up a Cactus Comments server](configuring-playbook-cactus-comments.md) - a federated comment system built on Matrix (optional)
Add Rageshake documentation
2023-02-25 12:00:42 +00:00
- [Setting up the Rageshake bug report server](configuring-playbook-rageshake.md) (optional)
Add support for matrix-alertmanager-receiver
2024-07-06 18:48:41 +00:00
- [Setting up Prometheus Alertmanager integration via matrix-alertmanager-receiver](configuring-playbook-alertmanager-receiver.md) (optional)
Reference in New Issue Copy Permalink