jowj/matrix-docker-ansible-deploy
1
0
Fork 0
forked from mirrors/matrix-docker-ansible-deploy
Code Issues Pull Requests Releases Wiki Activity
17e7bae2cc
matrix-docker-ansible-deploy/docs/prerequisites.md
Christian Wolf 1b87dbf54b Added documentation to README file
2020-03-28 17:33:51 +01:00

2.7 KiB
Raw Blame History

Prerequisites

  • An x86 server running CentOS (7 only for now; 8 is not yet supported), Debian (9/Stretch+), Ubuntu (16.04+), or Archlinux. This playbook doesn't support running on ARM (see), however a minimal subset of the tools can be built on the host, which may result in a working configuration, even on a Raspberry pi (see Self-Building). We only strive to support released stable versions of distributions, not betas or pre-releases. This playbook can take over your whole server or co-exist with other services that you have there.

  • root access to your server (or a user capable of elevating to root via sudo).

  • Python being installed on the server. Most distributions install Python by default, but some don't (e.g. Ubuntu 18.04) and require manual installation (something like apt-get install python).

  • a cron-like tool installed on the server such as cron or anacron to automatically schedule the Let's Encrypt SSL certificates's renewal. This can be ignored if you use your own SSL certificates.

  • the Ansible program being installed on your own computer. It's used to run this playbook and configures your server for you. Take a look at our guide about Ansible for more information, as well as version requirements and alternative ways to run Ansible.

  • either the dig tool or python-dns installed on your own computer. Used later on, by the playbook's services check feature.

  • an HTTPS-capable web server at the base domain name (<your-domain>) which is capable of serving static files. Unless you decide to Serve the base domain from the Matrix server or alternatively, to use DNS SRV records for Server Delegation.

  • properly configured DNS records for <your-domain> (details in Configuring DNS)

  • some TCP/UDP ports open. This playbook configures the server's internal firewall for you. In most cases, you don't need to do anything special. But if your server is running behind another firewall, you'd need to open these ports: 80/tcp (HTTP webserver), 443/tcp (HTTPS webserver), 3478/tcp (TURN over TCP), 3478/udp (TURN over UDP), 5349/tcp (TURN over TCP), 5349/udp (TURN over UDP), 8448/tcp (Matrix Federation API HTTPS webserver), the range 49152-49172/udp (TURN over UDP).

When ready to proceed, continue with Configuring DNS.