Matrix Synapse installieren

Diese Anleitung beschreibt, wie man den Matrix-Homeserver Synapse auf der Managed Hosting Plattform von Hostsharing installieren kann.

Vorbereitungen

Mit Hilfe von HSAdmin wird angelegt:

1. Ein User als Service-User mit /bin/bash als Shell, zum Beispiel Beispiel: xyz00-matrix
2. Eine Domain mit xyz00-matrix als Domain-Administrator, zum Beispiel matrix.beispiel.de
3. Einen Postgresql-User xyz00_matrixuser mit Passwort meinPasswort
4. Eine Postgresql-Datenbank xyz00_matrixdb mit Datenbank-Owner xyz00_matrixuser

Verwendete IP-Ports der Server-Dienste:

1. Monit: localhost:32800
2. Synapse: localhost:32801

Installation von Synapse

Installationsanleitung basierend auf https://github.com/matrix-org/synapse/blob/master/INSTALL.md#installing-from-source

Als User xyz00-matrix" ein Python3 virtualenv erstellen

   mkdir -p ~/synapse
   virtualenv -p python3 ~/synapse/env
   source ~/synapse/env/bin/activate
   pip install --upgrade pip
   pip install --upgrade setuptools

Synapse an sich installieren

   pip install matrix-synapse

Jinja2 und Postgres-Python-Bindings installieren

   pip install jinja2 psycopg2

Initiale Konfiguration generieren, im laufenden Betrieb keine Statistiken an Matrix.org senden

   cd ~/synapse
   python -m synapse.app.homeserver --server-name matrix.beispiel.de --config-path homeserver.yaml --generate-config --report-stats=no

== Konfiguration von Synapse

In die initial generierte Konfiguration muss noch die Port- und Datenbank-Konfiguration eingetragen werden:

Port: Innerhalb der listener-section den Port 8008 auf 32801 (wie initial definiert) ändern, alles andere beibehalten:

     - port: 32801
       tls: false
       bind_addresses: ['::1', '127.0.0.1']
       type: http
       x_forwarded: true

Postgres-Datenbank:

   database:
     # The database engine name
     name: "psycopg2"
     # Arguments to pass to the engine
     args:
       host: "localhost"
       database: "xyz00_matrixdb"
       user: "xyz00_matrixuser"
       password: "meinPasswort"
       cp_min: 5
       cp_max: 10

Starten der Dienste

Zum Start aller notwendigen Dienste wird in dieser Anleitung monit benutzt. Hier ein Beispiel für eine Datei .monitrc (überlange Zeilen werden hier im Wiki umgebrochen)

Das monitpassword auf jeden Fall durch ein sicheres Passwort ersetzen:

   set daemon 60
       with start delay 120
   set logfile /home/pacs/xyz00/users/matrix/monit/var/monit.log
   set idfile /home/pacs/xyz00/users/matrix/monit/var/monit.id
   set statefile /home/pacs/xyz00/users/matrix/monit/var/monit.state
   set mailserver localhost
   set mail-format { from: monit@matrix.beispiel.de }
   set alert matrix@matrix.beispiel.de
   set httpd port 32800 address xyz00.hostsharing.net 
       allow matrix:monitpassword
   check process synapse with pidfile /home/pacs/xyz00/users/matrix/synapse/homeserver.pid
       start program "/bin/bash -c 'export VIRTUAL_ENV=$HOME/synapse/env && export PATH=$VIRTUAL_ENV/bin:$PATH && cd $HOME/synapse && synctl start'"
       stop program "/bin/bash -c '/bin/kill $( cat $HOME/synapse/homeserver.pid )'"

Cronjobs

Cron wird für eine Aufgabe genutzt:

• Start von monit nach einem Server Reboot

Einrichten der crontab mit cronttab -e

HOME=/home/pacs/xyz00/users/matrix
MAILTO=matrix@matrix.beispiel.de

@reboot /usr/bin/monit -c $HOME/.monitrc

Einrichten des Apache VHost

Die ~/doms/matrix.beispiel.de/.htaccess mit dem Editor der Wahl öffnen und folgende Konfiguration einfügen:

DirectoryIndex disabled
RewriteEngine On
RewriteBase /
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-l
RewriteRule .* http://localhost:32801%{REQUEST_URI} [NE,proxy]
RequestHeader set X-Forwarded-Proto "https"

Update von Synapse

source ~/synapse/env/bin/activate
pip install -U matrix-synapse
monit restart synapse

TODO

• riot-web?
• SimpleSAML mit Wordpress-Userdb
• Synapse mit pysaml gegen SimpleSAML