nixos-config/services/matrix.nix

331 lines
9.8 KiB
Nix

# Matrix homeserver setup, using different endpoints for federation and client
# traffic. The main trick for this is defining two nginx servers endpoints for
# matrix.domain.com, each listening on different ports.
#
# Configuration inspired by :
#
# - https://github.com/delroth/infra.delroth.net/blob/master/roles/matrix-synapse.nix
# - https://nixos.org/manual/nixos/stable/index.html#module-services-matrix
#
{ config, lib, pkgs, ... }:
with lib;
let
cfg = config.my.services.matrix;
my = config.my;
federationPort = { public = 8448; private = 11338; };
clientPort = { public = 443; private = 11339; };
domain = config.networking.domain;
in {
options.my.services.matrix = {
enable = lib.mkEnableOption "Matrix Synapse";
registration_shared_secret = lib.mkOption {
type = types.str;
default = null;
example = "deadbeef";
description = "Shared secret to register users";
};
emailConfig = mkOption {
type = types.submodule {
options = {
smtpHost = mkOption {
type = types.str;
default = "localhost";
};
smtpPort = mkOption {
type = types.port;
default = 587;
description = ''
The port to use to connect to the SMTP host.
Defaulting to STARTTLS port 587 because TLS port 465 isn't supported by synapse
See https://github.com/matrix-org/synapse/issues/8046
'';
};
smtpUser = mkOption {
type = types.str;
};
smtpPass = mkOption {
type = types.str;
};
notifFrom = mkOption {
type = types.str;
example = "Your Friendly %(app)s homeserver <noreply@example.com>";
};
};
};
};
};
config = lib.mkIf cfg.enable {
services.postgresql = {
enable = true;
};
services.postgresqlBackup = {
databases = [ "matrix-synapse" ];
};
services.matrix-synapse = {
enable = true;
server_name = domain;
public_baseurl = "https://matrix.${domain}";
registration_shared_secret = cfg.registration_shared_secret;
listeners = [
# Federation
{
bind_address = "::1";
port = federationPort.private;
tls = false; # Terminated by nginx.
x_forwarded = true;
resources = [ { names = [ "federation" ]; compress = false; } ];
}
# Client
{
bind_address = "::1";
port = clientPort.private;
tls = false; # Terminated by nginx.
x_forwarded = true;
resources = [ { names = [ "client" ]; compress = false; } ];
}
];
account_threepid_delegates.msisdn = "https://vector.im";
extraConfig = ''
experimental_features: { spaces_enabled: true }
use_presence: false
email:
# The hostname of the outgoing SMTP server to use. Defaults to 'localhost'.
#
smtp_host: "${cfg.emailConfig.smtpHost}"
# The port on the mail server for outgoing SMTP. Defaults to 25.
#
smtp_port: ${toString cfg.emailConfig.smtpPort}
# Username/password for authentication to the SMTP server. By default, no
# authentication is attempted.
#
smtp_user: "${cfg.emailConfig.smtpUser}"
smtp_pass: "${cfg.emailConfig.smtpPass}"
# Uncomment the following to require TLS transport security for SMTP.
# By default, Synapse will connect over plain text, and will then switch to
# TLS via STARTTLS *if the SMTP server supports it*. If this option is set,
# Synapse will refuse to connect unless the server supports STARTTLS.
#
require_transport_security: true
# notif_from defines the "From" address to use when sending emails.
# It must be set if email sending is enabled.
#
# The placeholder '%(app)s' will be replaced by the application name,
# which is normally 'app_name' (below), but may be overridden by the
# Matrix client application.
#
# Note that the placeholder must be written '%(app)s', including the
# trailing 's'.
#
notif_from: "${cfg.emailConfig.notifFrom}"
'';
logConfig = ''
version: 1
# In systemd's journal, loglevel is implicitly stored, so let's omit it
# from the message text.
formatters:
journal_fmt:
format: '%(name)s: [%(request)s] %(message)s'
filters:
context:
(): synapse.util.logcontext.LoggingContextFilter
request: ""
handlers:
journal:
class: systemd.journal.JournalHandler
formatter: journal_fmt
filters: [context]
SYSLOG_IDENTIFIER: synapse
root:
level: WARN
handlers: [journal]
disable_existing_loggers: False
'';
};
services.nginx = {
virtualHosts = {
"matrix.${domain}" = {
forceSSL = true;
enableACME = true;
locations =
let
proxyToClientPort = {
proxyPass = "http://[::1]:${toString clientPort.private}";
};
in {
# Or do a redirect instead of the 404, or whatever is appropriate
# for you. But do not put a Matrix Web client here! See the
# Element web section below.
"/".return = "404";
"/_matrix" = proxyToClientPort;
"/_synapse/client" = proxyToClientPort;
};
listen = [
{ addr = "0.0.0.0"; port = clientPort.public; ssl = true; }
{ addr = "[::]"; port = clientPort.public; ssl = true; }
];
};
# same as above, but listening on the federation port
"matrix.${domain}_federation" = rec {
forceSSL = true;
serverName = "matrix.${domain}";
useACMEHost = serverName;
locations."/".return = "404";
locations."/_matrix" = {
proxyPass = "http://[::1]:${toString federationPort.private}";
};
listen = [
{ addr = "0.0.0.0"; port = federationPort.public; ssl = true; }
{ addr = "[::]"; port = federationPort.public; ssl = true; }
];
};
"${domain}" = {
forceSSL = true;
enableACME = true;
locations."= /.well-known/matrix/server".extraConfig =
let
server = { "m.server" = "matrix.${domain}:${toString federationPort.public}"; };
in ''
add_header Content-Type application/json;
return 200 '${builtins.toJSON server}';
'';
locations."= /.well-known/matrix/client".extraConfig =
let
client = {
"m.homeserver" = { "base_url" = "https://matrix.${domain}"; };
"m.identity_server" = { "base_url" = "https://vector.im"; };
};
# ACAO required to allow element-web on any URL to request this json file
in ''
add_header Content-Type application/json;
add_header Access-Control-Allow-Origin *;
return 200 '${builtins.toJSON client}';
'';
};
# Element Web app deployment
#
"chat.${domain}" = {
enableACME = true;
forceSSL = true;
root = pkgs.element-web.override {
conf = {
default_server_config = {
"m.homeserver" = {
"base_url" = "https://matrix.${domain}";
"server_name" = "${domain}";
};
"m.identity_server" = {
"base_url" = "https://vector.im";
};
};
showLabsSettings = true;
defaultCountryCode = "FR"; # cocorico
roomDirectory = {
"servers" = [
"matrix.org"
"mozilla.org"
"prologin.org"
];
};
};
};
};
};
};
# For administration tools.
environment.systemPackages = [ pkgs.matrix-synapse ];
networking.firewall.allowedTCPPorts = [
clientPort.public
federationPort.public
];
my.services.borg-backup = let
dataDir = config.services.matrix-synapse.dataDir;
in mkIf cfg.enable {
paths = [ dataDir ];
# this is just caching for other servers media, doesn't need backup
exclude = [ "${dataDir}/media/remote_*" ];
};
systemd.services.matrix-synapse-compress-state = {
path = [
config.services.postgresql.package
pkgs.matrix-synapse-tools.rust-synapse-compress-state
];
serviceConfig = {
Type = "oneshot";
User = "matrix-synapse";
Group = "matrix-synapse";
};
script = ''
set -eux
# select the 20 biggest rooms
psql \
-U matrix-synapse \
-d matrix-synapse \
-c 'SELECT room_id, count(*) AS count
FROM state_groups_state
GROUP BY room_id
ORDER BY count DESC;' \
-t | sed -r 's/\s([^ ]+)\s*\|.*/\1/' | head -n 20 > /tmp/synapse_compress_rooms.txt
while read -r room_id; do
synapse-compress-state \
-p "postgresql:///matrix-synapse?user=matrix-synapse&host=/var/run/postgresql" \
-r "''${room_id}" \
-o /tmp/compress.sql \
-t
psql -U matrix-synapse -d matrix-synapse < /tmp/compress.sql
rm /tmp/compress.sql
done < /tmp/synapse_compress_rooms.txt
rm /tmp/synapse_compress_rooms.txt
'';
};
};
}