mirror of
https://github.com/dali99/nixos-matrix-modules.git
synced 2026-01-26 09:03:13 +01:00
Compare commits
1 Commits
make-worke
...
presence-s
| Author | SHA1 | Date | |
|---|---|---|---|
| 9c7cdcead1 |
1
.gitignore
vendored
1
.gitignore
vendored
@@ -1 +0,0 @@
|
|||||||
result
|
|
||||||
21
COPYING
21
COPYING
@@ -1,21 +0,0 @@
|
|||||||
MIT License
|
|
||||||
|
|
||||||
Copyright (c) 2020, 2022-2023 Daniel Løvbrøtte Olsen and contributors
|
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
|
||||||
in the Software without restriction, including without limitation the rights
|
|
||||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
||||||
copies of the Software, and to permit persons to whom the Software is
|
|
||||||
furnished to do so, subject to the following conditions:
|
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be included in all
|
|
||||||
copies or substantial portions of the Software.
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
||||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
||||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
||||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
||||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
||||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
||||||
SOFTWARE.
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# Migrations
|
|
||||||
|
|
||||||
This is a best effort document descibing neccecary changes you might have to do when updating
|
|
||||||
|
|
||||||
## 0.5.0 UNRELEASED
|
|
||||||
|
|
||||||
The module has been renamed from `synapse` to `default`
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
22
README.MD
22
README.MD
@@ -9,10 +9,6 @@ With matrix.YOURDOMAIN pointing at the server:
|
|||||||
|
|
||||||
workers.federationSenders = 1;
|
workers.federationSenders = 1;
|
||||||
workers.federationReceivers = 1;
|
workers.federationReceivers = 1;
|
||||||
workers.initialSyncers = 1;
|
|
||||||
workers.normalSyncers = 1;
|
|
||||||
workers.eventPersisters = 2;
|
|
||||||
workers.useUserDirectoryWorker = true;
|
|
||||||
|
|
||||||
enableNginx = true;
|
enableNginx = true;
|
||||||
|
|
||||||
@@ -35,20 +31,4 @@ With matrix.YOURDOMAIN pointing at the server:
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
is ~enough to get a functional matrix-server running with some workers
|
is ~enough to get a functional matrix-server running one federation sender and one federation receiver
|
||||||
|
|
||||||
## Sliding Sync (Element X)
|
|
||||||
|
|
||||||
Just add the following to your config and point `slidingsync.YOURDOMAIN` at the server
|
|
||||||
|
|
||||||
```
|
|
||||||
services.matrix-synapse-next = {
|
|
||||||
enableSlidingSync = true;
|
|
||||||
};
|
|
||||||
|
|
||||||
services.matrix-synapse.sliding-sync.environmentFile = "/some/file/containing/SYNCV3_SECRET=<some secret>";
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
If using [well-known delagation](https://matrix-org.github.io/synapse/v1.37/delegate.html) make sure `YOURDOMAIN/.well-known/matrix/client` matches
|
|
||||||
what's in `matrix.YOURDOMAIN/.well-known/matrix/client`
|
|
||||||
|
|||||||
16
flake.lock
generated
16
flake.lock
generated
@@ -1,20 +1,5 @@
|
|||||||
{
|
{
|
||||||
"nodes": {
|
"nodes": {
|
||||||
"nixpkgs": {
|
|
||||||
"locked": {
|
|
||||||
"lastModified": 1690789960,
|
|
||||||
"narHash": "sha256-3K+2HuyGTiJUSZNJxXXvc0qj4xFx1FHC/ItYtEa7/Xs=",
|
|
||||||
"owner": "NixOS",
|
|
||||||
"repo": "nixpkgs",
|
|
||||||
"rev": "fb942492b7accdee4e6d17f5447091c65897dde4",
|
|
||||||
"type": "github"
|
|
||||||
},
|
|
||||||
"original": {
|
|
||||||
"id": "nixpkgs",
|
|
||||||
"ref": "nixos-unstable",
|
|
||||||
"type": "indirect"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"nixpkgs-lib": {
|
"nixpkgs-lib": {
|
||||||
"locked": {
|
"locked": {
|
||||||
"lastModified": 1673743903,
|
"lastModified": 1673743903,
|
||||||
@@ -32,7 +17,6 @@
|
|||||||
},
|
},
|
||||||
"root": {
|
"root": {
|
||||||
"inputs": {
|
"inputs": {
|
||||||
"nixpkgs": "nixpkgs",
|
|
||||||
"nixpkgs-lib": "nixpkgs-lib"
|
"nixpkgs-lib": "nixpkgs-lib"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
20
flake.nix
20
flake.nix
@@ -2,27 +2,13 @@
|
|||||||
description = "NixOS modules for matrix related services";
|
description = "NixOS modules for matrix related services";
|
||||||
|
|
||||||
inputs = {
|
inputs = {
|
||||||
nixpkgs-lib.url = "github:nix-community/nixpkgs.lib";
|
nixpkgs-lib.url = github:nix-community/nixpkgs.lib;
|
||||||
nixpkgs.url = "nixpkgs/nixos-unstable";
|
|
||||||
};
|
};
|
||||||
|
|
||||||
outputs = { self, nixpkgs, nixpkgs-lib }: {
|
outputs = { self, nixpkgs-lib }: {
|
||||||
nixosModules = {
|
nixosModules = {
|
||||||
default = import ./module.nix;
|
synapse = import ./synapse-module { matrix-lib = self.lib; };
|
||||||
};
|
};
|
||||||
|
|
||||||
lib = import ./lib.nix { lib = nixpkgs-lib.lib; };
|
lib = import ./lib.nix { lib = nixpkgs-lib.lib; };
|
||||||
|
|
||||||
packages = let
|
|
||||||
system = "x86_64-linux";
|
|
||||||
pkgs = nixpkgs.legacyPackages.${system};
|
|
||||||
in {
|
|
||||||
${system}.tests = import ./tests {
|
|
||||||
inherit system;
|
|
||||||
inherit nixpkgs;
|
|
||||||
inherit pkgs;
|
|
||||||
nixosModule = self.outputs.nixosModules.synapse;
|
|
||||||
};
|
|
||||||
};
|
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,8 +0,0 @@
|
|||||||
{ ... }:
|
|
||||||
|
|
||||||
{
|
|
||||||
imports = [
|
|
||||||
./synapse-module
|
|
||||||
./sliding-sync
|
|
||||||
];
|
|
||||||
}
|
|
||||||
@@ -1,37 +0,0 @@
|
|||||||
{ lib
|
|
||||||
, buildGoModule
|
|
||||||
, fetchFromGitHub
|
|
||||||
}:
|
|
||||||
|
|
||||||
buildGoModule rec {
|
|
||||||
pname = "matrix-sliding-sync";
|
|
||||||
version = "0.99.11";
|
|
||||||
|
|
||||||
src = fetchFromGitHub {
|
|
||||||
owner = "matrix-org";
|
|
||||||
repo = "sliding-sync";
|
|
||||||
rev = "refs/tags/v${version}";
|
|
||||||
hash = "sha256-Wd/nnJhKg+BDyOIz42zEScjzQRrpEq6YG9/9Tk24hgg=";
|
|
||||||
};
|
|
||||||
|
|
||||||
vendorHash = "sha256-0QSyYhOht1j1tWNxHQh+NUZA/W1xy7ANu+29H/gusOE=";
|
|
||||||
|
|
||||||
subPackages = [ "cmd/syncv3" ];
|
|
||||||
|
|
||||||
ldflags = [
|
|
||||||
"-s"
|
|
||||||
"-w"
|
|
||||||
"-X main.GitCommit=${src.rev}"
|
|
||||||
];
|
|
||||||
|
|
||||||
# requires a running matrix-synapse
|
|
||||||
doCheck = false;
|
|
||||||
|
|
||||||
meta = with lib; {
|
|
||||||
description = "A sliding sync implementation of MSC3575 for matrix";
|
|
||||||
homepage = "https://github.com/matrix-org/sliding-sync";
|
|
||||||
license = with licenses; [ asl20 ];
|
|
||||||
maintainers = with maintainers; [ emilylange ];
|
|
||||||
mainProgram = "syncv3";
|
|
||||||
};
|
|
||||||
}
|
|
||||||
@@ -1,117 +0,0 @@
|
|||||||
{ config, lib, pkgs, ... }:
|
|
||||||
|
|
||||||
let
|
|
||||||
cfg = config.services.matrix-synapse.sliding-sync;
|
|
||||||
in
|
|
||||||
{
|
|
||||||
disabledModules = [ "services/matrix/matrix-sliding-sync.nix" ];
|
|
||||||
|
|
||||||
options.services.matrix-synapse.sliding-sync = {
|
|
||||||
enable = lib.mkEnableOption (lib.mdDoc "sliding sync");
|
|
||||||
|
|
||||||
package = lib.mkOption {
|
|
||||||
type = lib.types.package;
|
|
||||||
default = pkgs.callPackage ../pkgs/matrix-sliding-sync { };
|
|
||||||
description = "What package to use for the sliding-sync proxy.";
|
|
||||||
};
|
|
||||||
|
|
||||||
enableNginx = lib.mkEnableOption (lib.mdDoc "autogenerated nginx config");
|
|
||||||
publicBaseUrl = lib.mkOption {
|
|
||||||
type = lib.types.str;
|
|
||||||
description = "The domain where clients connect, only has an effect with enableNginx";
|
|
||||||
example = "slidingsync.matrix.org";
|
|
||||||
};
|
|
||||||
|
|
||||||
settings = lib.mkOption {
|
|
||||||
type = lib.types.submodule {
|
|
||||||
freeformType = with lib.types; attrsOf str;
|
|
||||||
options = {
|
|
||||||
SYNCV3_SERVER = lib.mkOption {
|
|
||||||
type = lib.types.str;
|
|
||||||
description = lib.mdDoc ''
|
|
||||||
The destination homeserver to talk to not including `/_matrix/` e.g `https://matrix.example.org`.
|
|
||||||
'';
|
|
||||||
};
|
|
||||||
|
|
||||||
SYNCV3_DB = lib.mkOption {
|
|
||||||
type = lib.types.str;
|
|
||||||
default = "postgresql:///matrix-sliding-sync?host=/run/postgresql";
|
|
||||||
description = lib.mdDoc ''
|
|
||||||
The postgres connection string.
|
|
||||||
Refer to <https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING>.
|
|
||||||
'';
|
|
||||||
};
|
|
||||||
|
|
||||||
SYNCV3_BINDADDR = lib.mkOption {
|
|
||||||
type = lib.types.str;
|
|
||||||
default = "127.0.0.1:8009";
|
|
||||||
example = "[::]:8008";
|
|
||||||
description = lib.mdDoc "The interface and port to listen on.";
|
|
||||||
};
|
|
||||||
|
|
||||||
SYNCV3_LOG_LEVEL = lib.mkOption {
|
|
||||||
type = lib.types.enum [ "trace" "debug" "info" "warn" "error" "fatal" ];
|
|
||||||
default = "info";
|
|
||||||
description = lib.mdDoc "The level of verbosity for messages logged.";
|
|
||||||
};
|
|
||||||
};
|
|
||||||
};
|
|
||||||
default = { };
|
|
||||||
description = ''
|
|
||||||
Freeform environment variables passed to the sliding sync proxy.
|
|
||||||
Refer to <https://github.com/matrix-org/sliding-sync#setup> for all supported values.
|
|
||||||
'';
|
|
||||||
};
|
|
||||||
|
|
||||||
createDatabase = lib.mkOption {
|
|
||||||
type = lib.types.bool;
|
|
||||||
default = true;
|
|
||||||
description = lib.mdDoc ''
|
|
||||||
Whether to enable and configure `services.postgres` to ensure that the database user `matrix-sliding-sync`
|
|
||||||
and the database `matrix-sliding-sync` exist.
|
|
||||||
'';
|
|
||||||
};
|
|
||||||
|
|
||||||
environmentFile = lib.mkOption {
|
|
||||||
type = lib.types.str;
|
|
||||||
description = lib.mdDoc ''
|
|
||||||
Environment file as defined in {manpage}`systemd.exec(5)`.
|
|
||||||
|
|
||||||
This must contain the {env}`SYNCV3_SECRET` variable which should
|
|
||||||
be generated with {command}`openssl rand -hex 32`.
|
|
||||||
'';
|
|
||||||
};
|
|
||||||
};
|
|
||||||
|
|
||||||
config = lib.mkIf cfg.enable {
|
|
||||||
services.postgresql = lib.optionalAttrs cfg.createDatabase {
|
|
||||||
enable = true;
|
|
||||||
ensureDatabases = [ "matrix-sliding-sync" ];
|
|
||||||
ensureUsers = [ rec {
|
|
||||||
name = "matrix-sliding-sync";
|
|
||||||
ensurePermissions."DATABASE \"${name}\"" = "ALL PRIVILEGES";
|
|
||||||
} ];
|
|
||||||
};
|
|
||||||
|
|
||||||
systemd.services.matrix-sliding-sync = {
|
|
||||||
after = lib.optional cfg.createDatabase "postgresql.service";
|
|
||||||
wantedBy = [ "multi-user.target" ];
|
|
||||||
environment = cfg.settings;
|
|
||||||
serviceConfig = {
|
|
||||||
DynamicUser = true;
|
|
||||||
EnvironmentFile = cfg.environmentFile;
|
|
||||||
ExecStart = lib.getExe cfg.package;
|
|
||||||
StateDirectory = "matrix-sliding-sync";
|
|
||||||
WorkingDirectory = "%S/matrix-sliding-sync";
|
|
||||||
};
|
|
||||||
};
|
|
||||||
|
|
||||||
services.nginx.virtualHosts.${cfg.publicBaseUrl} = lib.mkIf cfg.enableNginx {
|
|
||||||
enableACME = true;
|
|
||||||
forceSSL = true;
|
|
||||||
locations."/" = {
|
|
||||||
proxyPass = lib.replaceStrings [ "0.0.0.0" "::" ] [ "127.0.0.1" "::1" ] "http://${cfg.settings.SYNCV3_BINDADDR}";
|
|
||||||
};
|
|
||||||
};
|
|
||||||
};
|
|
||||||
}
|
|
||||||
@@ -1,7 +1,6 @@
|
|||||||
|
{ matrix-lib }:
|
||||||
{ pkgs, lib, config, ... }:
|
{ pkgs, lib, config, ... }:
|
||||||
let
|
let
|
||||||
matrix-lib = (import ../lib.nix { inherit lib; });
|
|
||||||
|
|
||||||
cfg = config.services.matrix-synapse-next;
|
cfg = config.services.matrix-synapse-next;
|
||||||
wcfg = cfg.workers;
|
wcfg = cfg.workers;
|
||||||
|
|
||||||
@@ -84,8 +83,6 @@ in
|
|||||||
description = "A yaml python logging config file";
|
description = "A yaml python logging config file";
|
||||||
};
|
};
|
||||||
|
|
||||||
enableSlidingSync = mkEnableOption (lib.mdDoc "automatic Sliding Sync setup at `slidingsync.<domain>`");
|
|
||||||
|
|
||||||
settings = mkOption {
|
settings = mkOption {
|
||||||
type = types.submodule {
|
type = types.submodule {
|
||||||
freeformType = format.type;
|
freeformType = format.type;
|
||||||
@@ -396,19 +393,5 @@ in
|
|||||||
};
|
};
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
|
|
||||||
services.matrix-synapse-next.settings.extra_well_known_client_content."org.matrix.msc3575.proxy" = mkIf cfg.enableSlidingSync {
|
|
||||||
url = "https://${config.services.matrix-synapse.sliding-sync.publicBaseUrl}";
|
|
||||||
};
|
|
||||||
services.matrix-synapse.sliding-sync = mkIf cfg.enableSlidingSync {
|
|
||||||
enable = true;
|
|
||||||
enableNginx = lib.mkDefault cfg.enableNginx;
|
|
||||||
publicBaseUrl = lib.mkDefault "slidingsync.${cfg.settings.server_name}";
|
|
||||||
|
|
||||||
settings = {
|
|
||||||
SYNCV3_SERVER = lib.mkDefault "https://${cfg.public_baseurl}";
|
|
||||||
SYNCV3_PROM = lib.mkIf cfg.settings.enable_metrics (lib.mkDefault "127.0.0.1:9001");
|
|
||||||
};
|
|
||||||
};
|
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -117,6 +117,7 @@ in
|
|||||||
synapse_federation_transaction synapse_worker_federation;
|
synapse_federation_transaction synapse_worker_federation;
|
||||||
|
|
||||||
synapse_client_user-dir synapse_worker_user-dir;
|
synapse_client_user-dir synapse_worker_user-dir;
|
||||||
|
synapse_client_presence synapse_worker_stream-presence;
|
||||||
}
|
}
|
||||||
|
|
||||||
# from https://github.com/tswfi/synapse/commit/b3704b936663cc692241e978dce4ac623276b1a6
|
# from https://github.com/tswfi/synapse/commit/b3704b936663cc692241e978dce4ac623276b1a6
|
||||||
@@ -187,6 +188,14 @@ in
|
|||||||
'';
|
'';
|
||||||
};
|
};
|
||||||
|
|
||||||
|
services.nginx.upstreams.synapse_worker_stream-presence = {
|
||||||
|
servers = let
|
||||||
|
workers = getWorkersOfType "stream-presence";
|
||||||
|
socketAddresses = generateSocketAddresses "client" workers;
|
||||||
|
in if workers != { } then
|
||||||
|
lib.genAttrs socketAddresses (_: { })
|
||||||
|
else config.services.nginx.upstreams.synapse_master.servers;
|
||||||
|
};
|
||||||
|
|
||||||
services.nginx.upstreams.synapse_worker_user-dir = {
|
services.nginx.upstreams.synapse_worker_user-dir = {
|
||||||
servers = let
|
servers = let
|
||||||
@@ -198,7 +207,7 @@ in
|
|||||||
};
|
};
|
||||||
|
|
||||||
services.nginx.virtualHosts."${cfg.public_baseurl}" = {
|
services.nginx.virtualHosts."${cfg.public_baseurl}" = {
|
||||||
enableACME = lib.mkDefault true;
|
enableACME = true;
|
||||||
forceSSL = true;
|
forceSSL = true;
|
||||||
locations."/_matrix" = {
|
locations."/_matrix" = {
|
||||||
proxyPass = "http://$synapse_backend";
|
proxyPass = "http://$synapse_backend";
|
||||||
@@ -230,9 +239,6 @@ in
|
|||||||
locations."/_synapse/client" = {
|
locations."/_synapse/client" = {
|
||||||
proxyPass = "http://$synapse_backend";
|
proxyPass = "http://$synapse_backend";
|
||||||
};
|
};
|
||||||
locations."/.well-known/matrix" = {
|
|
||||||
proxyPass = "http://$synapse_backend";
|
|
||||||
};
|
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -19,7 +19,6 @@
|
|||||||
type = types.ints.unsigned;
|
type = types.ints.unsigned;
|
||||||
description = "How many automatically configured ${workerType} workers to set up";
|
description = "How many automatically configured ${workerType} workers to set up";
|
||||||
default = 0;
|
default = 0;
|
||||||
example = 1;
|
|
||||||
};
|
};
|
||||||
|
|
||||||
genAttrs' = items: f: g: builtins.listToAttrs (map (i: lib.nameValuePair (f i) (g i)) items);
|
genAttrs' = items: f: g: builtins.listToAttrs (map (i: lib.nameValuePair (f i) (g i)) items);
|
||||||
@@ -34,25 +33,11 @@ in {
|
|||||||
type = types.bool;
|
type = types.bool;
|
||||||
internal = true;
|
internal = true;
|
||||||
default = false;
|
default = false;
|
||||||
description = ''
|
|
||||||
This is an internal flag that signals that this worker is part of the
|
|
||||||
workers generated by either of the following:
|
|
||||||
|
|
||||||
- federationSenders
|
|
||||||
- federationReceivers
|
|
||||||
- initialSyncers
|
|
||||||
- normalSyncers
|
|
||||||
- eventPersisters
|
|
||||||
- useUserDirectoryWorker
|
|
||||||
'';
|
|
||||||
};
|
};
|
||||||
|
|
||||||
index = mkOption {
|
index = mkOption {
|
||||||
internal = true;
|
internal = true;
|
||||||
type = types.ints.positive;
|
type = types.ints.positive;
|
||||||
description = ''
|
|
||||||
This is an internal variable that indexes the worker of this type.
|
|
||||||
'';
|
|
||||||
};
|
};
|
||||||
|
|
||||||
# The custom string type here is mainly for the name to use
|
# The custom string type here is mainly for the name to use
|
||||||
@@ -84,6 +69,20 @@ in {
|
|||||||
default = "synapse.app.generic_worker";
|
default = "synapse.app.generic_worker";
|
||||||
};
|
};
|
||||||
|
|
||||||
|
worker_replication_host = mkOption {
|
||||||
|
type = types.str;
|
||||||
|
default = wcfg.mainReplicationHost;
|
||||||
|
defaultText = literalExpression "${wcfgText}.mainReplicationHost";
|
||||||
|
description = "The replication listeners IP on the main synapse process";
|
||||||
|
};
|
||||||
|
|
||||||
|
worker_replication_http_port = mkOption {
|
||||||
|
type = types.port;
|
||||||
|
default = wcfg.mainReplicationPort;
|
||||||
|
defaultText = literalExpression "${wcfgText}.mainReplicationPort";
|
||||||
|
description = "The replication listeners port on the main synapse process";
|
||||||
|
};
|
||||||
|
|
||||||
worker_listeners = mkOption {
|
worker_listeners = mkOption {
|
||||||
type = types.listOf (workerListenerType instanceCfg);
|
type = types.listOf (workerListenerType instanceCfg);
|
||||||
description = "Listener configuration for the worker, similar to the main synapse listener";
|
description = "Listener configuration for the worker, similar to the main synapse listener";
|
||||||
@@ -100,25 +99,17 @@ in {
|
|||||||
default = "http";
|
default = "http";
|
||||||
};
|
};
|
||||||
|
|
||||||
path = mkOption {
|
port = mkOption {
|
||||||
type = types.path;
|
type = types.port;
|
||||||
default = instanceCfg.name;
|
description = "The TCP port to bind to";
|
||||||
description = ''
|
|
||||||
A path and filename for a Unix socket.
|
|
||||||
'';
|
|
||||||
};
|
};
|
||||||
|
|
||||||
# port = mkOption {
|
bind_addresses = mkOption {
|
||||||
# type = types.port;
|
type = with types; listOf str;
|
||||||
# description = "The TCP port to bind to";
|
description = "A list of local addresses to listen on";
|
||||||
# };
|
default = [ wcfg.defaultListenerAddress ];
|
||||||
|
defaultText = literalExpression "[ ${wcfgText}.defaultListenerAddress ]";
|
||||||
# bind_addresses = mkOption {
|
};
|
||||||
# type = with types; listOf str;
|
|
||||||
# description = "A list of local addresses to listen on";
|
|
||||||
# default = [ wcfg.defaultListenerAddress ];
|
|
||||||
# defaultText = literalExpression "[ ${wcfgText}.defaultListenerAddress ]";
|
|
||||||
# };
|
|
||||||
|
|
||||||
tls = mkOption {
|
tls = mkOption {
|
||||||
type = types.bool;
|
type = types.bool;
|
||||||
@@ -183,6 +174,38 @@ in {
|
|||||||
};
|
};
|
||||||
};
|
};
|
||||||
in {
|
in {
|
||||||
|
mainReplicationHost = mkOption {
|
||||||
|
type = types.str;
|
||||||
|
default = let
|
||||||
|
host = (matrix-lib.connectionInfo mainReplicationListener).host;
|
||||||
|
in
|
||||||
|
# To avoid connecting to 0.0.0.0 and so on
|
||||||
|
if builtins.elem host [ "0.0.0.0" "::" ]
|
||||||
|
then "127.0.0.1"
|
||||||
|
else host;
|
||||||
|
# TODO: add defaultText
|
||||||
|
description = "Host of the main synapse instance's replication listener";
|
||||||
|
};
|
||||||
|
|
||||||
|
mainReplicationPort = mkOption {
|
||||||
|
type = types.port;
|
||||||
|
default = mainReplicationListener.port;
|
||||||
|
# TODO: add defaultText
|
||||||
|
description = "Port for the main synapse instance's replication listener";
|
||||||
|
};
|
||||||
|
|
||||||
|
defaultListenerAddress = mkOption {
|
||||||
|
type = types.str;
|
||||||
|
default = "127.0.0.1";
|
||||||
|
description = "The default listener address for the worker";
|
||||||
|
};
|
||||||
|
|
||||||
|
workerStartingPort = mkOption {
|
||||||
|
type = types.port;
|
||||||
|
description = "What port should the automatically configured workers start enumerating from";
|
||||||
|
default = 8083;
|
||||||
|
};
|
||||||
|
|
||||||
enableMetrics = mkOption {
|
enableMetrics = mkOption {
|
||||||
type = types.bool;
|
type = types.bool;
|
||||||
default = cfg.settings.enable_metrics;
|
default = cfg.settings.enable_metrics;
|
||||||
@@ -190,6 +213,12 @@ in {
|
|||||||
# TODO: add description
|
# TODO: add description
|
||||||
};
|
};
|
||||||
|
|
||||||
|
metricsStartingPort = mkOption {
|
||||||
|
type = types.port;
|
||||||
|
default = 18083;
|
||||||
|
# TODO: add description
|
||||||
|
};
|
||||||
|
|
||||||
federationSenders = mkWorkerCountOption "federation-sender";
|
federationSenders = mkWorkerCountOption "federation-sender";
|
||||||
federationReceivers = mkWorkerCountOption "federation-reciever";
|
federationReceivers = mkWorkerCountOption "federation-reciever";
|
||||||
initialSyncers = mkWorkerCountOption "initial-syncer";
|
initialSyncers = mkWorkerCountOption "initial-syncer";
|
||||||
@@ -197,20 +226,20 @@ in {
|
|||||||
eventPersisters = mkWorkerCountOption "event-persister";
|
eventPersisters = mkWorkerCountOption "event-persister";
|
||||||
|
|
||||||
useUserDirectoryWorker = mkEnableOption "user directory worker";
|
useUserDirectoryWorker = mkEnableOption "user directory worker";
|
||||||
|
usePresenceStreamWriter = mkEnableOption "prescence stream writer";
|
||||||
|
|
||||||
instances = mkOption {
|
instances = mkOption {
|
||||||
type = types.attrsOf workerInstanceType;
|
type = types.attrsOf workerInstanceType;
|
||||||
default = { };
|
default = { };
|
||||||
description = "Worker configuration";
|
description = "Worker configuration";
|
||||||
example = {
|
example = {
|
||||||
"federation-sender-1" = {
|
"federation_sender1" = {
|
||||||
settings = {
|
settings = {
|
||||||
worker_name = "federation-sender-1";
|
worker_name = "federation_sender1";
|
||||||
worker_app = "synapse.app.generic_worker";
|
worker_app = "synapse.app.generic_worker";
|
||||||
|
|
||||||
path = "/run/matrix-synapse/federation-sender-1.sock";
|
worker_replication_host = "127.0.0.1";
|
||||||
# worker_replication_host = "127.0.0.1";
|
worker_replication_http_port = 9093;
|
||||||
# worker_replication_http_port = 9093;
|
|
||||||
worker_listeners = [ ];
|
worker_listeners = [ ];
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
@@ -218,59 +247,92 @@ in {
|
|||||||
};
|
};
|
||||||
};
|
};
|
||||||
|
|
||||||
config = let
|
config = {
|
||||||
genList1 = f: builtins.genList (i: f (i + 1));
|
|
||||||
in {
|
|
||||||
services.matrix-synapse-next.settings = {
|
services.matrix-synapse-next.settings = {
|
||||||
federation_sender_instances =
|
federation_sender_instances =
|
||||||
genList1 (i: "auto-fed-sender-${toString i}") wcfg.federationSenders;
|
lib.genList (i: "auto-fed-sender${toString (i + 1)}") wcfg.federationSenders;
|
||||||
|
|
||||||
instance_map = lib.mkIf (cfg.workers.instances != { }) ({
|
instance_map = genAttrs' (lib.lists.range 1 wcfg.eventPersisters)
|
||||||
main.path = "/run/matrix-synapse/main-replication-worker.sock";
|
(i: "auto-event-persist${toString i}")
|
||||||
} // builtins.mapAttrs (n: v: {
|
(i: let
|
||||||
inherit (builtins.head v.settings.worker_listeners) path;
|
wRL = matrix-lib.firstListenerOfType "replication" wcfg.instances."auto-event-persist${toString i}".settings.worker_listeners;
|
||||||
}) wcfg.instances);
|
in matrix-lib.connectionInfo wRL);
|
||||||
|
|
||||||
stream_writers.events =
|
stream_writers.events =
|
||||||
mkIf (wcfg.eventPersisters > 0)
|
mkIf (wcfg.eventPersisters > 0)
|
||||||
(genList1 (i: "auto-event-persist-${toString i}") wcfg.eventPersisters);
|
(lib.genList (i: "auto-event-persist${toString (i + 1)}") wcfg.eventPersisters);
|
||||||
|
|
||||||
update_user_directory_from_worker =
|
update_user_directory_from_worker =
|
||||||
mkIf wcfg.useUserDirectoryWorker "auto-user-dir-1";
|
mkIf wcfg.useUserDirectoryWorker "auto-user-dir";
|
||||||
};
|
};
|
||||||
|
|
||||||
services.matrix-synapse-next.workers.instances =
|
services.matrix-synapse-next.workers.instances = let
|
||||||
let
|
sum = lib.foldl lib.add 0;
|
||||||
workerInstances = {
|
workerListenersWithMetrics = portOffset:
|
||||||
"fed-sender" = wcfg.federationSenders;
|
lib.singleton ({
|
||||||
"fed-receiver" = wcfg.federationReceivers;
|
port = wcfg.workerStartingPort + portOffset - 1;
|
||||||
"initial-sync" = wcfg.initialSyncers;
|
})
|
||||||
"normal-sync" = wcfg.normalSyncers;
|
++ lib.optional wcfg.enableMetrics {
|
||||||
"event-persist" = wcfg.eventPersisters;
|
port = wcfg.metricsStartingPort + portOffset;
|
||||||
"user-dir" = if wcfg.useUserDirectoryWorker then 1 else 0;
|
resources = [ { names = [ "metrics" ]; } ];
|
||||||
};
|
};
|
||||||
in
|
|
||||||
lib.pipe workerInstances [
|
makeWorkerInstances = {
|
||||||
(lib.mapAttrsToList (type: count: { inherit type count; }))
|
type,
|
||||||
(map ({ type, count }: genList1 (i: rec {
|
numberOfWorkers,
|
||||||
name = "auto-${type}-${toString i}";
|
portOffset ? 0,
|
||||||
value = {
|
nameFn ? i: "auto-${type}${toString i}",
|
||||||
inherit type;
|
workerListenerFn ? i: workerListenersWithMetrics (portOffset + i)
|
||||||
isAuto = true;
|
}: genAttrs'
|
||||||
index = i;
|
(lib.lists.range 1 numberOfWorkers)
|
||||||
settings.worker_listeners =
|
nameFn
|
||||||
[
|
(i: {
|
||||||
{ path = "/run/matrix-synapse/${name}.sock"; }
|
isAuto = true;
|
||||||
] ++ lib.optionals wcfg.enableMetrics [{
|
inherit type;
|
||||||
path = "/run/matrix-synapse/${name}-metrics.sock";
|
index = i;
|
||||||
resources = [{ names = [ "metrics" ]; }];
|
settings.worker_listeners = workerListenerFn i;
|
||||||
type = "metrics";
|
});
|
||||||
}];
|
|
||||||
};
|
workerInstances = {
|
||||||
}) count))
|
"fed-sender" = wcfg.federationSenders;
|
||||||
lib.flatten
|
"fed-receiver" = wcfg.federationReceivers;
|
||||||
builtins.listToAttrs
|
"initial-sync" = wcfg.initialSyncers;
|
||||||
];
|
"normal-sync" = wcfg.normalSyncers;
|
||||||
|
"event-persist" = wcfg.eventPersisters;
|
||||||
|
} // (lib.optionalAttrs wcfg.useUserDirectoryWorker {
|
||||||
|
"user-dir" = {
|
||||||
|
numberOfWorkers = 1;
|
||||||
|
nameFn = _: "auto-user-dir";
|
||||||
|
};
|
||||||
|
}) // (lib.optionalAttrs wcfg.usePresenceStreamWriter {
|
||||||
|
"stream-presence" = {
|
||||||
|
numberOfWorkers = 1;
|
||||||
|
nameFn = _: "auto-stream-presence";
|
||||||
|
};
|
||||||
|
});
|
||||||
|
|
||||||
|
coerceWorker = { name, value }: if builtins.isInt value then {
|
||||||
|
type = name;
|
||||||
|
numberOfWorkers = value;
|
||||||
|
} else { type = name; } // value;
|
||||||
|
|
||||||
|
# Like foldl, but keeps all intermediate values
|
||||||
|
#
|
||||||
|
# (b -> a -> b) -> b -> [a] -> [b]
|
||||||
|
scanl = f: x1: list: let
|
||||||
|
x2 = lib.head list;
|
||||||
|
x1' = f x1 x2;
|
||||||
|
in if list == [] then [] else [x1'] ++ (scanl f x1' (lib.tail list));
|
||||||
|
|
||||||
|
f = { portOffset, numberOfWorkers, ... }: x: x // { portOffset = portOffset + numberOfWorkers; };
|
||||||
|
init = { portOffset = 0; numberOfWorkers = 0; };
|
||||||
|
in lib.pipe workerInstances [
|
||||||
|
(lib.mapAttrsToList lib.nameValuePair)
|
||||||
|
(map coerceWorker)
|
||||||
|
(scanl f init)
|
||||||
|
(map makeWorkerInstances)
|
||||||
|
mkMerge
|
||||||
|
];
|
||||||
|
|
||||||
systemd.services = let
|
systemd.services = let
|
||||||
workerList = lib.mapAttrsToList lib.nameValuePair wcfg.instances;
|
workerList = lib.mapAttrsToList lib.nameValuePair wcfg.instances;
|
||||||
@@ -279,26 +341,20 @@ in {
|
|||||||
in builtins.listToAttrs (lib.flip map workerList (worker: {
|
in builtins.listToAttrs (lib.flip map workerList (worker: {
|
||||||
name = "matrix-synapse-worker-${worker.name}";
|
name = "matrix-synapse-worker-${worker.name}";
|
||||||
value = {
|
value = {
|
||||||
documentation = [ "https://github.com/matrix-org/synapse/blob/develop/docs/workers.md" ];
|
|
||||||
description = "Synapse Matrix Worker";
|
description = "Synapse Matrix Worker";
|
||||||
partOf = [ "matrix-synapse.target" ];
|
partOf = [ "matrix-synapse.target" ];
|
||||||
wantedBy = [ "matrix-synapse.target" ];
|
wantedBy = [ "matrix-synapse.target" ];
|
||||||
after = [ "matrix-synapse.service" ];
|
after = [ "matrix-synapse.service" ];
|
||||||
requires = [ "matrix-synapse.service" ];
|
requires = [ "matrix-synapse.service" ];
|
||||||
restartTriggers = [ matrix-synapse-common-config (workerConfig worker) ] ++ cfg.extraConfigFiles;
|
environment.PYTHONPATH = lib.makeSearchPathOutput "lib" cfg.package.python.sitePackages [
|
||||||
environment = {
|
pluginsEnv
|
||||||
PYTHONPATH = lib.makeSearchPathOutput "lib" cfg.package.python.sitePackages [
|
];
|
||||||
pluginsEnv
|
|
||||||
];
|
|
||||||
};
|
|
||||||
serviceConfig = {
|
serviceConfig = {
|
||||||
Restart = "always";
|
|
||||||
Type = "notify";
|
Type = "notify";
|
||||||
User = "matrix-synapse";
|
User = "matrix-synapse";
|
||||||
Group = "matrix-synapse";
|
Group = "matrix-synapse";
|
||||||
Slice = "system-matrix-synapse.slice";
|
Slice = "system-matrix-synapse.slice";
|
||||||
WorkingDirectory = cfg.dataDir;
|
WorkingDirectory = cfg.dataDir;
|
||||||
RuntimeDirectory = [ "matrix-synapse" ];
|
|
||||||
ExecStartPre = pkgs.writers.writeBash "wait-for-synapse" ''
|
ExecStartPre = pkgs.writers.writeBash "wait-for-synapse" ''
|
||||||
# From https://md.darmstadt.ccc.de/synapse-at-work
|
# From https://md.darmstadt.ccc.de/synapse-at-work
|
||||||
while ! systemctl is-active -q matrix-synapse.service; do
|
while ! systemctl is-active -q matrix-synapse.service; do
|
||||||
|
|||||||
@@ -1,18 +0,0 @@
|
|||||||
{ pkgs, lib, ... }:
|
|
||||||
{
|
|
||||||
services.matrix-synapse-next = {
|
|
||||||
enable = true;
|
|
||||||
settings.server_name = "matrix.example.com";
|
|
||||||
|
|
||||||
workers = {
|
|
||||||
enableMetrics = true;
|
|
||||||
|
|
||||||
federationSenders = 2;
|
|
||||||
federationReceivers = 2;
|
|
||||||
initialSyncers = 2;
|
|
||||||
normalSyncers = 2;
|
|
||||||
eventPersisters = 2;
|
|
||||||
useUserDirectoryWorker = true;
|
|
||||||
};
|
|
||||||
};
|
|
||||||
}
|
|
||||||
@@ -1,7 +0,0 @@
|
|||||||
{ pkgs, lib, ... }:
|
|
||||||
{
|
|
||||||
services.matrix-synapse-next = {
|
|
||||||
enable = true;
|
|
||||||
settings.server_name = "matrix.example.com";
|
|
||||||
};
|
|
||||||
}
|
|
||||||
@@ -1,16 +0,0 @@
|
|||||||
{ nixpkgs, pkgs, system ? pkgs.system, nixosModule, ... }: let
|
|
||||||
buildSystemWithConfig = configPath: (nixpkgs.lib.nixosSystem {
|
|
||||||
inherit system;
|
|
||||||
modules = [
|
|
||||||
nixosModule
|
|
||||||
configPath
|
|
||||||
{
|
|
||||||
boot.isContainer = true;
|
|
||||||
}
|
|
||||||
];
|
|
||||||
}).config.system.build.toplevel;
|
|
||||||
in {
|
|
||||||
a = pkgs.writeText "hello-world" ''a'';
|
|
||||||
base-config = buildSystemWithConfig ./base-config.nix;
|
|
||||||
auto-workers-config = buildSystemWithConfig ./auto-workers-config.nix;
|
|
||||||
}
|
|
||||||
Reference in New Issue
Block a user