matrix-synapse

ansible-matrix-synapse

NOTE: Unmaintain it, there are better solutions available now and official docker images are available as well.

This code will install matrix-synapse on your server & get an certificates from letsencrypt.org for your domain, and set a cron job to renew the certificates. Optionally, Install and setup postgresSQL with matrix-synapse.

How to run

Install Ansible
Add your server group in the inventory.
Change the hosts from all to the server group in which you want to install matrix-synapse. (In file ansible-matrix-synapse/main.yaml) [optional; as per your Requirements]
Change the remote_user from root to a user which is a sudoer. (In file ansible-matrix-synapse/main.yaml) [optional; as per your Requirements]
Make sure you have set the variables you desire for installation. (In file ansible-matrix-synapse/defaults/main.yml)

Must Change

Variable	Valid Values	Example	Note
hostname	string	hostname: www.MY_AWESOME_WEBSITE.com	The domain of server where you plan to set homeserver
email	string	email: YOUR_AWESOME@EMAIL.ID	Email is required if you plan to use letsencrypt for https (secure) connection

Advanced Changes

Variable	Valid Values	Example	Note
enableRegistration	true/false	enableRegistration: true	Set to `true` if you plan to allow users to register themselves using riot.im like clients, Set `false` otherwise
reportStats	true/false	reportStats: false	Send anonymous stats report to help improve matrix code, for more information visit: `matrix.org`
nginxConfFile	PATH/TO/FILE	nginxConfFile: nginx.j2	This is the nginx configuration file that would be send to the server
synapseCacheFactor	NUMBER	synapseCacheFactor: 0.2	Amount of RAM matrix-synapse is allowed to use, read more

PostgreSQL Settings

Variable	Valid Values	Example	Note
portForClient	PORT NUMBER	portForClient: 443	You'll use this port on your domain for your homeserver
postgresEnable	true/false	postgresEnable: true	Set this `true` if you want to use postgreSQL as your database management system and `false` if you plan to use SQLite
postgresConfig	true/false	postgresConfig: true	Set this `true` if you want to setup postgreSQL on the same server and `false` if you have a different database server already setup and you just want to setup Matrix with the host, user, password and database name of the database server
postgresHost	string	postgresHost: localhost	Host Address for your database Server
postgresUser	string	postgresUser: YOUR_AWESOME_USER	This will be the postgresSQL Role/User of your Database
postgresPassword	string	postgresUser: YOUR_AWESOME_PASSWORD	This will be the Password of your Role/User
postgresDatabase	string	postgresDatabase: YOUR_AWESOME_DATABASE	This will be the main database for matrix
postgresConfFile	PATH/TO/FILE	postgresConfFile: database.yml.js	This is the settings file to enable postgreSQL