Repository files navigation

ThisAnsible playbook is meant to help you run your ownMatrix homeserver, along with thevarious 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 (seeprerequisites).

We run allsupported services inDocker containers (seethe container images we use), which lets us have a predictable and up-to-date setup, across multiple supported distros (seeprerequisites) andarchitectures (x86/amd64 being recommended).

Installation (upgrades) and some maintenance tasks are automated usingAnsible (seeour Ansible guide).

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

If you like theFOSS spirit of this Ansible playbook, but prefer to put the responsibility on someone else, you can alsoget a managed Matrix server from etke.cc (both hosting and on-premises) - a service built on top of this Ansible playbook but withadditional components andservices 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.

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

While thelist 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 thePrerequisites 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 ourFAQ. If you cannot find an answer to your question, feel free to ask forhelp and support.

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

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

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

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

Extend and modify how users are authenticated on your homeserver.

Use alternative file storage to the defaultmedia_store folder.

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

Bots provide various additional functionality to your installation.

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

Various services that don't fit any other categories.

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

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

• Matrix room:#matrix-docker-ansible-deploy:devture.com

• IRC channel:#matrix-docker-ansible-deploy on theLibera Chat IRC network (irc.libera.chat:6697)

• GitHub issues:spantaleev/matrix-docker-ansible-deploy/issues

See thei18n/README.md file for more information about translation.

Translations are still work in progress.

You may also be interested inmash-playbook - another Ansible playbook for self-hosting non-Matrix services (see itsList of supported services).

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