matrix-docker-ansible-deploy

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 user ID like @alice:example.com, 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 continuwuity ❌ Storing your data and managing your presence in the Matrix network. Link Tuwunel ❌ Storing your data and managing your presence in the Matrix network. Tuwunel is the official successor to conduwuit. 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 Sable ❌ Simple, elegant and secure web client Link SchildiChat Web ❌ Based on Element Web, with a more traditional instant messaging experience Link FluffyChat Web ❌ The cutest messenger in Matrix Link Commet ❌ Matrix 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 Traefik ✅ Web server, listening on ports 80, 443 and 8448 - standing in front of all the other services. Using your own webserver is also 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 coturn ❌ STUN/TURN server for WebRTC audio/video calls Link ddclient ❌ Dynamic DNS Link Matrix RTC stack ❌ Supporting components (LiveKit Server and LiveKit JWT Service) for in-app audio/video calls for Matrix clients 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 User Verification Service ❌ Service to verify details of a user based on an Open ID token Link synapse-simple-anti