finallycoffee/matrix-docker-ansible-deploy
finallycoffee/matrix-docker-ansible-deploy
5
1
Fork 0
Code Issues Pull Requests Releases Wiki Activity
Upstream: https://github.com/spantaleev/matrix-docker-ansible-deploy Used for deploying https://matrix.finallycoffee.eu/
5,913 Commits 3 Branches 0 Tags 171 MiB
Jinja 99.3%
Just 0.3%
Shell 0.3%
adcc6d9723
Go to file
Slavi Pantaleev adcc6d9723 Relocate Traefik (to matrix-traefik.service && /matrix/traefik base path) 
The migration is automatic. Existing users should experience a bit of
downtime until the playbook runs to completion, but don't need to do
anything manually.

This change is provoked by https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/2535

While my statements there ("Traefik is a shared component among
sibling/related playbooks and should retain its global
non-matrix-prefixed name and path") do make sense, there's another point
of view as well.

With the addition of docker-socket-proxy support in bf2b540807,
we potentially introduced another non-`matrix-`-prefixed systemd service
and global path (`/devture-container-socket-proxy`). It would have
started to become messy.

Traefik always being called `devture-traefik.service` and using the `/devture-traefik` path
has the following downsides:

- different playbooks may write to the same place, unintentionally,
  before you disable the Traefik role in some of them.
  If each playbook manages its own installation, no such conflicts
  arise and you'll learn about the conflict when one of them starts its
  Traefik service and fails because the ports are already in use

- the data is scattered - backing up `/matrix` is no longer enough when
  some stuff lives in `/devture-traefik` or `/devture-container-socket-proxy` as well;
  similarly, deleting `/matrix` is no longer enough to clean up

For this reason, the Traefik instance managed by this playbook
will now be called `matrix-traefik` and live under `/matrix/traefik`.

This also makes it obvious to users running multiple playbooks, which
Traefik instance (powered by which playbook) is the active one.
Previously, you'd look at `devture-traefik.service` and wonder which
role was managing it.
2023-03-06 09:34:31 +02:00
.config Try to fix ansible-lint Github action 2022-11-20 19:13:00 +02:00
.github Bump ansible-community/ansible-lint-action from 6.10.2 to 6.11.0 2023-01-20 16:03:54 +00:00
collections fix: all praise the allmighty yamllinter 2022-02-05 21:32:54 +01:00
docs Add Traefik support to Go-NEB bot 2023-03-03 10:40:45 +02:00
examples Improve wordng in examples/nginx/README.md 2023-02-27 17:45:28 +02:00
group_vars Relocate Traefik (to matrix-traefik.service && /matrix/traefik base path) 2023-03-06 09:34:31 +02:00
inventory run the playbook on multiple hosts with different credentials (#1980) 2022-07-26 16:34:55 +03:00
playbooks Harden Traefik security by accessing the Docker API through docker-socket-proxy 2023-03-06 09:11:02 +02:00
roles/custom Relocate Traefik (to matrix-traefik.service && /matrix/traefik base path) 2023-03-06 09:34:31 +02:00
.editorconfig Make .editorconfig for group_vars/matrix_servers cleaner 2023-02-15 08:50:31 +02:00
.gitignore Adjust .gitignore 2022-11-03 09:16:54 +02:00
.yamllint remove old workers.yml (already saved into main.yml) 2022-11-04 19:02:24 +02:00
ansible.cfg Use the yaml callback plugin when running ansible-playbook 2021-02-18 15:57:05 +01:00
CHANGELOG.md Switch to using an external Etherpad role 2023-03-02 22:50:13 +02:00
justfile Add justfile 2023-01-11 15:12:05 +02:00
LICENSE Add LICENSE file 2018-08-17 09:01:06 +03:00
Makefile Try to fix ansible-lint Github action 2022-11-20 19:13:00 +02:00
README.md Add Related plabooks 2023-02-26 16:21:50 +02:00
requirements.yml Harden Traefik security by accessing the Docker API through docker-socket-proxy 2023-03-06 09:11:02 +02:00
setup.yml Provision extra Jitsi JVB services on additional hosts (#2166) 2022-11-18 14:00:27 +02:00

README.md

Support room on Matrix donate

Matrix (An open network for secure, decentralized communication) server setup using Ansible and Docker

Purpose

This Ansible playbook is meant to help you run your own Matrix homeserver, along with the various services related to that.

That is, it lets you join the Matrix network using your own @<username>:<your-domain> identifier, all hosted on your own server (see prerequisites).

We run all services in Docker containers (see the container images we use), which lets us have a predictable and up-to-date setup, across multiple supported distros (see prerequisites) and architectures (x86/amd64 being recommended).

Installation (upgrades) and some maintenance tasks are automated using Ansible (see our Ansible guide).

Self-hosting or SaaS

This Ansible playbook tries to make self-hosting and maintaining a Matrix server fairly easy. Still, running any service smoothly requires knowledge, time and effort.

If you like the FOSS spirit of this Ansible playbook, but prefer to put the responsibility on someone else, you can also get a managed Matrix server from etke.cc - a service built on top of this Ansible playbook, which can help you run a Matrix server with ease.

If you like learning and experimentation, but would rather reduce future maintenance effort, you can even go for a hybrid approach - self-hosting manually using this Ansible playbook at first and then transferring server maintenance to etke.cc at a later time.

Supported services

Using this playbook, you can get the following list of services configured on your server. Basically, this playbook aims to get you up-and-running with all the necessities around Matrix, without you having to do anything else.

Note: the list below 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.

Homeserver

The homeserver is the backbone of your matrix system. Choose one from the following list.

Name Default? Description Documentation
Synapse ✓ Storing your data and managing your presence in the Matrix network Link
Conduit x Storing your data and managing your presence in the Matrix network. Conduit is a lightweight open-source server implementation of the Matrix Specification with a focus on easy setup and low system requirements Link
Dendrite x Storing your data and managing your presence in the Matrix network. Dendrite is a second-generation Matrix homeserver written in Go, an alternative to Synapse. Link

Clients

Web clients for matrix that you can host on your own domains.

Name Default? Description Documentation
Element ✓ Web UI, which is configured to connect to your own Synapse server by default Link
Hydrogen x Web client Link
Cinny x Web client Link

Server Components

Services that run on the server to make the various parts of your installation work.

Name Default? Description Documentation
PostgreSQL ✓ Database for Synapse. Using an external PostgreSQL server is also possible. Link
Coturn ✓ STUN/TURN server for WebRTC audio/video calls Link
Traefik ✓ Web server, listening on ports 80, 443 and 8448 - standing in front of all the other services. Using your own webserver is possible Link
nginx x (Deprecated) Web server, listening on ports 80, 443 and 8448 - standing in front of all the other services. Deprecated in favor of Traefik Link
Let's Encrypt ✓ Free SSL certificate, which secures the connection to all components Link
ma1sd x Matrix Identity Server Link
Exim ✓ Mail server, through which all Matrix services send outgoing email (can be configured to relay through another SMTP server) Link
Dimension x An open source integrations manager for matrix clients Link
Sygnal x Push gateway Link
ntfy x Push notifications server Link

Authentication

Extend and modify how users are authenticated on your homeserver.

Name Default? Description Documentation
matrix-synapse-rest-auth (advanced) x REST authentication password provider module Link
matrix-synapse-shared-secret-auth (advanced) x Password provider module Link
matrix-synapse-ldap3 (advanced) x LDAP Auth password provider module Link
matrix-ldap-registration-proxy (advanced) x A proxy that handles Matrix registration requests and forwards them to LDAP. Link
matrix-registration x A simple python application to have a token based matrix registration Link

File Storage

Use alternative file storage to the default media_store folder.

Name Default? Description Documentation
Goofys x Amazon S3 (or other S3-compatible object store) storage for Synapse's content repository (media_store) files Link
synapse-s3-storage-provider x Amazon S3 (or other S3-compatible object store) storage for Synapse's content repository (media_store) files Link

Bridges

Bridges can be used to connect your matrix installation with third-party communication networks.

Name Default? Description Documentation
mautrix-discord x Bridge for bridging your Matrix server to Discord Link
mautrix-slack x Bridge for bridging your Matrix server to Slack Link
mautrix-telegram x Bridge for bridging your Matrix server to Telegram Link
mautrix-whatsapp x Bridge for bridging your Matrix server to WhatsApp Link
mautrix-facebook x Bridge for bridging your Matrix server to Facebook Link
mautrix-twitter x Bridge for bridging your Matrix server to Twitter Link
mautrix-hangouts x Bridge for bridging your Matrix server to Google Hangouts Link
mautrix-googlechat x Bridge for bridging your Matrix server to Google Chat Link
mautrix-instagram x Bridge for bridging your Matrix server to Instagram Link
mautrix-signal x Bridge for bridging your Matrix server to Signal Link
beeper-linkedin x Bridge for bridging your Matrix server to LinkedIn Link
matrix-appservice-irc x Bridge for bridging your Matrix server to IRC Link
matrix-appservice-discord x Bridge for bridging your Matrix server to Discord Link
matrix-appservice-slack x Bridge for bridging your Matrix server to Slack Link
matrix-appservice-webhooks x Bridge for slack compatible webhooks (ConcourseCI, Slack etc. pp.) Link
matrix-hookshot x Bridge for bridging Matrix to generic webhooks and multiple project management services, such as GitHub, GitLab, Figma, and Jira in particular Link
matrix-sms-bridge x Bridge for bridging your Matrix server to SMS Link
Heisenbridge x Bridge for bridging your Matrix server to IRC bouncer-style Link
go-skype-bridge x Bridge for bridging your Matrix server to Skype Link
mx-puppet-slack x Bridge for bridging your Matrix server to Slack Link
mx-puppet-instagram x Bridge for Instagram-DMs (Instagram) Link
mx-puppet-twitter x Bridge for Twitter-DMs (Twitter) Link
mx-puppet-discord x Bridge for Discord Link
mx-puppet-groupme x Bridge for GroupMe Link
mx-puppet-steam x Bridge for Steam Link
Email2Matrix x Bridge for relaying email messages to Matrix rooms Link

Bots

Bots provide various additional functionality to your installation.

Name Default? Description Documentation
matrix-reminder-bot x Bot for scheduling one-off & recurring reminders and alarms Link
matrix-registration-bot x Bot for invitations by creating and managing registration tokens Link
maubot x A plugin-based Matrix bot system Link
honoroit x A helpdesk bot Link
Postmoogle x Email to matrix bot Link
Go-NEB x A multi functional bot written in Go Link
Mjolnir x A moderation tool for Matrix Link
Draupnir x A moderation tool for Matrix (Fork of Mjolnir) Link
Buscarron x Web forms (HTTP POST) to matrix Link
matrix-chatgpt-bot x ChatGPT from matrix Link

Administration

Services that help you in administrating and monitoring your matrix installation.

Name Default? Description Documentation
synapse-admin x A web UI tool for administrating users and rooms on your Matrix server Link
Metrics and Graphs x Consists of the Prometheus time-series database server, the Prometheus node-exporter host metrics exporter, and the Grafana web UI Link
Borg x Backups Link
Rageshake x Bug report server Link

Misc

Various services that don't fit any other category.

Name Default? Description Documentation
synapse-simple-antispam (advanced) x A spam checker module Link
Matrix Corporal (advanced) x Reconciliator and gateway for a managed Matrix server Link
Etherpad x An open source collaborative text editor Link
Jitsi x An open source video-conferencing platform Link
Cactus Comments x A federated comment system built on matrix Link

Installation

To configure and install Matrix on your own server, follow the README in the docs/ directory.

Changes

This playbook evolves over time, sometimes with backward-incompatible changes.

When updating the playbook, refer to the changelog to catch up with what's new.

Support

Related

You may also be interested in these other Ansible playbooks:

They're all making use of Traefik as their reverse-proxy, so it should be easy to host all these services on the same server. Follow the docs/configuring-playbook-interoperability.md documentation in each playbook.