7
0
mirror of https://github.com/spantaleev/matrix-docker-ansible-deploy.git synced 2024-12-30 08:16:04 +00:00
Matrix (An open network for secure, decentralized communication) server setup using Ansible and Docker
Go to file
2024-12-08 12:07:00 +02:00
.config Disable var-naming[no-role-prefix] ansible-lint rule 2023-07-12 08:18:50 +03:00
.github Merge pull request from luixxiul/fix 2024-12-06 18:51:17 +02:00
bin Add support for bridging to Facebook Messenger and Instagram via mautrix-meta 2024-02-19 10:25:00 +02:00
collections fix: all praise the allmighty yamllinter 2022-02-05 21:32:54 +01:00
docs Merge pull request from luixxiul/fix 2024-12-07 08:57:34 +02:00
examples Replace triple dots with horizontal ellipsis (U+2026) 2024-12-06 13:34:50 +09:00
group_vars Update beeper-linkedin configuration to latest upstream config and properly pass double-puppeting login shared secrets 2024-12-02 20:00:08 +02:00
roles/custom Upgrade matrix-corporal (3.1.1 -> 3.1.2) 2024-12-08 12:07:00 +02:00
.editorconfig Add justfile to .editorconfig 2023-03-28 10:55:43 +03:00
.envrc Added a nix flake 2023-04-16 19:04:35 +00:00
.gitattributes add .gitattributes with checking out with lf line endings 2023-10-23 19:09:30 +03:00
.gitignore chore: fix nix flake () 2024-04-09 10:22:45 +03: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 Edit CHANGELOG.md: remove blank lines from paragraphes rendered as one 2024-12-06 18:22:46 +09:00
flake.lock chore: fix nix flake () 2024-04-09 10:22:45 +03:00
flake.nix chore: fix nix flake () 2024-04-09 10:22:45 +03:00
jitsi_jvb.yml Ensure docker is installed on additional JVBs (fixes ) 2023-06-17 15:04:35 +03:00
justfile Replace triple dots with horizontal ellipsis (U+2026) 2024-12-06 13:34:50 +09: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 Edit README.md: add links to docs/FAQ.md and to the support section 2024-12-06 05:36:13 +02:00
requirements.yml borgmatic v1.9.4 2024-12-07 19:07:46 +02:00
setup.yml Add support for Valkey and default to using it instead of KeyDB 2024-11-23 14:43:04 +02:00
YEAR-IN-REVIEW.md Add "Web" to Element and SchildiChat web application () 2024-11-07 16:31:26 +02:00

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>:example.com identifier, all hosted on your own server (see prerequisites).

We run all supported 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 Managed / SaaS

This Ansible playbook tries to make self-hosting and maintaining a Matrix server fairly easy (see Getting started). 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 (both hosting and on-premises) - a service built on top of this Ansible playbook but with additional components and services which all help you run a Matrix server with ease. Be advised that etke.cc operates on a subscription-based approach and there is no "just set up my server once and be done with it" option.

🚀 Getting started

We have detailed documentation in the docs/ directory - see the Table of Contents in the documentation README.

While the list of supported services and documentation is very extensive, you don't need to read through everything. We recommend:

  • Starting with the basics. You can always add/remove or tweak services later on.

  • Following our installation guide. There are two guides available for beginners and advanced users:

    • Quick start (for beginners): this is recommended for those who do not have an existing Matrix server and want to start quickly with "opinionated defaults".

    • Full installation guide (for advanced users): if you need to import an existing Matrix server's data into the new server or want to learn more while setting up the server, follow this guide by starting with the Prerequisites documentation page.

If you experience an issue on configuring the playbook, setting up your server, maintaining services on it, etc., please take a look at our FAQ. If you cannot find an answer to your question, feel free to ask for help and support.

✔ 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.

Notes:

  • 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.

  • Deprecated or unmaintained services are not listed. You can find documentations for them here.

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 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 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 Default Matrix web client, configured to connect to your own Synapse server Link
Hydrogen Lightweight Matrix client with legacy and mobile browser support Link
Cinny Simple, elegant and secure web client Link
SchildiChat Web Based on Element Web, with a more traditional instant messaging experience 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
Let's Encrypt Free SSL certificate, which secures the connection to all components Link
Exim Mail server, through which all Matrix services send outgoing email (can be configured to relay through another SMTP server) Link
ma1sd Matrix Identity Server Link
ddclient Dynamic DNS Link

Authentication

Extend and modify how users are authenticated on your homeserver.

Name Default? Description Documentation
matrix-synapse-rest-auth (advanced) REST authentication password provider module Link
matrix-synapse-shared-secret-auth (advanced) Password provider module Link
matrix-synapse-ldap3 (advanced) LDAP Auth password provider module Link
matrix-ldap-registration-proxy (advanced) A proxy that handles Matrix registration requests and forwards them to LDAP. Link
matrix-registration A simple python application to have a token based Matrix registration Link
Matrix User Verification Service (UVS) Service to verify details of a user based on an Open ID token Link
synapse-simple-antispam (advanced) A spam checker module Link

File Storage

Use alternative file storage to the default media_store folder.

Name Default? Description Documentation
Goofys Amazon S3 (or other S3-compatible object store) storage for Synapse's content repository (media_store) files Link
synapse-s3-storage-provider Amazon S3 (or other S3-compatible object store) storage for Synapse's content repository (media_store) files Link
matrix-media-repo matrix-media-repo is a highly customizable multi-domain media repository for Matrix. Intended for medium to large deployments, this media repo de-duplicates media while being fully compliant with the specification. Link

Bridges

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

Name Default? Description Documentation
mautrix-discord Bridge to Discord Link
mautrix-slack Bridge to Slack Link
mautrix-telegram Bridge to Telegram Link
mautrix-gmessages Bridge to Google Messages Link
mautrix-whatsapp Bridge to WhatsApp Link
mautrix-wsproxy Bridge to Android SMS or Apple iMessage Link
mautrix-twitter Bridge to Twitter Link
mautrix-googlechat Bridge to Google Chat Link
mautrix-meta Bridge to Messenger and Instagram Link for Messenger / Instagram
mautrix-signal Bridge to Signal Link
beeper-linkedin Bridge to LinkedIn Link
matrix-appservice-irc Bridge to IRC Link
matrix-appservice-kakaotalk Bridge to Kakaotalk Link
matrix-appservice-discord Bridge to Discord Link
matrix-appservice-slack Bridge to Slack Link
matrix-hookshot Bridge for generic webhooks and multiple project management services, such as GitHub, GitLab, Figma, and Jira in particular Link
matrix-sms-bridge Bridge to SMS Link
matrix-wechat Bridge to WeChat Link
Heisenbridge Bouncer-style bridge to IRC Link
go-skype-bridge Bridge to Skype Link
mx-puppet-slack Bridge to Slack Link
mx-puppet-instagram Bridge for Instagram-DMs (Instagram) Link
mx-puppet-twitter Bridge for Twitter-DMs (Twitter) Link
mx-puppet-discord Bridge to Discord Link
mx-puppet-groupme Bridge to GroupMe Link
mx-puppet-steam Bridge to Steam Link
Email2Matrix Bridge for relaying emails to Matrix rooms Link
Postmoogle Email to Matrix bridge Link

Bots

Bots provide various additional functionality to your installation.

Name Default? Description Documentation
baibot A bot that exposes the power of AI / Large Language Models to you Link
matrix-reminder-bot Bot for scheduling one-off & recurring reminders and alarms Link
matrix-registration-bot Bot for invitations by creating and managing registration tokens Link
maubot A plugin-based Matrix bot system Link
Honoroit A helpdesk bot Link
Mjolnir A moderation tool for Matrix Link
Draupnir A moderation tool for Matrix (Fork of Mjolnir) Link (for appservice mode)
Buscarron Web forms (HTTP POST) to Matrix Link

Administration

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

Name Default? Description Documentation
matrix-alertmanager-receiver Prometheus' Alertmanager client Link
Matrix Authentication Service OAuth 2.0 and OpenID Provider server Link
synapse-admin A web UI tool for administrating users and rooms on your Matrix server Link
Metrics and Graphs Consists of the Prometheus time-series database server, the Prometheus node-exporter host metrics exporter, and the Grafana web UI, with prometheus-nginxlog-exporter being available too Link (for prometheus-nginxlog-exporter)
Borg Backups Link
rageshake Bug report server Link
synapse-usage-exporter Export the usage statistics of a Synapse homeserver to be scraped by Prometheus. Link

Misc

Various services that don't fit any other categories.

Name Default? Description Documentation
sliding-sync (Superseded by Simplified Sliding Sync integrated into Synapse > 1.114 and Conduit > 0.6.0) Sliding Sync support for clients which require it (e.g. old Element X versions before Simplified Sliding Sync was developed) Link
synapse_auto_accept_invite A Synapse module to automatically accept invites. Link
synapse_auto_compressor A cli tool that automatically compresses state_groups database table in background. Link
Matrix Corporal (advanced) Reconciliator and gateway for a managed Matrix server Link
Etherpad An open source collaborative text editor Link
Jitsi An open source video-conferencing platform Link
Cactus Comments A federated comment system built on Matrix Link
Pantalaimon An E2EE aware proxy daemon Link
Sygnal Push gateway Link
ntfy Push notifications server Link

🆕 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

You may also be interested in mash-playbook - another Ansible playbook for self-hosting non-Matrix services (see its List of supported services).

mash-playbook also makes use of Traefik as its reverse-proxy, so with minor interoperability adjustments, you can make matrix-docker-ansible-deploy and mash-playbook co-exist and host Matrix and non-Matrix services on the same server.