Synapse

This article has been flagged for not conforming to the wiki guidelines (Should follow software blueprint; second party wording; don't use syntaxhighlight, use templates instead; missing lead-in sentences). Please help out, if possible.

Resources

Package information

This article has some todo items:

• Correct handling of TLS certificates

Synapse is the reference implementation of Matrix homeserver.

Installation

USE flags

USE flags for net-im/synapse Reference implementation of Matrix homeserver

debug	Enable extra debug codepaths, like asserts and extra output. If you want to get meaningful backtraces see https://wiki.gentoo.org/wiki/Project:Quality_Assurance/Backtraces
postgres	Add support for the postgresql database
systemd	Enable use of systemd-specific libraries and features like socket activation or session tracking
test	Enable dependencies and/or preparations necessary to run tests (usually controlled by FEATURES=test but can be toggled independently)

Data provided by the Gentoo Package Database · Last update: 2023-09-26 20:44 More information about USE flags

Emerge

root #emerge --ask net-im/synapse

Additional software

root #emerge --ask net-im/coturn

Configuration

Synapse will not work using an IP address, so even with a static IP it's necessary to have a valid internet hostname. DynuDNS https://www.dynu.com/en-US/ is free, but any valid name will work. Changing the server name is not straightforward once Synapse is installed.

Once a valid hostname has been obtained.

Initial Configuration

As root, the --server-name entry must be changed to the actual domain name:

root #cd /var/lib/synapse

root #sudo -u synapse python -m synapse.app.homeserver --server-name my.domain.name --config-path /etc/synapse/homeserver.yaml --generate-config --report-stats=yes

Service

root #rc-service synapse start

Or the corresponding systemd command.

Check Synapse is actually running

user $ps aux|grep synapse

Synapse can fail to start without showing an error message. If so check the /etc/synapse/homeserver.yaml config file.

Add users

Once Synapse is set up with TLS and TURN trying to add a user gives Python errors; commenting out all TLS and TURN entries and setting tlsːfalse in /etc/synapse/homeserver.yaml then restarting synapse will allow users to be added; then the homeserver.yaml file can then be restored and synapse restarted again.

user $register_new_matrix_user -c /etc/synapse/homeserver.yaml http://127.0.0.1:8008

Install Let's Encrypt / Certbot

Instructions are hereː Let's Encrypt

The reverse proxy is probably best set up after Synapse is up and running. These steps assume one has not been set up.

The certificates as installed do not have read permissions required for Synapse, and require copying and permissions changing. Edits are welcome for a better way of handling this, that has been fully tested and works with voice and video calls over different networks. Modifications to the synapse group and symlinking (or directly specifying the certificate locations in homeserver.yaml) may be a start, but the privkey1.pem is set 0600 and owned by root. Using a unique domain name and cert for synapse, and different domain name and certs for other applications may improve security:

root #/bin/cp /etc/letsencrypt/archive/your.domain.name/fullchain1.pem /etc/synapse/your.domain.name.tls.crt

root #/bin/cp /etc/letsencrypt/archive/your.domain.name/privkey1.pem /etc/synapse/your.domain.name.tls.key

root #/bin/chown synapse:synapse /etc/synapse/your.domain.name.tls.*

root #/bin/chmod 640 /etc/synapse/your.domain.name.tls.key

root #/bin/chmod 644 /etc/synapse/your.domain.name.tls.crt

Configuration

Generate secret key:

user $openssl rand -hex 16

Edit /etc/turnserver.conf:

FILE /etc/turnserver.conf

listening-port=3478
fingerprint
use-auth-secret
static-auth-secret=The32HexCharacterKeyGeneratedAbove
realm=your.domain.name
bps-capacity=0
stale-nonce=600
no-multicast-peers

An example config file is at /etc/turnserver.conf.default Edit /etc/synapse/homeserver.yaml with your domain name and keys. To add new users after TLS has been set up disable TLS and TURN as comments. It may not be neccessary to change all the lines noted:

FILE /etc/synapse/homeserver.yaml

# Configuration file for Synapse.
#
# This is a YAML file: see [1] for a quick introduction. Note in particular
# that *indentation is important*: all the elements of a list or dictionary
# should have the same indentation.
#
# [1] https://docs.ansible.com/ansible/latest/reference_appendices/YAMLSyntax.html
#
# For more information on how to configure Synapse, including a complete accounting of
# each option, go to docs/usage/configuration/config_documentation.md or
# https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html
server_name: "your.domain.name"
pid_file: /var/lib/synapse/homeserver.pid
listeners:
  - port: 8008
#CHANGE TO tls:false TO ADD NEW USER
    tls: true
    type: http
    x_forwarded: true
# Bind to the server IP address the modem will port forward to 
    bind_addresses: ['192.168.x.xxx']
    resources:
      - names: [client, federation]
        compress: false
database:
  name: sqlite3
  args:
    database: /var/lib/synapse/homeserver.db
log_config: "/etc/synapse/your.domain.name.log.config"
media_store_path: /var/lib/synapse/media_store
registration_shared_secret: "0Q&*NQ74K0qq*V:zK:7dEKnEHMTjdavK3y:K@.bf^ljhH*BHw&"
report_stats: true
macaroon_secret_key: "Default entry will work"
form_secret: "ODk^^*yaABCDEFGHpXqw7_lndv2LA6hR0fyxiqWpz+dVBOk~"
signing_key_path: "/etc/synapse/your.domain.name.signing.key"
trusted_key_servers:
# CHANGE TO   - server_name: "matrix.org" TO ADD NEW USER
  - server_name: "your.doamin.name"
# COMMENT ALL TLS AND TURN OUT TO ADD NEW USER
tls_private_key_path: "/etc/synapse/your.domain.name.tls.key"
tls_certificate_path: "/etc/synapse/your.domain.name.tls.crt"
turn_uris: [ "turn:your.domain.name?transport=udp", "turn:your.domain.name?transport=tcp" ]
turn_shared_secret: "SharedSecretInEtcTurnserver.conf"
turn_user_lifetime: 86400000
turn_allow_guests: true

# vim:ft=yaml

Set modem port forwarding

The following ports need to be forwarded to the serverː

UDP 49152 to 65535

TCP 8008

UDP/TCP 3478

UDP/TCP 5349

TCP 8448

Restart Synapse:

root #rc-service synapse restart

Start TURN server:

root #rc-service turnserver restart

Add to default runlevel:

root #rc-update add synapse default

root #rc-update add turnserver default

Client Software

This has been tested with the Element Linux and Android client. Specify the port as ː8008 on logging in.

Troubleshooting

Service will not start

Check the homeserver.yaml and turnserver.conf files for any "your.domain.name" entries which have not been updated to your actual domain name.

Text messaging works, but video and voice calls only work within the same network

This is normally an issue with the TURN server setup.

See Also

User:Maffblaster/Projects/Matrix

External Resources

https://matrix-org.github.io/synapse/latest/welcome_and_overview.html

https://python-docs.synapse.org/build/html/CommandLineClient.html#

https://wiki.archlinux.org/title/Matrix