summaryrefslogtreecommitdiff
path: root/modules
diff options
context:
space:
mode:
authorsinanmohd <sinan@sinanmohd.com>2023-12-24 07:22:21 +0530
committersinanmohd <sinan@sinanmohd.com>2023-12-27 08:14:06 +0530
commit565225847ebf54aa57722271dd83d99954a55076 (patch)
tree4b0bdeaff2907a783e3081ad2658a49c64ec5537 /modules
parenta74e008263afe2a3a71a4cf5b76ca71e62ae3b21 (diff)
modules/matrix-sliding-sync: init dendrite
Diffstat (limited to 'modules')
-rw-r--r--modules/matrix-sliding-sync.nix109
1 files changed, 109 insertions, 0 deletions
diff --git a/modules/matrix-sliding-sync.nix b/modules/matrix-sliding-sync.nix
new file mode 100644
index 0000000..3785515
--- /dev/null
+++ b/modules/matrix-sliding-sync.nix
@@ -0,0 +1,109 @@
+{ config, lib, pkgs, ... }:
+
+let
+ cfg = config.services.matrix-sliding-sync;
+in
+{
+ imports = [
+ (lib.mkRenamedOptionModule
+ [ "services" "matrix-synapse" "sliding-sync" ]
+ [ "services" "matrix-sliding-sync" ]
+ )
+ ];
+
+ options.services.matrix-sliding-sync = {
+ enable = lib.mkEnableOption (lib.mdDoc "sliding sync");
+
+ package = lib.mkPackageOption pkgs "matrix-sliding-sync" { };
+
+ 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 = lib.mdDoc ''
+ 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 = [ {
+ name = "matrix-sliding-sync";
+ ensureDBOwnership = true;
+ } ];
+ };
+
+ systemd.services.matrix-sliding-sync = rec {
+ after =
+ lib.optional cfg.createDatabase "postgresql.service"
+ ++ lib.optional config.services.dendrite.enable "dendrite.service"
+ ++ lib.optional config.services.matrix-synapse.enable config.services.matrix-synapse.serviceUnit;
+ wants = after;
+ 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";
+ Restart = "on-failure";
+ RestartSec = "1s";
+ };
+ };
+ };
+}