mirror/matrix-docker-ansible-deploy
1
0
Fork 0
mirror of https://github.com/spantaleev/matrix-docker-ansible-deploy.git synced 2024-11-10 12:47:39 +01:00
Code Issues Packages Projects Releases Wiki Activity
2f33b330ff
matrix-docker-ansible-deploy/docs/configuring-playbook.md

166 lines
7.6 KiB
Markdown
Raw Normal View History

Minor wording improvements
2018-08-15 09:19:31 +02:00
# Configuring the Ansible playbook
Split README into a bunch of files in docs/
2018-08-08 09:07:02 +02:00
Improve documentation about getting the playbook
2019-03-10 16:02:17 +01: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 09:07:02 +02:00
Improve documentation about getting the playbook
2019-03-10 16:02:17 +01: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 09:07:02 +02: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 19:35:12 +01:00
1. create a directory to hold your configuration (`mkdir inventory/host_vars/matrix.<your-domain>`)
Split README into a bunch of files in docs/
2018-08-08 09:07:02 +02: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 19:35:12 +01: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 09:07:02 +02: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 19:35:12 +01: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 09:07:02 +02: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 19:35:12 +01: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 09:07:02 +02: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 19:35:12 +01:00
1. edit the inventory hosts file (`inventory/hosts`) to your liking
Split README into a bunch of files in docs/
2018-08-08 09:07:02 +02: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 08:54:18 +02:00
### Additional useful services
Add documentation about Telemetry configuration
2018-11-01 17:21:38 +01: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 08:54:18 +02:00
- [Setting up the Dimension Integration Manager](configuring-playbook-dimension.md) (optional, but recommended; after [installing](installing.md))
Add support for controlling Matrix federation
2018-10-25 17:02:04 +02:00
Add Jitsi reference to Configuring Playbook docs page
2020-03-24 17:26:52 +01:00
- [Setting up the Jitsi video-conferencing platform](configuring-playbook-jitsi.md) (optional)
Improve "things to do after installation" docs section
2021-01-26 16:19:28 +01: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 08:54:18 +02:00
Announce Prometheus/Grafana
2021-02-12 13:02:53 +01: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 08:54:18 +02:00
### Core service adjustments
Add email-sending support
2018-08-14 13:11:41 +02:00
Make Synapse configuration extensible
2019-08-22 08:49:22 +02:00
- [Configuring Synapse](configuring-playbook-synapse.md) (optional)
Riot is now Element Fixes #586 (Github Issue)
2020-07-17 10:31:20 +02:00
- [Configuring Element](configuring-playbook-client-element.md) (optional)
Make Riot-web configuration extensible Fixes #71 (Github Issue).
2019-08-25 09:37:05 +02:00
Improve wording a bit
2018-08-08 09:10:16 +02: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 09:07:02 +02: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 10:00:12 +01: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 21:27:18 +01:00
- [Serving your base domain using this playbook's nginx server](configuring-playbook-base-domain-serving.md) (optional)
Fix spelling ngnix -> nginx
2019-10-04 10:07:37 +02:00
- [Configure Nginx (optional, advanced)](configuring-playbook-nginx.md) (optional, advanced)
add ngnix-status to config add doc
2019-04-17 13:42:09 +02: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 06:23:42 +01:00
- [Using your own webserver, instead of this playbook's nginx proxy](configuring-playbook-own-webserver.md) (optional, advanced)
Add matrix-synapse-rest-auth support
2018-08-17 08:02:12 +02:00
Add TURN server configuration documentation
2019-04-19 08:57:41 +02: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 08:54:18 +02: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 12:50:45 +02: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 16:58:59 +01:00
added matrix-client-cinny
2022-01-05 17:33:21 +01: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 12:50:45 +02: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 08:54:18 +02: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 16:58:59 +01:00
- [Setting up an ma1sd Identity Server](configuring-playbook-ma1sd.md) (optional)
Add synapse-admin support Fixes #562 (Github Issue)
2020-07-22 07:10:26 +02:00
- [Setting up Synapse Admin](configuring-playbook-synapse-admin.md) (optional)
Add matrix-registration support
2020-09-01 12:46:05 +02: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 06:23:42 +01: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 16:11:55 +02: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 06:23:42 +01: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 12:34:34 +02:00
Add LDAP auth password provider documentation and changelog description
2018-11-28 10:21:03 +01:00
- [Setting up the LDAP password provider module](configuring-playbook-ldap-auth.md) (optional, advanced)
Add support for Synapse Simple Antispam Fixes #255 (Github Issue).
2019-09-09 07:13:06 +02: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 06:23:42 +01:00
- [Setting up Matrix Corporal](configuring-playbook-matrix-corporal.md) (optional, advanced)
Update README
2018-09-07 22:35:04 +02: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 08:54:18 +02:00
### Bridging other networks
Update documentation
2018-10-26 18:44:58 +02:00
- [Setting up Mautrix Telegram bridging](configuring-playbook-bridge-mautrix-telegram.md) (optional)
Updated "Controlling Matrix federation" link Missing file ending results in 404
2018-11-04 00:30:17 +01:00
- [Setting up Mautrix Whatsapp bridging](configuring-playbook-bridge-mautrix-whatsapp.md) (optional)
Add support for matrix-appservice-irc
2019-01-31 06:37:23 +01:00
Add mautrix-facebook doc
2019-05-08 16:33:09 +02:00
- [Setting up Mautrix Facebook bridging](configuring-playbook-bridge-mautrix-facebook.md) (optional)
Update changelog and documentation
2019-08-21 06:24:58 +02:00
- [Setting up Mautrix Hangouts bridging](configuring-playbook-bridge-mautrix-hangouts.md) (optional)
Added Mautrix Google Chat
2021-10-12 13:45:04 +02:00
- [Setting up Mautrix Google Chat bridging](configuring-playbook-bridge-mautrix-googlechat.md) (optional)
update informational files.
2021-02-19 19:37:36 +01:00
- [Setting up Mautrix Instagram bridging](configuring-playbook-bridge-mautrix-instagram.md) (optional)
Update documentation to include mautrix-twitter Playbook config copied from mautrix-facebook and altered accordingly.
2021-04-11 08:45:27 +02:00
- [Setting up Mautrix Twitter bridging](configuring-playbook-bridge-mautrix-twitter.md) (optional)
added docs
2020-10-25 18:44:19 +01:00
- [Setting up Mautrix Signal bridging](configuring-playbook-bridge-mautrix-signal.md) (optional)
Add support for matrix-appservice-irc
2019-01-31 06:37:23 +01: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 18:22:52 +01:00
Adds Documentation for LinkedIn Bridge
2021-08-21 18:24:30 +02:00
- [Setting up Beeper LinkedIn bridging](configuring-playbook-bridge-beeper-linkedin.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 18:22:52 +01:00
- [Setting up Appservice Discord bridging](configuring-playbook-bridge-appservice-discord.md) (optional)
Added Slack role
2019-06-10 16:52:48 +02:00
- [Setting up Appservice Slack bridging](configuring-playbook-bridge-appservice-slack.md) (optional)
Merge branch 'master' into master
2019-08-21 06:34:20 +02:00
Announce Appservice Webhooks support Related to #339 (Github Pull Request).
2020-01-14 15:02:37 +01:00
- [Setting up Appservice Webhooks bridging](configuring-playbook-bridge-appservice-webhooks.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 13:07:43 +01: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)
Announce Skype bridging
2020-04-09 08:33:30 +02:00
- [Setting up MX Puppet Skype bridging](configuring-playbook-bridge-mx-puppet-skype.md) (optional)
Announce mx-puppet-slack support Related to #454 (Github Pull Request).
2020-04-23 17:03:36 +02: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 16:51:56 +02: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 18:01:14 +02:00
- [Setting up MX Puppet Discord bridging](configuring-playbook-bridge-mx-puppet-discord.md) (optional)
Add docs
2021-02-13 16:55:54 +01: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 11:10:57 +02:00
- [Setting up MX Puppet Steam bridging](configuring-playbook-bridge-mx-puppet-steam.md) (optional)
Add Email2Matrix support
2019-08-05 12:06:49 +02:00
- [Setting up Email2Matrix](configuring-playbook-email2matrix.md) (optional)
matrix-sms-bridge: added docs, added seperate service for database, pr comments
2020-05-23 13:14:24 +02:00
Relocate docs page for consistency
2020-09-01 12:47:58 +02:00
- [Setting up Matrix SMS bridging](configuring-playbook-bridge-matrix-bridge-sms.md) (optional)
Add support for matrix-reminder-bot
2020-07-20 13:13:08 +02:00
Add Heisenbridge
2021-05-12 14:24:39 +02:00
- [Setting up Heisenbridge bouncer-style IRC bridging](configuring-playbook-bridge-heisenbridge.md) (optional)
Add support for matrix-reminder-bot
2020-07-20 13:13:08 +02:00
### Bots
Announce Mjolnir bot support Related to https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/962
2021-04-03 09:52:35 +02: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 06:54:26 +01:00
added honoroit
2022-01-06 19:30:10 +01: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 09:52:35 +02: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 12:31:34 +01:00
Add matrix-registration-bot (#1771) * Add matrix-registration-bot This adds an install and uninstall task plus helpers. The bot is disabled by default. This commit does not include documentation, yet. In short, the bot can be enabled by adding matrix_bot_matrix_registration_bot_enabled: true matrix_bot_matrix_registration_bot_matrix_user_password: "verysecret" matrix_bot_matrix_registration_bot_matrix_admin_token: "supersecret" to the host_vars * Change bot username to bot.matrix-registration-bot following convention * Address smaller remarks, fix local docker build * Switch to an env file * Add environment variables extension for additional config * Add documentation for the matrix-registration-bot * Add screenshot on how to obtain admin access token * Use bot as admin to only have one access token (bot and admin api) * Use cleaner setting of matrix_synapse_registration_requires_token * Use config file for cleaner more secure usage * Delete unneeded env * Rename vars to make usage clear * Fix typos/wording and add notice about logging out * Convert configuration to use |to_json * Reorder role includes Nothing should be after `matrix-common-after`. `matrix-bot-matrix-registration-bot` can probably be anywhere, but it makes sense to put it next to the other `matrix-bot-*` roles. * Minor group_vars/matrix_servers touchups Co-authored-by: Slavi Pantaleev <slavi@devture.com>
2022-04-21 10:07:47 +02: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 Sygnal support Fixes https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/683
2021-03-20 12:31:34 +01: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 18:29:41 +02: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 12:31:34 +01:00
### Other specialized services
- [Setting up the Sygnal push gateway](configuring-playbook-sygnal.md) (optional)
Reference in New Issue Copy Permalink