pub-solar/matrix-docker-ansible-deploy
5
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity
Matrix (An open network for secure, decentralized communication) server setup using Ansible and Docker https://github.com/spantaleev/matrix-docker-ansible-deploy
4810 commits 2 branches 0 tags 16 MiB
Jinja 99.7%
Shell 0.3%
Find a file
Slavi Pantaleev 5f3f460cda Restore support for appservice and user_dir workers
2022-09-15 10:06:56 +03:00
.config Fix (suppress) var-naming ansible-lint errors 2022-07-18 16:43:12 +03:00
.github Bump frenck/action-yamllint from 1.2.0 to 1.3.0 2022-09-14 17:19:47 +00:00
collections fix: all praise the allmighty yamllinter 2022-02-05 21:32:54 +01:00
docs Add support for stream writer Synapse workers 2022-09-15 08:10:04 +03:00
examples run the playbook on multiple hosts with different credentials (#1980) 2022-07-26 16:34:55 +03:00
group_vars Restore support for appservice and user_dir workers 2022-09-15 10:06:56 +03:00
inventory run the playbook on multiple hosts with different credentials (#1980) 2022-07-26 16:34:55 +03:00
roles Restore support for appservice and user_dir workers 2022-09-15 10:06:56 +03:00
.editorconfig Add comment about trailing whitespace in Markdown 2019-02-01 11:00:25 +02:00
.gitignore Adding '.python-version' to .gitignore 2020-10-06 11:42:32 +02:00
.yamllint fix: ignore generated file on yamllint 2022-02-09 15:03:39 +01:00
ansible.cfg Use the yaml callback plugin when running ansible-playbook 2021-02-18 15:57:05 +01:00
CHANGELOG.md Restore support for appservice and user_dir workers 2022-09-15 10:06:56 +03:00
LICENSE Add LICENSE file 2018-08-17 09:01:06 +03:00
Makefile Add Makefile and lint target 2022-07-18 16:51:33 +03:00
README.md Cactus comments (#2089) 2022-09-09 14:37:52 +03:00
setup.yml Cactus comments (#2089) 2022-09-09 14:37:52 +03: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).

Supported services

Using this playbook, you can get the following 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 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.

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

Services by the community

  • 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