lar.ven – this.ven's wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Synapse ======

The server reference implementation for the [[services/matrix|Matrix]] protocol is [[https://github.com/matrix-org/synapse|Synapse]]. It's a [[https://spec.matrix.org/latest/server-server-api|federated]] homeserver developed by the [[https://matrix.org/foundation|Matrix foundation]], a non-profit organisation, and has a stable and full-featured maturity. The latter makes it quite resource-intensive. If you plan to use Matrix on a [[wp>Raspberry_Pi|Raspberry Pi]], for example, consider a more lightweight solution like [[https://github.com/matrix-org/dendrite|Dendrite]]. The source code of Synapse is written in [[wp>Twisted_(software)|Python3/Twisted]] and can be found at [[https://github.com/matrix-org/synapse|GitHub]].

===== Basic setup =====

For instructions on how to install and setup Synapse consult [[https://matrix.org/docs/guides/installing-synapse|Installing Synapse article]] and the [[https://lab.uberspace.de/guide_synapse|Synapse — UberLab 7 documentation]]. Use [[https://federationtester.matrix.org/|federation tester]] to check your Synapse instance.

> Remark: When you want Synapse to run at a subdomain like matrix.example.org it's convenient to use [[https://github.com/matrix-org/synapse/blob/master/docs/delegate.md|delegation]] for [[/services/matrix#matrix_id_mxid|Matrix IDs (MXID)]] without subdomain part. Thus a MXID is ''user:example.org'' instead of ''user:matrix.example.org''.

==== Delegation ====

Specify example.org as ''server_name'' at the beginning of the configuration file, but set ''public_baseurl'' to matrix.example.org:

<code yaml>server_name: "example.org"
...
public_baseurl: https://matrix.example.org/</code>

For .well-known announcement you need to create ''.well-known/matrix/server'' in [[https://www.php.net/manual/en/reserved.variables.server.php|DOCUMENT_ROOT]] of example.org containing:

<code yaml server>{
    "m.server": "matrix.example.org:<port>"
}</code>

Change ''<port>'' to your needs, typically 443.

> **Note:** If you're running [[services/nextcloud|Nextcloud]] in the DOCUMENT_ROOT, its ''.htaccess'' file needs to be edited to force a [[#nextcloud_redirects|redirect]].

===== Privacy =====

The default configuration of Synapse isn't aligned to be extremely privacy respecting as researched by [[https://github.com/libremonde-org/paper-research-privacy-matrix.org/tree/master/part1|Libre Monde ASBL]], but there are means to change that behavior and opt-out of statistics, metrics, for example.

==== Metrics and stats ====

Opt-out of metrics and statistics data collection by using the following configuration settings:

<code yaml>enable_metrics: false
report_stats: false</code>

==== Push ====

When using Push notifications message content isn't encrypted. For this reason edit main configuration file again, find ''push'' section and disable content inclusion as follows:

<code yaml>  include_content: false</code>

==== Profile data ====

If you don't want profile information to be visible to the public and shared in rooms you are invited to **before** you joined them, use these settings:

<code yaml>require_auth_for_profile_requests: true
limit_profile_requests_to_users_who_share_rooms: true
include_profile_data_on_invite: false</code>

===== Encryption by default =====

By default encryption in rooms is optional. To activate encryption for all rooms by default set:

<code yaml>encryption_enabled_by_default_for_room_type: all</code>

> **Note:** If you consider [[services/matrix/synapse/bridging|bridging]] or building a community, this setting might be sub-optimal, as bridges may not support encryption and new users joining a room won't have access to the message history.

===== Minimize logging =====

Synapse log configuration file is typically named after the server name with suffix .log.config appended. To minimize logging, change both ''level'' parameters in ''synapse.storage.SQL'' subsection below ''loggers'' as well as in ''root'' section to only log critical errors:

<code yaml>loggers:
    synapse.storage.SQL:
        level: CRITICAL
    ...
root:
    level: CRITICAL</code>
    
===== Known issues =====

FIXME This section is about issues related to interaction with other [[/services|services]] and tries to offer some **quick and dirty** solutions to keep it running rather than implementing secure and clean code.

==== Nextcloud redirects ====

When using [[#delegation|delegation]] and running [[services/nextcloud|Nextcloud]] at the top-level domain, URL rewriting redirects all traffic for documents in ''/.well-known'' to Nextcloud. A solution is to add the following [[https://cwiki.apache.org/confluence/display/HTTPD/RewriteCond|rewrite condition]] into the ''.htaccess'' file in both sections before [[https://cwiki.apache.org/confluence/display/HTTPD/RewriteRule|rewrite rules]]:

<code apache>
RewriteCond %{REQUEST_URI} !^/\.well-known/matrix/server
</code>

{{tag>communication communities federation matrix messaging server }}

Category: [[./|Matrix]]
lar.ven – this.ven's wiki

User Tools

Site Tools

Page Tools
