titanz
/
matrix-docker-ansible-deploy
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '39e6484956'
${ noResults }
matrix-docker-ansible-deploy/docs/configuring-playbook.md

191 lines
9.4 KiB
Raw Normal View History Unescape

Minor wording improvements
6 years ago
# Configuring the Ansible playbook
Split README into a bunch of files in docs/
6 years ago
Improve documentation about getting the playbook
6 years ago
To configure the playbook, you need to have done the following things:
Split README into a bunch of files in docs/
6 years ago
Improve documentation about getting the playbook
6 years ago
- 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/
6 years ago
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
4 years ago
1. create a directory to hold your configuration (`mkdir inventory/host_vars/matrix.<your-domain>`)
Split README into a bunch of files in docs/
6 years ago
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
4 years ago
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/
6 years ago
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
4 years ago
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/
6 years ago
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
4 years ago
1. copy the sample inventory hosts file (`cp examples/hosts inventory/hosts`)
Split README into a bunch of files in docs/
6 years ago
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
4 years ago
1. edit the inventory hosts file (`inventory/hosts`) to your liking
Split README into a bunch of files in docs/
6 years ago
run the playbook on multiple hosts with different credentials (#1980) * run the playbook on multiple hosts with different credentials with this script * fix: add yaml missing document start "---" * fix: *now really* allow this script to be run from any directory * add about-note to examples/host.yml Co-authored-by: Slavi Pantaleev <slavi@devture.com> * improve ansible-all-hosts.sh related docs/configuring-playbook.md Co-authored-by: Slavi Pantaleev <slavi@devture.com> * fix typos :) Co-authored-by: Slavi Pantaleev <slavi@devture.com>
2 years ago
1. (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`](../inventory/scripts/ansible-all-hosts.sh) script [in the installation step](installing.md).
Split README into a bunch of files in docs/
6 years ago
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.
6 years ago
### Additional useful services
Add documentation about Telemetry configuration
6 years ago
Split additional configuration options in groups It's too many configuration options to keep them in a single list. Trying to put some order.
6 years ago
- [Setting up the Dimension Integration Manager](configuring-playbook-dimension.md) (optional, but recommended; after [installing](installing.md))
Add support for controlling Matrix federation
6 years ago
Add Jitsi reference to Configuring Playbook docs page
5 years ago
- [Setting up the Jitsi video-conferencing platform](configuring-playbook-jitsi.md) (optional)
docs/configuring-playbook: Add link to etherpad configuration
2 years ago
- [Setting up Etherpad](configuring-playbook-etherpad.md) (optional)
Improve "things to do after installation" docs section
4 years ago
- [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.
6 years ago
Announce Prometheus/Grafana
4 years ago
- [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.
6 years ago
### Core service adjustments
Add email-sending support
6 years ago
Document Conduit installation Fixes https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/2076
2 years ago
- 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
5 years ago
Riot is now Element Fixes #586 (Github Issue)
4 years ago
- [Configuring Element](configuring-playbook-client-element.md) (optional)
Make Riot-web configuration extensible Fixes #71 (Github Issue).
5 years ago
Improve wording a bit
6 years ago
- [Storing Matrix media files on Amazon S3](configuring-playbook-s3.md) (optional)
Split README into a bunch of files in docs/
6 years ago
- [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.
6 years ago
- [Adjusting SSL certificate retrieval](configuring-playbook-ssl-certificates.md) (optional, advanced)
Add support for serving base domain via matrix-nginx-proxy
6 years ago
- [Serving your base domain using this playbook's nginx server](configuring-playbook-base-domain-serving.md) (optional)
Minor typo update
2 years ago
- [Configure Nginx](configuring-playbook-nginx.md) (optional, advanced)
add ngnix-status to config add doc
6 years ago
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)".
6 years ago
- [Using your own webserver, instead of this playbook's nginx proxy](configuring-playbook-own-webserver.md) (optional, advanced)
Add matrix-synapse-rest-auth support
6 years ago
Add TURN server configuration documentation
6 years ago
- [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.
6 years ago
### 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
4 years ago
- [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.
3 years ago
added matrix-client-cinny
3 years ago
- [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
4 years ago
Split additional configuration options in groups It's too many configuration options to keep them in a single list. Trying to put some order.
6 years ago
### Authentication and user-related
Do not install the ma1sd identity server by default As mentioned in the changelog, this is a breaking change.
3 years ago
- [Setting up an ma1sd Identity Server](configuring-playbook-ma1sd.md) (optional)
Add synapse-admin support Fixes #562 (Github Issue)
4 years ago
- [Setting up Synapse Admin](configuring-playbook-synapse-admin.md) (optional)
Add matrix-registration support
4 years ago
- [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)".
6 years ago
- [Setting up the REST authentication password provider module](configuring-playbook-rest-auth.md) (optional, advanced)
Add support for matrix-synapse-shared-secret-auth
6 years ago
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)".
6 years ago
- [Setting up the Shared Secret Auth password provider module](configuring-playbook-shared-secret-auth.md) (optional, advanced)
Add support for matrix-corporal
6 years ago
Add LDAP auth password provider documentation and changelog description
6 years ago
- [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>
2 years ago
- [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).
5 years ago
- [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)".
6 years ago
- [Setting up Matrix Corporal](configuring-playbook-matrix-corporal.md) (optional, advanced)
Update README
6 years ago
Split additional configuration options in groups It's too many configuration options to keep them in a single list. Trying to put some order.
6 years ago
### Bridging other networks
Add Mautrix Discord Bridge
2 years ago
- [Setting up Mautrix Discord bridging](configuring-playbook-bridge-mautrix-discord.md) (optional)
Update documentation
6 years ago
- [Setting up Mautrix Telegram bridging](configuring-playbook-bridge-mautrix-telegram.md) (optional)
Updated "Controlling Matrix federation" link Missing file ending results in 404
6 years ago
- [Setting up Mautrix Whatsapp bridging](configuring-playbook-bridge-mautrix-whatsapp.md) (optional)
Add support for matrix-appservice-irc
6 years ago
Add mautrix-facebook doc
6 years ago
- [Setting up Mautrix Facebook bridging](configuring-playbook-bridge-mautrix-facebook.md) (optional)
Update changelog and documentation
5 years ago
- [Setting up Mautrix Hangouts bridging](configuring-playbook-bridge-mautrix-hangouts.md) (optional)
Added Mautrix Google Chat
3 years ago
- [Setting up Mautrix Google Chat bridging](configuring-playbook-bridge-mautrix-googlechat.md) (optional)
update informational files.
4 years ago
- [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.
4 years ago
- [Setting up Mautrix Twitter bridging](configuring-playbook-bridge-mautrix-twitter.md) (optional)
added docs
4 years ago
- [Setting up Mautrix Signal bridging](configuring-playbook-bridge-mautrix-signal.md) (optional)
Add support for matrix-appservice-irc
6 years ago
- [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.
6 years ago
- [Setting up Appservice Discord bridging](configuring-playbook-bridge-appservice-discord.md) (optional)
Added Slack role
6 years ago
- [Setting up Appservice Slack bridging](configuring-playbook-bridge-appservice-slack.md) (optional)
Merge branch 'master' into master
5 years ago
Announce Appservice Webhooks support Related to #339 (Github Pull Request).
5 years ago
- [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)
2 years ago
- [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
3 years ago
- [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
2 years ago
- ~~[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
5 years ago
Announce mx-puppet-slack support Related to #454 (Github Pull Request).
5 years ago
- [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).
4 years ago
- [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).
4 years ago
- [Setting up MX Puppet Discord bridging](configuring-playbook-bridge-mx-puppet-discord.md) (optional)
Add docs
4 years ago
- [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).
4 years ago
- [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.
2 years ago
- [Setting up Go Skype Bridge bridging](configuring-playbook-bridge-go-skype-bridge.md) (optional)
Add Email2Matrix support
5 years ago
- [Setting up Email2Matrix](configuring-playbook-email2matrix.md) (optional)
matrix-sms-bridge: added docs, added seperate service for database, pr comments
5 years ago
Announce Postmoogle email bridge bot Related to https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/2043
2 years ago
- [Setting up Postmoogle email bridging](configuring-playbook-bot-postmoogle.md) (optional)
Relocate docs page for consistency
4 years ago
- [Setting up Matrix SMS bridging](configuring-playbook-bridge-matrix-bridge-sms.md) (optional)
Add support for matrix-reminder-bot
4 years ago
Add Heisenbridge
4 years ago
- [Setting up Heisenbridge bouncer-style IRC bridging](configuring-playbook-bridge-heisenbridge.md) (optional)
Add support for matrix-reminder-bot
4 years ago
### Bots
Announce Mjolnir bot support Related to https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/962
4 years ago
- [Setting up matrix-reminder-bot](configuring-playbook-bot-matrix-reminder-bot.md) - a bot to remind you about stuff (optional)
Announce Go-NEB support
4 years ago
Link to Buscarron bot from configuring docs page Related to https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/1782
3 years ago
- [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
2 years ago
- [Setting up maubot](configuring-playbook-bot-maubot.md) - a plugin-based Matrix bot system (optional)
added honoroit
3 years ago
- [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
4 years ago
- [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
4 years ago
Link to Buscarron bot from configuring docs page Related to https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/1782
3 years ago
- [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
4 years ago
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
3 years ago
### 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
4 years ago
### Other specialized services
- [Setting up the Sygnal push gateway](configuring-playbook-sygnal.md) (optional)
matrix-ntfy: documentation
2 years ago
- [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>
2 years ago
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>
2 years ago
- [Setting up a Cactus Comments server](configuring-playbook-cactus-comments.md) - a federated comment system built on Matrix (optional)