You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Slavi Pantaleev a8e9f35708
Touch up documentation a bit
4 years ago
.github Create FUNDING.yml 4 years ago
docs Touch up documentation a bit 4 years ago
examples Clarify hosts file wording 4 years ago
group_vars Add variable for extra domains to get LE certs for 4 years ago
inventory Rename script file 5 years ago
roles Touch up documentation a bit 4 years ago
.editorconfig Add comment about trailing whitespace in Markdown 6 years ago
.gitignore Adding '.python-version' to .gitignore 4 years ago
CHANGELOG.md Update docs and changelog 4 years ago
LICENSE Add LICENSE file 6 years ago
README.md Merge pull request #804 from pushytoxin/matrix-etherpad 4 years ago
ansible.cfg Move pipelining option to proper section 5 years ago
setup.yml Etherpad role 4 years ago

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