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
6d29048ed9
matrix-docker-ansible-deploy/README.md

173 lines
16 KiB
Markdown
Raw Normal View History

Add donation and support room badges
2020-12-01 21:24:07 +08:00
[![Support room on Matrix](https://img.shields.io/matrix/matrix-docker-ansible-deploy:devture.com.svg?label=%23matrix-docker-ansible-deploy%3Adevture.com&logo=matrix&style=for-the-badge&server_fqdn=matrix.devture.com)](https://matrix.to/#/#matrix-docker-ansible-deploy:devture.com) [![donate](https://liberapay.com/assets/widgets/donate.svg)](https://liberapay.com/s.pantaleev/donate)
Initial commit
2017-08-01 04:07:30 +08:00
# Matrix (An open network for secure, decentralized communication) server setup using Ansible and Docker
## Purpose
Make README more tidy
2021-01-24 16:04:30 +08:00
This [Ansible](https://www.ansible.com/) playbook is meant to help you run your own [Matrix](http://matrix.org/) homeserver, along with the [various services](#supported-services) related to that.
Initial commit
2017-08-01 04:07:30 +08:00
Make README more tidy
2021-01-24 16:04:30 +08:00
That is, it lets you join the Matrix network using your own `@<username>:<your-domain>` identifier, all hosted on your own server (see [prerequisites](docs/prerequisites.md)).
We run all services in [Docker](https://www.docker.com/) containers (see [the container images we use](docs/container-images.md)), which lets us have a predictable and up-to-date setup, across multiple supported distros (see [prerequisites](docs/prerequisites.md)) and [architectures](docs/alternative-architectures.md) (x86/amd64 being recommended).
[Installation](docs/README.md) (upgrades) and some maintenance tasks are automated using [Ansible](https://www.ansible.com/) (see [our Ansible guide](docs/ansible.md)).
Bring back newlines
2021-05-17 21:10:54 +08:00
Make README more tidy
2021-01-24 16:04:30 +08:00
## Supported services
Initial commit
2017-08-01 04:07:30 +08:00
Using this playbook, you can get the following services configured on your server:
Bring back newlines
2021-05-17 21:10:54 +08:00
Update README and changelog
2019-05-21 10:04:58 +08:00
- (optional, default) a [Synapse](https://github.com/matrix-org/synapse) homeserver - storing your data and managing your presence in the [Matrix](http://matrix.org/) network
Bring back newlines
2021-05-17 21:10:54 +08:00
Announce Conduit support Related to https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/2002
2022-08-09 16:37:57 +08:00
- (optional) a [Conduit](https://conduit.rs) homeserver - storing your data and managing your presence in the [Matrix](http://matrix.org/) network. Conduit is a lightweight open-source server implementation of the Matrix Specification with a focus on easy setup and low system requirements
Update README
2022-01-07 21:13:13 +08:00
- (optional) a [Dendrite](https://github.com/matrix-org/dendrite) homeserver - storing your data and managing your presence in the [Matrix](http://matrix.org/) network. Dendrite is a second-generation Matrix homeserver written in Go, an alternative to Synapse.
Make roles more independent of one another With this change, the following roles are now only dependent on the minimal `matrix-base` role: - `matrix-corporal` - `matrix-coturn` - `matrix-mailer` - `matrix-mxisd` - `matrix-postgres` - `matrix-riot-web` - `matrix-synapse` The `matrix-nginx-proxy` role still does too much and remains dependent on the others. Wiring up the various (now-independent) roles happens via a glue variables file (`group_vars/matrix-servers`). It's triggered for all hosts in the `matrix-servers` group. According to Ansible's rules of priority, we have the following chain of inclusion/overriding now: - role defaults (mostly empty or good for independent usage) - playbook glue variables (`group_vars/matrix-servers`) - inventory host variables (`inventory/host_vars/matrix.<your-domain>`) All roles default to enabling their main component (e.g. `matrix_mxisd_enabled: true`, `matrix_riot_web_enabled: true`). Reasoning: if a role is included in a playbook (especially separately, in another playbook), it should "work" by default. Our playbook disables some of those if they are not generally useful (e.g. `matrix_corporal_enabled: false`).
2019-01-17 00:05:48 +08:00
- (optional) [Amazon S3](https://aws.amazon.com/s3/) storage for Synapse's content repository (`media_store`) files using [Goofys](https://github.com/kahing/goofys)
Bring back newlines
2021-05-17 21:10:54 +08:00
Make roles more independent of one another With this change, the following roles are now only dependent on the minimal `matrix-base` role: - `matrix-corporal` - `matrix-coturn` - `matrix-mailer` - `matrix-mxisd` - `matrix-postgres` - `matrix-riot-web` - `matrix-synapse` The `matrix-nginx-proxy` role still does too much and remains dependent on the others. Wiring up the various (now-independent) roles happens via a glue variables file (`group_vars/matrix-servers`). It's triggered for all hosts in the `matrix-servers` group. According to Ansible's rules of priority, we have the following chain of inclusion/overriding now: - role defaults (mostly empty or good for independent usage) - playbook glue variables (`group_vars/matrix-servers`) - inventory host variables (`inventory/host_vars/matrix.<your-domain>`) All roles default to enabling their main component (e.g. `matrix_mxisd_enabled: true`, `matrix_riot_web_enabled: true`). Reasoning: if a role is included in a playbook (especially separately, in another playbook), it should "work" by default. Our playbook disables some of those if they are not generally useful (e.g. `matrix_corporal_enabled: false`).
2019-01-17 00:05:48 +08:00
- (optional, default) [PostgreSQL](https://www.postgresql.org/) database for Synapse. [Using an external PostgreSQL server](docs/configuring-playbook-external-postgres.md) is also possible.
Bring back newlines
2021-05-17 21:10:54 +08:00
Make roles more independent of one another With this change, the following roles are now only dependent on the minimal `matrix-base` role: - `matrix-corporal` - `matrix-coturn` - `matrix-mailer` - `matrix-mxisd` - `matrix-postgres` - `matrix-riot-web` - `matrix-synapse` The `matrix-nginx-proxy` role still does too much and remains dependent on the others. Wiring up the various (now-independent) roles happens via a glue variables file (`group_vars/matrix-servers`). It's triggered for all hosts in the `matrix-servers` group. According to Ansible's rules of priority, we have the following chain of inclusion/overriding now: - role defaults (mostly empty or good for independent usage) - playbook glue variables (`group_vars/matrix-servers`) - inventory host variables (`inventory/host_vars/matrix.<your-domain>`) All roles default to enabling their main component (e.g. `matrix_mxisd_enabled: true`, `matrix_riot_web_enabled: true`). Reasoning: if a role is included in a playbook (especially separately, in another playbook), it should "work" by default. Our playbook disables some of those if they are not generally useful (e.g. `matrix_corporal_enabled: false`).
2019-01-17 00:05:48 +08:00
- (optional, default) a [coturn](https://github.com/coturn/coturn) STUN/TURN server for WebRTC audio/video calls
Bring back newlines
2021-05-17 21:10:54 +08:00
Riot is now Element Fixes #586 (Github Issue)
2020-07-17 16:31:20 +08:00
- (optional, default) free [Let's Encrypt](https://letsencrypt.org/) SSL certificate, which secures the connection to the Synapse server and the Element web UI
Bring back newlines
2021-05-17 21:10:54 +08:00
Update README.md to rename Element
2020-07-15 21:44:49 +08:00
- (optional, default) an [Element](https://app.element.io/) ([formerly Riot](https://element.io/previously-riot)) web UI, which is configured to connect to your own Synapse server by default
Bring back newlines
2021-05-17 21:10:54 +08:00
Do not install the ma1sd identity server by default As mentioned in the changelog, this is a breaking change.
2022-03-17 23:58:59 +08:00
- (optional) a [ma1sd](https://github.com/ma1uta/ma1sd) Matrix Identity server
Bring back newlines
2021-05-17 21:10:54 +08:00
Make (most) containers start as non-root This makes all containers (except mautrix-telegram and mautrix-whatsapp), start as a non-root user. We do this, because we don't trust some of the images. In any case, we'd rather not trust ALL images and avoid giving `root` access at all. We can't be sure they would drop privileges or what they might do before they do it. Because Postfix doesn't support running as non-root, it had to be replaced by an Exim mail server. The matrix-nginx-proxy nginx container image is patched up (by replacing its main configuration) so that it can work as non-root. It seems like there's no other good image that we can use and that is up-to-date (https://hub.docker.com/r/nginxinc/nginx-unprivileged is outdated). Likewise for riot-web (https://hub.docker.com/r/bubuntux/riot-web/), we patch it up ourselves when starting (replacing the main nginx configuration). Ideally, it would be fixed upstream so we can simplify.
2019-01-28 02:25:13 +08:00
- (optional, default) an [Exim](https://www.exim.org/) mail server, through which all Matrix services send outgoing email (can be configured to relay through another SMTP server)
Bring back newlines
2021-05-17 21:10:54 +08:00
Fix typo
2021-05-17 22:32:31 +08:00
- (optional, default) an [nginx](http://nginx.org/) web server, listening on ports 80 and 443 - standing in front of all the other services. Using your own webserver [is possible](docs/configuring-playbook-own-webserver.md)
Bring back newlines
2021-05-17 21:10:54 +08:00
Replace mxisd with ma1sd in docs, fixing URLs
2020-01-08 02:04:26 +08:00
- (optional, advanced) the [matrix-synapse-rest-auth](https://github.com/ma1uta/matrix-synapse-rest-password-provider) REST authentication password provider module
Bring back newlines
2021-05-17 21:10:54 +08:00
Make it clearer that not all components are necessary
2018-11-26 16:35:08 +08:00
- (optional, advanced) the [matrix-synapse-shared-secret-auth](https://github.com/devture/matrix-synapse-shared-secret-auth) password provider module
Bring back newlines
2021-05-17 21:10:54 +08:00
Add LDAP auth password provider documentation and changelog description
2018-11-28 17:21:03 +08:00
- (optional, advanced) the [matrix-synapse-ldap3](https://github.com/matrix-org/matrix-synapse-ldap3) LDAP Auth password provider module
Bring back newlines
2021-05-17 21:10:54 +08:00
Update README
2019-09-09 13:17:35 +08:00
- (optional, advanced) the [synapse-simple-antispam](https://github.com/t2bot/synapse-simple-antispam) spam checker module
Bring back newlines
2021-05-17 21:10:54 +08:00
Make it clearer that not all components are necessary
2018-11-26 16:35:08 +08:00
- (optional, advanced) the [Matrix Corporal](https://github.com/devture/matrix-corporal) reconciliator and gateway for a managed Matrix server
Bring back newlines
2021-05-17 21:10:54 +08:00
Update README.md
2022-08-08 20:25:40 +08:00
- (optional) the [mautrix-discord](https://github.com/mautrix/discord) bridge for bridging your Matrix server to [Discord](https://discord.com/) - see [docs/configuring-playbook-bridge-mautrix-discord.md](docs/configuring-playbook-bridge-mautrix-discord.md) for setup documentation
Update readme mautrix bridges
2021-08-18 22:49:35 +08:00
- (optional) the [mautrix-telegram](https://github.com/mautrix/telegram) bridge for bridging your Matrix server to [Telegram](https://telegram.org/)
Bring back newlines
2021-05-17 21:10:54 +08:00
Update readme mautrix bridges
2021-08-18 22:49:35 +08:00
- (optional) the [mautrix-whatsapp](https://github.com/mautrix/whatsapp) bridge for bridging your Matrix server to [WhatsApp](https://www.whatsapp.com/)
Bring back newlines
2021-05-17 21:10:54 +08:00
Update readme mautrix bridges
2021-08-18 22:49:35 +08:00
- (optional) the [mautrix-facebook](https://github.com/mautrix/facebook) bridge for bridging your Matrix server to [Facebook](https://facebook.com/)
Bring back newlines
2021-05-17 21:10:54 +08:00
Update documentation to include mautrix-twitter Playbook config copied from mautrix-facebook and altered accordingly.
2021-04-11 14:45:27 +08:00
- (optional) the [mautrix-twitter](https://github.com/mautrix/twitter) bridge for bridging your Matrix server to [Twitter](https://twitter.com/)
Update readme mautrix bridges
2021-08-18 22:49:35 +08:00
- (optional) the [mautrix-hangouts](https://github.com/mautrix/hangouts) bridge for bridging your Matrix server to [Google Hangouts](https://en.wikipedia.org/wiki/Google_Hangouts)
Bring back newlines
2021-05-17 21:10:54 +08:00
Added Mautrix Google Chat
2021-10-12 19:45:04 +08:00
- (optional) the [mautrix-googlechat](https://github.com/mautrix/googlechat) bridge for bridging your Matrix server to [Google Chat](https://en.wikipedia.org/wiki/Google_Chat)
Update readme mautrix bridges
2021-08-18 22:49:35 +08:00
- (optional) the [mautrix-instagram](https://github.com/mautrix/instagram) bridge for bridging your Matrix server to [Instagram](https://instagram.com/)
Bring back newlines
2021-05-17 21:10:54 +08:00
Update readme mautrix bridges
2021-08-18 22:49:35 +08:00
- (optional) the [mautrix-signal](https://github.com/mautrix/signal) bridge for bridging your Matrix server to [Signal](https://www.signal.org/)
Bring back newlines
2021-05-17 21:10:54 +08:00
Update beeper-linkedin URLs to the new GitHub repo
2022-08-20 04:28:29 +08:00
- (optional) the [beeper-linkedin](https://github.com/beeper/linkedin) bridge for bridging your Matrix server to [LinkedIn](https://www.linkedin.com/)
Adds Documentation for LinkedIn Bridge
2021-08-22 00:24:30 +08:00
Fix matrix-appservice-irc database specification This fixes an incorrect indentation in the database specification for appservice-irc which caused matrix-appservice-irc to refuse to start with the remarkably unhelpful error message: ``` ERROR:CLI Failed to run bridge. ``` This also updates doc links to the new matrixdotorg repo because the tedomum repo contains out-of-date documentation.
2020-02-08 18:02:03 +08:00
- (optional) the [matrix-appservice-irc](https://github.com/matrix-org/matrix-appservice-irc) bridge for bridging your Matrix server to [IRC](https://wikipedia.org/wiki/Internet_Relay_Chat)
Bring back newlines
2021-05-17 21:10:54 +08:00
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
- (optional) the [matrix-appservice-discord](https://github.com/Half-Shot/matrix-appservice-discord) bridge for bridging your Matrix server to [Discord](https://discordapp.com/)
Bring back newlines
2021-05-17 21:10:54 +08:00
Update changelog
2019-08-21 12:48:42 +08:00
- (optional) the [matrix-appservice-slack](https://github.com/matrix-org/matrix-appservice-slack) bridge for bridging your Matrix server to [Slack](https://slack.com/)
Bring back newlines
2021-05-17 21:10:54 +08:00
Add matrix-appservice-webhooks to configurable services in README.md
2020-01-10 22:04:23 +08:00
- (optional) the [matrix-appservice-webhooks](https://github.com/turt2live/matrix-appservice-webhooks) bridge for slack compatible webhooks ([ConcourseCI](https://concourse-ci.org/), [Slack](https://slack.com/) etc. pp.)
Bring back newlines
2021-05-17 21:10:54 +08:00
add hookshot to README.md
2022-02-01 23:32:08 +08:00
- (optional) the [matrix-hookshot](https://github.com/Half-Shot/matrix-hookshot) bridge for bridging Matrix to generic webhooks and multiple project management services, such as GitHub, GitLab, Figma, and Jira in particular
Add mx-puppet-skype and mx-puppet-slack to README I also moved matrix-sms-bridge up to match the order from container-images.md
2021-01-30 07:31:27 +08:00
- (optional) the [matrix-sms-bridge](https://github.com/benkuly/matrix-sms-bridge) for bridging your Matrix server to SMS - see [docs/configuring-playbook-bridge-matrix-bridge-sms.md](docs/configuring-playbook-bridge-matrix-bridge-sms.md) for setup documentation
Bring back newlines
2021-05-17 21:10:54 +08:00
Add Heisenbridge
2021-05-12 20:24:39 +08:00
- (optional) the [Heisenbridge](https://github.com/hifi/heisenbridge) for bridging your Matrix server to IRC bouncer-style - see [docs/configuring-playbook-bridge-heisenbridge.md](docs/configuring-playbook-bridge-heisenbridge.md) for setup documentation
Update README.md to include Go Skype Bridge Update README.md to include Go Skype Bridge, added in #1877
2022-06-28 22:51:06 +08:00
- (optional) the [go-skype-bridge](https://github.com/kelaresg/go-skype-bridge) for bridging your Matrix server to [Skype](https://www.skype.com) - see [docs/configuring-playbook-bridge-go-skype-bridge.md](docs/configuring-playbook-bridge-go-skype-bridge.md) for setup documentation
fix typo from skype to slack
2021-02-09 01:22:59 +08:00
- (optional) the [mx-puppet-slack](https://hub.docker.com/r/sorunome/mx-puppet-slack) for bridging your Matrix server to [Slack](https://slack.com) - see [docs/configuring-playbook-bridge-mx-puppet-slack.md](docs/configuring-playbook-bridge-mx-puppet-slack.md) for setup documentation
Bring back newlines
2021-05-17 21:10:54 +08:00
mx-puppet-instagram: add documentation on how to setup & use the bridge
2020-06-28 16:46:39 +08:00
- (optional) the [mx-puppet-instagram](https://github.com/Sorunome/mx-puppet-instagram) bridge for Instagram-DMs ([Instagram](https://www.instagram.com/)) - see [docs/configuring-playbook-bridge-mx-puppet-instagram.md](docs/configuring-playbook-bridge-mx-puppet-instagram.md) for setup documentation
Bring back newlines
2021-05-17 21:10:54 +08:00
Mention Prometheus/Grafana on the README
2021-02-12 22:32:49 +08:00
- (optional) the [mx-puppet-twitter](https://github.com/Sorunome/mx-puppet-twitter) bridge for Twitter-DMs ([Twitter](https://twitter.com/)) - see [docs/configuring-playbook-bridge-mx-puppet-twitter.md](docs/configuring-playbook-bridge-mx-puppet-twitter.md) for setup documentation
Bring back newlines
2021-05-17 21:10:54 +08:00
Mention Prometheus/Grafana on the README
2021-02-12 22:32:49 +08:00
- (optional) the [mx-puppet-discord](https://github.com/matrix-discord/mx-puppet-discord) bridge for [Discord](https://discordapp.com/) - see [docs/configuring-playbook-bridge-mx-puppet-discord.md](docs/configuring-playbook-bridge-mx-puppet-discord.md) for setup documentation
Bring back newlines
2021-05-17 21:10:54 +08:00
Migrate mx-puppet-groupme to new repo
2022-07-20 07:02:32 +08:00
- (optional) the [mx-puppet-groupme](https://gitlab.com/xangelix-pub/matrix/mx-puppet-groupme) bridge for [GroupMe](https://groupme.com/) - see [docs/configuring-playbook-bridge-mx-puppet-groupme.md](docs/configuring-playbook-bridge-mx-puppet-groupme.md) for setup documentation
Bring back newlines
2021-05-17 21:10:54 +08:00
Mention Prometheus/Grafana on the README
2021-02-12 22:32:49 +08:00
- (optional) the [mx-puppet-steam](https://github.com/icewind1991/mx-puppet-steam) bridge for [Steam](https://steamapp.com/) - see [docs/configuring-playbook-bridge-mx-puppet-steam.md](docs/configuring-playbook-bridge-mx-puppet-steam.md) for setup documentation
Bring back newlines
2021-05-17 21:10:54 +08:00
Add matrix-registration support
2020-09-01 18:46:05 +08:00
- (optional) [Email2Matrix](https://github.com/devture/email2matrix) for relaying email messages to Matrix rooms - see [docs/configuring-playbook-email2matrix.md](docs/configuring-playbook-email2matrix.md) for setup documentation
Bring back newlines
2021-05-17 21:10:54 +08:00
Add matrix-registration support
2020-09-01 18:46:05 +08:00
- (optional) [Dimension](https://github.com/turt2live/matrix-dimension), an open source integrations manager for matrix clients - see [docs/configuring-playbook-dimension.md](docs/configuring-playbook-dimension.md) for setup documentation
Bring back newlines
2021-05-17 21:10:54 +08:00
Etherpad documentation
2021-01-20 22:52:26 +08:00
- (optional) [Etherpad](https://etherpad.org), an open source collaborative text editor - see [docs/configuring-playbook-etherpad.md](docs/configuring-playbook-etherpad.md) for setup documentation
Bring back newlines
2021-05-17 21:10:54 +08:00
Add matrix-registration support
2020-09-01 18:46:05 +08:00
- (optional) [Jitsi](https://jitsi.org/), an open source video-conferencing platform - see [docs/configuring-playbook-jitsi.md](docs/configuring-playbook-jitsi.md) for setup documentation
Bring back newlines
2021-05-17 21:10:54 +08:00
Add matrix-registration support
2020-09-01 18:46:05 +08:00
- (optional) [matrix-reminder-bot](https://github.com/anoadragon453/matrix-reminder-bot) for scheduling one-off & recurring reminders and alarms - see [docs/configuring-playbook-bot-matrix-reminder-bot.md](docs/configuring-playbook-bot-matrix-reminder-bot.md) for setup documentation
Bring back newlines
2021-05-17 21:10:54 +08:00
Add docs Unrelated to the original branch I added the matrix-registration bot as it was missing in the readme
2022-07-11 19:28:23 +08:00
- (optional) [matrix-registration-bot](https://github.com/moan0s/matrix-registration-bot) for invitations by creating and managing registration tokens - see [docs/configuring-playbook-bot-matrix-registration-bot.md](docs/configuring-playbook-bot-matrix-registration-bot.md) for setup documentation
matrix-maubot -> maubot
2022-07-21 22:26:48 +08:00
- (optional) [maubot](https://github.com/maubot/maubot) a plugin-based Matrix bot system - see [docs/configuring-playbook-bot-maubot.md](docs/configuring-playbook-bot-maubot.md) for setup documentation
Add docs Unrelated to the original branch I added the matrix-registration bot as it was missing in the readme
2022-07-11 19:28:23 +08:00
added honoroit
2022-01-07 02:30:10 +08:00
- (optional) [honoroit](https://gitlab.com/etke.cc/honoroit) helpdesk bot - see [docs/configuring-playbook-bot-honoroit.md](docs/configuring-playbook-bot-honoroit.md) for setup documentation
Announce Postmoogle email bridge bot Related to https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/2043
2022-08-23 19:16:07 +08:00
- (optional) [Postmoogle](https://gitlab.com/etke.cc/postmoogle) email to matrix bot - see [docs/configuring-playbook-bot-postmoogle.md](docs/configuring-playbook-bot-postmoogle.md) for setup documentation
update README
2022-08-23 01:29:48 +08:00
Added a link to the doc in the README
2021-03-12 23:57:49 +08:00
- (optional) [Go-NEB](https://github.com/matrix-org/go-neb) multi functional bot written in Go - see [docs/configuring-playbook-bot-go-neb.md](docs/configuring-playbook-bot-go-neb.md) for setup documentation
Bring back newlines
2021-05-17 21:10:54 +08:00
Add mjolnir
2021-03-24 11:46:08 +08:00
- (optional) [Mjolnir](https://github.com/matrix-org/mjolnir), a moderation tool for Matrix - see [docs/configuring-playbook-bot-mjolnir.md](docs/configuring-playbook-bot-mjolnir.md) for setup documentation
Bring back newlines
2021-05-17 21:10:54 +08:00
Add matrix-registration support
2020-09-01 18:46:05 +08:00
- (optional) [synapse-admin](https://github.com/Awesome-Technologies/synapse-admin), a web UI tool for administrating users and rooms on your Matrix server - see [docs/configuring-playbook-synapse-admin.md](docs/configuring-playbook-synapse-admin.md) for setup documentation
Bring back newlines
2021-05-17 21:10:54 +08:00
Add matrix-registration support
2020-09-01 18:46:05 +08:00
- (optional) [matrix-registration](https://github.com/ZerataX/matrix-registration), a simple python application to have a token based matrix registration - see [docs/configuring-playbook-matrix-registration.md](docs/configuring-playbook-matrix-registration.md) for setup documentation
Bring back newlines
2021-05-17 21:10:54 +08:00
Mention Prometheus/Grafana on the README
2021-02-12 22:32:49 +08:00
- (optional) the [Prometheus](https://prometheus.io) time-series database server, the Prometheus [node-exporter](https://prometheus.io/docs/guides/node-exporter/) host metrics exporter, and the [Grafana](https://grafana.com/) web UI - see [Enabling metrics and graphs (Prometheus, Grafana) for your Matrix server](docs/configuring-playbook-prometheus-grafana.md) for setup documentation
Bring back newlines
2021-05-17 21:10:54 +08:00
Add Sygnal support Fixes https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/683
2021-03-20 19:31:34 +08:00
- (optional) the [Sygnal](https://github.com/matrix-org/sygnal) push gateway - see [Setting up the Sygnal push gateway](docs/configuring-playbook-sygnal.md) for setup documentation
matrix-ntfy: list in playbook's README.md
2022-07-06 04:00:55 +08:00
- (optional) the [ntfy](https://ntfy.sh) push notifications server - see [docs/configuring-playbook-ntfy.md](docs/configuring-playbook-ntfy.md) for setup documentation
Add docs
2021-05-21 17:43:04 +08:00
- (optional) the [Hydrogen](https://github.com/vector-im/hydrogen-web) web client - see [docs/configuring-playbook-client-hydrogen.md](docs/configuring-playbook-client-hydrogen.md) for setup documentation
added matrix-client-cinny
2022-01-06 00:33:21 +08:00
- (optional) the [Cinny](https://github.com/ajbura/cinny) web client - see [docs/configuring-playbook-client-cinny.md](docs/configuring-playbook-client-cinny.md) for setup documentation
add borg backup (#1727) * add borg backup * lint fix * add exlclude patterns * missed in the #1726 fix for honoroit * feedback * Fix indentation * feedback * feedback * feedback Co-authored-by: Slavi Pantaleev <slavi@devture.com>
2022-04-05 19:37:27 +08:00
- (optional) the [Borg](https://borgbackup.org) backup - see [docs/configuring-playbook-backup-borg.md](docs/configuring-playbook-backup-borg.md) for setup documentation
add buscarron to the readme
2022-04-23 22:11:24 +08:00
- (optional) the [Buscarron](https://gitlab.com/etke.cc/buscarron) bot - see [docs/configuring-playbook-bot-buscarron.md](docs/configuring-playbook-bot-buscarron.md) for setup documentation
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 19:37:52 +08:00
- (optional) [Cactus Comments](https://cactus.chat), a federated comment system built on matrix - see [docs/configuring-playbook-cactus-comments.md](docs/configuring-playbook-cactus-comments.md) for setup documentation
Fixed typos in README Hi, I used [LanguageTool](https://languagetool.org) to fix typos in README
2021-05-13 03:52:23 +08:00
Basically, this playbook aims to get you up-and-running with all the necessities around Matrix, without you having to do anything else.
Initial commit
2017-08-01 04:07:30 +08:00
Make it clearer that not all components are necessary
2018-11-26 16:35:08 +08:00
**Note**: the list above is exhaustive. It includes optional or even some advanced components that you will most likely not need.
Sticking with the defaults (which install a subset of the above components) is the best choice, especially for a new installation.
You can always re-run the playbook later to add or remove components.
Bring back newlines
2021-05-17 21:10:54 +08:00
Split README into a bunch of files in docs/
2018-08-08 15:07:02 +08:00
## Installation
Initial commit
2017-08-01 04:07:30 +08:00
Split README into a bunch of files in docs/
2018-08-08 15:07:02 +08:00
To configure and install Matrix on your own server, follow the [README in the docs/ directory](docs/README.md).
Initial commit
2017-08-01 04:07:30 +08:00
Bring back newlines
2021-05-17 21:10:54 +08:00
Split README into a bunch of files in docs/
2018-08-08 15:07:02 +08:00
## Changes
Initial commit
2017-08-01 04:07:30 +08:00
Split README into a bunch of files in docs/
2018-08-08 15:07:02 +08:00
This playbook evolves over time, sometimes with backward-incompatible changes.
Bring back newlines
2021-05-17 21:10:54 +08:00
Split README into a bunch of files in docs/
2018-08-08 15:07:02 +08:00
When updating the playbook, refer to [the changelog](CHANGELOG.md) to catch up with what's new.
Add support for not taking over a server (no matrix-nginx-proxy) and disabling Riot
2017-09-12 17:41:44 +08:00
Bring back newlines
2021-05-17 21:10:54 +08:00
Add support information
2018-05-29 14:58:36 +08:00
## Support
Add information about the IRC support channel
2018-11-23 19:23:01 +08:00
- Matrix room: [#matrix-docker-ansible-deploy:devture.com](https://matrix.to/#/#matrix-docker-ansible-deploy:devture.com)
Bring back newlines
2021-05-17 21:10:54 +08:00
Update IRC channel
2021-05-28 04:21:47 +08:00
- IRC channel: `#matrix-docker-ansible-deploy` on the [Libera Chat](https://libera.chat/) IRC network (irc.libera.chat:6697)
Bring back newlines
2021-05-17 21:10:54 +08:00
Fixed typos in README Hi, I used [LanguageTool](https://languagetool.org) to fix typos in README
2021-05-13 03:52:23 +08:00
- GitHub issues: [spantaleev/matrix-docker-ansible-deploy/issues](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues)
Added services built by community Hi, After discussion with Slavi ([link to private chat](https://matrix.to/#/!GWNJzoHiCybWdouIiP:etke.cc/$_XpK8-ucbWvxY667IVZ9ROZPqSVkG2UGglNagrbDQmw?via=etke.cc&via=devture.com)), we agreed on adding services that use matrix-docker-ansible-deploy as a core to list in README file. @GoMatrixHosting could you approve the description is correct, please? (Sorry, I just put what I know about your service)
2021-05-12 00:02:13 +08:00
Bring back newlines
2021-05-17 21:10:54 +08:00
Updated description with @GoMatrixHosting edits
2021-05-12 15:40:48 +08:00
## Services by the community
Added services built by community Hi, After discussion with Slavi ([link to private chat](https://matrix.to/#/!GWNJzoHiCybWdouIiP:etke.cc/$_XpK8-ucbWvxY667IVZ9ROZPqSVkG2UGglNagrbDQmw?via=etke.cc&via=devture.com)), we agreed on adding services that use matrix-docker-ansible-deploy as a core to list in README file. @GoMatrixHosting could you approve the description is correct, please? (Sorry, I just put what I know about your service)
2021-05-12 00:02:13 +08:00
Fixed typos in README Hi, I used [LanguageTool](https://languagetool.org) to fix typos in README
2021-05-13 03:52:23 +08:00
- [etke.cc](https://etke.cc) - matrix-docker-ansible-deploy and system stuff "as a service". That service will create your matrix homeserver on your domain and server (doesn't matter if it's cloud provider or on an old laptop in the corner of your room), (optional) maintains it (server's system updates, cleanup, security adjustments, tuning, etc.; matrix homeserver updates & maintenance) and (optional) provide full-featured email service for your domain
Reference in New Issue Copy Permalink