mirror/matrix-docker-ansible-deploy
1
0
Fork 0
mirror of https://github.com/spantaleev/matrix-docker-ansible-deploy.git synced 2024-11-06 02:37:31 +01:00
Code Issues Packages Projects Releases Wiki Activity
🐳 Matrix (An open network for secure, decentralized communication) server setup using Ansible and Docker
2,309 Commits 6 Branches 0 Tags 29 MiB
Jinja 99.4%
Just 0.3%
Shell 0.2%
87ce12c3eb
Go to file
Slavi Pantaleev 87ce12c3eb Add note about potential breaking change
2021-02-12 14:07:26 +02:00
.github Create FUNDING.yml 2020-12-01 15:11:37 +02:00
docs Announce Prometheus/Grafana 2021-02-12 14:02:53 +02:00
examples Clarify hosts file wording 2021-02-01 03:22:04 -06:00
group_vars Do not auto-expose metrics on matrix.DOMAIN/_synapse/metrics 2021-02-12 13:47:53 +02:00
inventory Rename script file 2020-04-08 10:05:43 +03:00
roles Merge pull request #838 from Peetz0r/stats 2021-02-12 14:03:17 +02: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
ansible.cfg Move pipelining option to proper section 2019-09-01 01:59:41 +02:00
CHANGELOG.md Add note about potential breaking change 2021-02-12 14:07:26 +02:00
LICENSE Add LICENSE file 2018-08-17 09:01:06 +03:00
README.md fix typo from skype to slack 2021-02-08 18:22:59 +01:00
setup.yml Grafana 2021-02-10 22:54:14 +01: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 basic 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