finallycoffee/matrix-docker-ansible-deploy
finallycoffee/matrix-docker-ansible-deploy
5
1
Fork 0
Code Issues Pull Requests Releases Wiki Activity
Upstream: https://github.com/spantaleev/matrix-docker-ansible-deploy Used for deploying https://matrix.finallycoffee.eu/
1,053 Commits 3 Branches 0 Tags 171 MiB
Jinja 99.3%
Just 0.3%
Shell 0.3%
89910bd0d1
Go to file
Slavi Pantaleev 89910bd0d1
Merge pull request #335 from hannojg/patch-1 
Notes when not using a ssh key for authentication
2020-01-03 17:00:19 +02:00
docs Fix typo 2020-01-03 17:00:11 +02:00
examples Fix Caddy example config for Dimension 2019-12-05 17:33:08 -06:00
group_vars Don't make it Dimension specific 2019-12-09 22:23:56 -06:00
inventory Fix README instructions typo about Ansible host_vars 2018-01-17 15:57:01 +02:00
roles Update synapse (1.7.2 -> 1.7.3) 2019-12-31 06:28:58 -06:00
.editorconfig Add comment about trailing whitespace in Markdown 2019-02-01 11:00:25 +02:00
.gitignore Initial commit 2017-07-31 23:08:20 +03:00
ansible.cfg Move pipelining option to proper section 2019-09-01 01:59:41 +02:00
CHANGELOG.md Add support to matrix-nginx-proxy to work in HTTP-only mode 2019-12-06 11:53:15 +02:00
LICENSE Add LICENSE file 2018-08-17 09:01:06 +03:00
README.md Update README 2019-11-29 10:16:05 +02:00
setup.yml Merge branch 'master' into master 2019-08-21 07:34:20 +03:00

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