Matrix/matrix-docker-ansible-deploy
1
0
Fork 0
mirror of https://github.com/spantaleev/matrix-docker-ansible-deploy.git synced 2024-11-14 10:04:46 +08:00
Code Issues Packages Projects Releases Wiki Activity
85e4c16905
matrix-docker-ansible-deploy/docs/configuring-playbook.md

129 lines
5.5 KiB
Markdown
Raw Normal View History

Minor wording improvements
2018-08-15 15:19:31 +08:00
# Configuring the Ansible playbook
Split README into a bunch of files in docs/
2018-08-08 15:07:02 +08:00
Improve documentation about getting the playbook
2019-03-10 23:02:17 +08: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 15:07:02 +08:00
Improve documentation about getting the playbook
2019-03-10 23:02:17 +08: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 15:07:02 +08:00
- create a directory to hold your configuration (`mkdir inventory/host_vars/matrix.<your-domain>`)
Rename file to prevent common mistake Prompted by this: https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/779#issuecomment-764807507
2021-01-22 01:24:05 +08:00
- 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 15:07:02 +08:00
Split playbook into multiple roles As suggested in #63 (Github issue), splitting the playbook's logic into multiple roles will be beneficial for maintainability. This patch realizes this split. Still, some components affect others, so the roles are not really independent of one another. For example: - disabling mxisd (`matrix_mxisd_enabled: false`), causes Synapse and riot-web to reconfigure themselves with other (public) Identity servers. - enabling matrix-corporal (`matrix_corporal_enabled: true`) affects how reverse-proxying (by `matrix-nginx-proxy`) is done, in order to put matrix-corporal's gateway server in front of Synapse We may be able to move away from such dependencies in the future, at the expense of a more complicated manual configuration, but it's probably not worth sacrificing the convenience we have now. As part of this work, the way we do "start components" has been redone now to use a loop, as suggested in #65 (Github issue). This should make restarting faster and more reliable.
2019-01-12 23:53:00 +08:00
- 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 15:07:02 +08:00
- copy the sample inventory hosts file (`cp examples/hosts inventory/hosts`)
- edit the inventory hosts file (`inventory/hosts`) to your liking
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 14:54:18 +08:00
### Additional useful services
Add documentation about Telemetry configuration
2018-11-02 00:21:38 +08: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 14:54:18 +08: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 23:02:04 +08:00
Add Jitsi reference to Configuring Playbook docs page
2020-03-25 00:26:52 +08:00
- [Setting up the Jitsi video-conferencing platform](configuring-playbook-jitsi.md) (optional)
Improve "things to do after installation" docs section
2021-01-26 23:19:28 +08: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 14:54:18 +08:00
Announce Prometheus/Grafana
2021-02-12 20:02:53 +08: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 14:54:18 +08:00
### Core service adjustments
Add email-sending support
2018-08-14 19:11:41 +08:00
Make Synapse configuration extensible
2019-08-22 14:49:22 +08:00
- [Configuring Synapse](configuring-playbook-synapse.md) (optional)
Riot is now Element Fixes #586 (Github Issue)
2020-07-17 16:31:20 +08:00
- [Configuring Element](configuring-playbook-client-element.md) (optional)
Make Riot-web configuration extensible Fixes #71 (Github Issue).
2019-08-25 15:37:05 +08:00
Improve wording a bit
2018-08-08 15:10:16 +08: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 15:07:02 +08:00
- [Using an external PostgreSQL server](configuring-playbook-external-postgres.md) (optional)
Replace mxisd with ma1sd in docs, fixing URLs
2020-01-08 02:04:26 +08:00
- [Adjusting ma1sd Identity Server configuration](configuring-playbook-ma1sd.md) (optional)
Add mxisd Identity Server support
2018-08-15 15:23:22 +08:00
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 17:00:12 +08:00
- [Adjusting SSL certificate retrieval](configuring-playbook-ssl-certificates.md) (optional, advanced)
Add support for serving base domain via matrix-nginx-proxy
2019-03-13 04:27:18 +08: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 16:07:37 +08:00
- [Configure Nginx (optional, advanced)](configuring-playbook-nginx.md) (optional, advanced)
add ngnix-status to config add doc
2019-04-17 19:42:09 +08: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 13:23:42 +08: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 14:02:12 +08:00
Add TURN server configuration documentation
2019-04-19 14:57:41 +08: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 14:54:18 +08: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)
### Authentication and user-related
Add synapse-admin support Fixes #562 (Github Issue)
2020-07-22 13:10:26 +08:00
- [Setting up Synapse Admin](configuring-playbook-synapse-admin.md) (optional)
Add matrix-registration support
2020-09-01 18:46:05 +08: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 13:23:42 +08: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 22:11:55 +08: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 13:23:42 +08: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 18:34:34 +08:00
Add LDAP auth password provider documentation and changelog description
2018-11-28 17:21:03 +08: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 13:13:06 +08: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 13:23:42 +08:00
- [Setting up Matrix Corporal](configuring-playbook-matrix-corporal.md) (optional, advanced)
Update README
2018-09-08 04:35:04 +08: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 14:54:18 +08:00
### Bridging other networks
Update documentation
2018-10-27 00:44:58 +08: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 07:30:17 +08:00
- [Setting up Mautrix Whatsapp bridging](configuring-playbook-bridge-mautrix-whatsapp.md) (optional)
Add support for matrix-appservice-irc
2019-01-31 13:37:23 +08:00
Add mautrix-facebook doc
2019-05-08 22:33:09 +08:00
- [Setting up Mautrix Facebook bridging](configuring-playbook-bridge-mautrix-facebook.md) (optional)
Update changelog and documentation
2019-08-21 12:24:58 +08:00
- [Setting up Mautrix Hangouts bridging](configuring-playbook-bridge-mautrix-hangouts.md) (optional)
added docs
2020-10-26 01:44:19 +08:00
- [Setting up Mautrix Signal bridging](configuring-playbook-bridge-mautrix-signal.md) (optional)
Add support for matrix-appservice-irc
2019-01-31 13:37:23 +08: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-04 01:22:52 +08:00
- [Setting up Appservice Discord bridging](configuring-playbook-bridge-appservice-discord.md) (optional)
Added Slack role
2019-06-10 22:52:48 +08:00
- [Setting up Appservice Slack bridging](configuring-playbook-bridge-appservice-slack.md) (optional)
Merge branch 'master' into master
2019-08-21 12:34:20 +08:00
Announce Appservice Webhooks support Related to #339 (Github Pull Request).
2020-01-14 22:02:37 +08:00
- [Setting up Appservice Webhooks bridging](configuring-playbook-bridge-appservice-webhooks.md) (optional)
Announce Skype bridging
2020-04-09 14:33:30 +08: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 23:03:36 +08: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 22:51:56 +08: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-02 00:01:14 +08:00
- [Setting up MX Puppet Discord bridging](configuring-playbook-bridge-mx-puppet-discord.md) (optional)
Announce mx-puppet-steam bridging support Related to #557 (Github Pull Request).
2020-07-03 17:10:57 +08:00
- [Setting up MX Puppet Steam bridging](configuring-playbook-bridge-mx-puppet-steam.md) (optional)
Add Email2Matrix support
2019-08-05 18:06:49 +08:00
- [Setting up Email2Matrix](configuring-playbook-email2matrix.md) (optional)
matrix-sms-bridge: added docs, added seperate service for database, pr comments
2020-05-23 19:14:24 +08:00
Relocate docs page for consistency
2020-09-01 18:47:58 +08:00
- [Setting up Matrix SMS bridging](configuring-playbook-bridge-matrix-bridge-sms.md) (optional)
Add support for matrix-reminder-bot
2020-07-20 19:13:08 +08:00
### Bots
- [Setting up matrix-reminder-bot](configuring-playbook-bot-matrix-reminder-bot.md) (optional)
Reference in New Issue Copy Permalink