titanz
/
matrix-docker-ansible-deploy
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
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.
995 Commits
2 Branches
0 Tags
12 MiB
 
 
 
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'b75e64258d'
${ noResults }
Go to file
Slavi Pantaleev b75e64258d
Merge pull request #307 from thedanbob/certbot-0.40.1 		5 years ago
docs Simplify Prerequisites a bit 5 years ago
examples Listen 8448 required for apache 5 years ago
group_vars Merge branch 'master' into master 5 years ago
inventory Fix README instructions typo about Ansible host_vars 7 years ago
roles Update certbot (0.38.0 -> 0.40.1) 5 years ago
.editorconfig Add comment about trailing whitespace in Markdown 6 years ago
.gitignore Initial commit 7 years ago
CHANGELOG.md Do not expose server room directory by default 5 years ago
LICENSE Add LICENSE file 6 years ago
README.md Update README 5 years ago
ansible.cfg Move pipelining option to proper section 5 years ago
setup.yml Merge branch 'master' into master 5 years ago

README.md

Matrix (An open network for secure, decentralized communication) server setup using Ansible and Docker

Purpose

This Ansible playbook is meant to easily let you run your own Matrix homeserver.

That is, it lets you join the Matrix network with your own @<username>:<your-domain> identifier, all hosted on your own server.

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.

What's different about this Ansible playbook?

This is similar to the EMnify/matrix-synapse-auto-deploy Ansible deployment, but:

  • this one is a complete Ansible playbook (instead of just a role), so it's easier to run - especially for folks not familiar with Ansible

  • this one installs and hooks together a lot more Matrix-related services for you (see above)

  • this one can be re-ran many times without causing trouble

  • works on both CentOS (7.0+) and Debian-based distributions (Debian 9/Stretch+, Ubuntu 16.04+)

  • this one installs everything in a single directory (/matrix by default) and doesn't "contaminate" your server with files all over the place

  • this one doesn't necessarily take over ports 80 and 443. By default, it sets up nginx for you there, but you can also use your own webserver

  • this one runs everything in Docker containers, so it's likely more predictable and less fragile (see Docker images used by this playbook)

  • this one retrieves and automatically renews free Let's Encrypt SSL certificates for you

  • this one optionally can store the media_store content repository files on Amazon S3 (but defaults to storing files on the server's filesystem)

  • this one optionally allows you to use an external PostgreSQL server for Synapse's database (but defaults to running one in a container)

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.

Docker images used by this playbook

This playbook sets up your server using the following Docker images:

Deficiencies

This Ansible playbook can be improved in the following ways:

  • setting up automatic backups to one or more storage providers

Support