atb00ker.matrix-synapse

ansible-matrix-synapse

NOTE: This project is no longer maintained. There are better solutions available now, and official Docker images are also offered.

This code will help you install matrix-synapse on your server, obtain certificates from letsencrypt.org for your domain, and set up a cron job to renew these certificates. Additionally, you can install and configure PostgreSQL with matrix-synapse.

How to Run

Install Ansible.
Add your server group in the inventory.
Change the hosts value from all to the specific server group where you want to install matrix-synapse. (Refer to file ansible-matrix-synapse/main.yaml) [optional; based on your needs]
Change the remote_user from root to a user with sudo privileges. (Refer to file ansible-matrix-synapse/main.yaml) [optional; based on your needs]
Ensure you have set the variables you want for the installation. (Refer to file ansible-matrix-synapse/defaults/main.yml)

Required Changes

Variable	Valid Values	Example	Note
hostname	string	hostname: www.MY_AWESOME_WEBSITE.com	Your server's domain where you plan to install the homeserver.
email	string	email: YOUR_AWESOME@EMAIL.ID	This email is needed for using letsencrypt for secure (https) connections.

Advanced Changes

Variable	Valid Values	Example	Note
enableRegistration	true/false	enableRegistration: true	Set to `true` to allow user registrations via clients like riot.im; set `false` otherwise.
reportStats	true/false	reportStats: false	Send anonymous stats to improve matrix code. More info at: `matrix.org`.
nginxConfFile	PATH/TO/FILE	nginxConfFile: nginx.j2	The nginx configuration file to be sent to the server.
synapseCacheFactor	NUMBER	synapseCacheFactor: 0.2	The amount of RAM matrix-synapse can use. read more

PostgreSQL Settings

Variable	Valid Values	Example	Note
portForClient	PORT NUMBER	portForClient: 443	This port will be used on your domain for the homeserver.
postgresEnable	true/false	postgresEnable: true	Set to `true` if you want to use PostgreSQL as your DB management system, or `false` to use SQLite.
postgresConfig	true/false	postgresConfig: true	Set to `true` if you want to set up PostgreSQL on the same server; otherwise set to `false` if you have a different DB server already set up and just want to connect to it.
postgresHost	string	postgresHost: localhost	Host address for your PostgreSQL server.
postgresUser	string	postgresUser: YOUR_AWESOME_USER	The PostgreSQL role/user for your database.
postgresPassword	string	postgresPassword: YOUR_AWESOME_PASSWORD	Password for your role/user.
postgresDatabase	string	postgresDatabase: YOUR_AWESOME_DATABASE	This is the main database for matrix.
postgresConfFile	PATH/TO/FILE	postgresConfFile: database.yml.js	Settings file to enable PostgreSQL.