ansol/matrix-docker-ansible-deploy
7
0
Fork 0
mirror of https://github.com/spantaleev/matrix-docker-ansible-deploy.git synced 2024-11-10 09:30:39 +00:00
Code Issues Projects Releases Wiki Activity
Matrix (An open network for secure, decentralized communication) server setup using Ansible and Docker
2,211 Commits 6 Branches 0 Tags 37 MiB
Jinja 99.4%
Just 0.3%
Shell 0.2%
1cd251ed78
Go to file
Slavi Pantaleev 1cd251ed78 Don't delete Docker images which may have been pulled by another 
Some people run Coturn or Jitsi, etc., by themselves and disable it
in the playbook.

Because the playbook is trying to be nice and clean up after itself,
it was deleting these Docker images.

However, people wish to pull and use them separately and would rather
they don't get deleted.

We could make this configurable for the sake of this special case, but
it's simpler to just avoid deleting these images.
It's not like this "cleaning things up" thing works anyway.
As time goes on, the playbook gets updated with newer image tags
and we leave so many images behind. If one doesn't run
`docker system prune -a` manually once in a while, they'd get swamped
with images anyway. Whether we leave a few images behind due to the lack
of this cleanup now is pretty much irrelevant.
2021-01-23 14:01:31 +02:00
.github Create FUNDING.yml 2020-12-01 15:11:37 +02:00
docs Merge branch 'master' into irc 2021-01-22 20:30:24 +00:00
examples Fix typo 2021-01-22 14:13:56 +02:00
group_vars Merge branch 'master' into irc 2021-01-22 20:30:24 +00:00
inventory Rename script file 2020-04-08 10:05:43 +03:00
roles Don't delete Docker images which may have been pulled by another 2021-01-23 14:01:31 +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 Fix step number 2021-01-23 09:24:08 +02:00
LICENSE
README.md fixed typo 2021-01-22 16:38:27 -08:00
setup.yml Add matrix-aux role to help with managing auxiliary files/directories 2021-01-11 22:32:52 +02: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 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 executed more than once without causing trouble

  • works on various distros: CentOS (7.0+), Debian-based distributions (Debian 9/Stretch+, Ubuntu 16.04+), Archlinux

  • 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)

  • helps you import data from a previous installation (so you can migrate your manual virtualenv/Docker setup to a more managed one)

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