Synapse homeserver package

[matrix] Synapse homeserver

This package installs Synapse, an open-source Matrix homeserver written and maintained by the Matrix.org Foundation.

At installation time you have to configure the server name, because it cannot be changed later.

The homeserver config file is installed at /var/packages/matrix-synapse/var/homeserver.yaml on your diskstation. For further configuration you have to ssh into your device and edit this file with a privileged user.
After the configuration is modified, you have to restart the service, either by stop and start the package in the DSM package center or on the command line with sudo synopkg restart matrix-synapse.

For all configuration details please visit Configuring Synapse.

The installation wizard offers two options at installation time

1. Report usage statistics

This sets the option: report_stats: true|false

For what's reported see Reporting Homeserver Usage Statistics.

2. Open private ports

Default (disabled) will configure a listener with bind_addresses:

listeners:
  - port: 8008
    tls: false
    type: http
    x_forwarded: true
    bind_addresses: ['::1', '127.0.0.1']
    resources:
      - names: [client, federation]
        compress: false

If you check Open private ports, the configuration will be created with --open-private-ports. This will create the listener on port 8008 as above, but without bind_addresses to listen on all local interfaces. Do not enable this, unless you know what you are doing.

Most often you will disable Open private ports and add the ip of your device to the bind_addresses manually. This is a common use case with a Reverse Proxy.

Add a new user

To add a user you need to ssh into your device and execute the following command:

/var/packages/matrix-synapse/target/env/bin/register_new_matrix_user -c /var/packages/matrix-synapse/var/homeserver.yaml http://localhost:8008

This will prompt to add a new user:

New user localpart [root]: demo_user
Password:
Confirm password:
Make admin [no]: no
Sending registration request...
Success!