about summary refs log tree commit diff
path: root/modules/services/matrix-homeserver.nix
blob: a29ecc64fddb2ec1ee563c6fd26f3ef51e1b0b03 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
{ config, lib, pkgs, ... }:

with lib;
let
  cfg = config.modules.services.matrix-homeserver;

  httpPort = 8008;
  slidingSyncPort = 8009;
  metricsPort = 8010;
in
{
  options.modules.services.matrix-homeserver = {
    enable = mkEnableOption "matrix homeserver instance";
    domain = mkOption { type = types.str; };
    realHost = mkOption { type = types.str; default = "matrix.${cfg.domain}"; };
    slidingSyncHost = mkOption { type = types.str; default = "slidingsync.${cfg.domain}"; };
    turn = {
      enable = mkEnableOption "VOIP using TURN";
      domain = mkOption { type = types.str; default = "turn.${cfg.domain}"; };
      shared_secret = mkOption { type = types.str; };
    };
    secrets = {
      matrix-server-key = mkOption { type = types.path; description = "path to the server key"; };
      matrix-shared-secret = mkOption { type = types.path; description = "path to the registration shared secret"; };
      extra-config-path = mkOption { type = types.nullOr types.path; description = "path to the extra configuration file to source"; };
      sliding-sync-secret = mkOption { type = types.nullOr types.path; description = "path to the sliding sync secret"; };
    };
  };

  config = mkIf cfg.enable {
    services.matrix-synapse = {
      enable = true;
      withJemalloc = true;
      dataDir = "/var/lib/matrix-synapse";
      settings = {
        server_name = cfg.domain;
        public_baseurl = "https://${cfg.realHost}";

        signing_key_path = cfg.secrets.matrix-server-key;

        allow_guest_access = false;
        enable_registration = false;
        registration_requires_token = true;
        registration_shared_secret_path = cfg.secrets.matrix-shared-secret;

        enable_metrics = true;
        url_preview_enabled = true;

        push.enabled = true;
        push.group_unread_count_by_room = false;

        database = {
          name = "psycopg2";
          args.password = "synapse";
        };

        listeners = [
          {
            port = httpPort;
            resources = [
              {
                compress = true;
                names = [ "client" ];
              }
              {
                compress = false;
                names = [ "federation" ];
              }
            ];
            type = "http";
            tls = false;
            x_forwarded = true;
          }
          {
            port = metricsPort;
            resources = [{
              compress = false;
              names = [ "metrics" ];
            }];
            type = "metrics";
            tls = false;
          }
        ];

        trusted_key_servers = [{
          server_name = "matrix.org";
          verify_keys = {
            "ed25519:auto" = "Noi6WqcDj0QmPxCNQqgezwTlBKrfqehY1u2FyWP9uYw";
          };
        }];
        # Yes, we want to use matrix.org as our trusted key server
        suppress_key_server_warning = true;
      } // optionalAttrs (cfg.turn.enable) {
        turn_uris = [
          "turns:${cfg.turn.domain}?transport=udp"
          "turns:${cfg.turn.domain}?transport=tcp"
          "turn:${cfg.turn.domain}?transport=udp"
          "turn:${cfg.turn.domain}?transport=tcp"
        ];
      };
    };

    services.matrix-sliding-sync = {
      enable = true;
      createDatabase = true;
      settings = {
        SYNCV3_SERVER = "https://${cfg.realHost}";
        SYNCV3_BINDADDR = "[::1]:${toString slidingSyncPort}";
      };
      environmentFile = cfg.secrets.sliding-sync-secret;
    };

    services.prometheus.scrapeConfigs = [
      {
        job_name = "synapse";
        metrics_path = "/_synapse/metrics";
        static_configs = [{
          targets = [ "127.0.0.1:${toString metricsPort}" ];
        }];
      }
    ];

    modules.persistence.directories = [
      "/var/lib/matrix-synapse"
    ];

    services.postgresql.enable = true;
    services.postgresql.initialScript = pkgs.writeText "synapse-init.sql" ''
      CREATE ROLE "matrix-synapse" WITH LOGIN PASSWORD 'synapse';
      CREATE DATABASE "matrix-synapse" WITH OWNER "matrix-synapse"
       TEMPLATE template0
       LC_COLLATE = "C"
       LC_CTYPE = "C";
    '';
    services.nginx.virtualHosts.${cfg.realHost} = {
      forceSSL = true;
      useACMEHost = cfg.domain;
      listen = [
        { addr = "0.0.0.0"; port = 443; ssl = true; }
        { addr = "[::]"; port = 443; ssl = true; }
        { addr = "0.0.0.0"; port = 8448; ssl = true; }
        { addr = "[::]"; port = 8448; ssl = true; }

      ];
      extraConfig = ''
        proxy_set_header Host $host;
        proxy_set_header X-Forwarded-For $remote_addr;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_read_timeout 600;
        client_max_body_size ${config.services.matrix-synapse.settings.max_upload_size};
      '';

      locations."~* ^(\\/_matrix|\\/_synapse\\/client)".proxyPass = "http://[::1]:${toString httpPort}";
    };

    services.nginx.virtualHosts.${cfg.domain} =
      let
        server-hello = { "m.server" = "${cfg.realHost}:443"; };
        client-hello = {
          "m.homeserver"."base_url" = "https://${cfg.realHost}";
          "m.identity_server"."base_url" = "https://vector.im";
          "org.matrix.msc3575.proxy"."url" = "https://${cfg.slidingSyncHost}";
        };
      in
      {
        forceSSL = true;
        useACMEHost = cfg.domain;
        locations = {
          "/.well-known/matrix/server" = {
            extraConfig = ''
              add_header Content-Type application/json;
              return 200 '${builtins.toJSON server-hello}';
            '';
          };
          "/.well-known/matrix/client" = {
            extraConfig = ''
              add_header Content-Type application/json;
              add_header Access-Control-Allow-Origin *;
              return 200 '${builtins.toJSON client-hello}';
            '';
          };
        };
      };

    services.nginx.virtualHosts.${cfg.slidingSyncHost} = {
      forceSSL = true;
      useACMEHost = cfg.domain;
      locations."/".proxyPass = "http://${config.services.matrix-sliding-sync.settings.SYNCV3_BINDADDR}";
    };

    networking.firewall.allowedTCPPorts = [ 443 8448 ];
  };
}