commit 0b483037f72095d81ce4af2c7d2b91f1e845c7c0 · pyrox.dev/nixpkgs

nixos/doc/manual/release-notes/rl-2505.section.md

···

       149
       149
        
       

     

       150
       150
        
       - [PDS](https://github.com/bluesky-social/pds), Personal Data Server for [bsky](https://bsky.social/). Available as [services.pds](option.html#opt-services.pds).

     

       151
       151
        
       

     

       152
       152
       +
       - [synapse-auto-compressor](https://github.com/matrix-org/rust-synapse-compress-state?tab=readme-ov-file#automated-tool-synapse_auto_compressor), a rust-based matrix-synapse state compressor for postgresql. Available as [services.synapse-auto-compressor](#opt-services.synapse-auto-compressor.enable).

     

       153
       153
       +
       

     

       152
       154
        
       - [mqtt-exporter](https://github.com/kpetremann/mqtt-exporter/), a Prometheus exporter for exposing messages from MQTT. Available as [services.prometheus.exporters.mqtt](#opt-services.prometheus.exporters.mqtt.enable).

     

       153
       155
        
       

     

       154
       156
        
       - [nvidia-gpu](https://github.com/utkuozdemir/nvidia_gpu_exporter), a Prometheus exporter that scrapes `nvidia-smi` for GPU metrics. Available as [services.prometheus.exporters.nvidia-gpu](#opt-services.prometheus.exporters.nvidia-gpu.enable).

nixos/modules/module-list.nix

···

       751
       751
        
         ./services/matrix/mx-puppet-discord.nix

     

       752
       752
        
         ./services/matrix/pantalaimon.nix

     

       753
       753
        
         ./services/matrix/synapse.nix

     

       754
       754
       +
         ./services/matrix/synapse-auto-compressor.nix

     

       754
       755
        
         ./services/misc/airsonic.nix

     

       755
       756
        
         ./services/misc/amazon-ssm-agent.nix

     

       756
       757
        
         ./services/misc/ananicy.nix

+164

nixos/modules/services/matrix/synapse-auto-compressor.nix

···

       1
       1
       +
       {

     

       2
       2
       +
         config,

     

       3
       3
       +
         lib,

     

       4
       4
       +
         pkgs,

     

       5
       5
       +
         utils,

     

       6
       6
       +
         ...

     

       7
       7
       +
       }:

     

       8
       8
       +
       

     

       9
       9
       +
       let

     

       10
       10
       +
         cfg = config.services.synapse-auto-compressor;

     

       11
       11
       +
         synapseConfig = config.services.matrix-synapse;

     

       12
       12
       +
         postgresEnabled = config.services.postgresql.enable;

     

       13
       13
       +
         synapseUsesPostgresql = synapseConfig.settings.database.name == "psycopg2";

     

       14
       14
       +
         synapseUsesLocalPostgresql =

     

       15
       15
       +
           let

     

       16
       16
       +
             args = synapseConfig.settings.database.args;

     

       17
       17
       +
           in

     

       18
       18
       +
           synapseUsesPostgresql

     

       19
       19
       +
           && postgresEnabled

     

       20
       20
       +
           && (

     

       21
       21
       +
             !(args ? host)

     

       22
       22
       +
             || (builtins.elem args.host [

     

       23
       23
       +
               "localhost"

     

       24
       24
       +
               "127.0.0.1"

     

       25
       25
       +
               "::1"

     

       26
       26
       +
             ])

     

       27
       27
       +
           );

     

       28
       28
       +
       in

     

       29
       29
       +
       {

     

       30
       30
       +
         options = {

     

       31
       31
       +
           services.synapse-auto-compressor = {

     

       32
       32
       +
             enable = lib.mkEnableOption "synapse-auto-compressor";

     

       33
       33
       +
             package = lib.mkPackageOption pkgs "rust-synapse-state-compress" { };

     

       34
       34
       +
             postgresUrl = lib.mkOption {

     

       35
       35
       +
               default =

     

       36
       36
       +
                 let

     

       37
       37
       +
                   args = synapseConfig.settings.database.args;

     

       38
       38
       +
                 in

     

       39
       39
       +
                 if synapseConfig.enable then

     

       40
       40
       +
                   ''postgresql://${args.user}${lib.optionalString (args ? password) (":" + args.password)}@${

     

       41
       41
       +
                     lib.escapeURL (if (args ? host) then args.host else "/run/postgresql")

     

       42
       42
       +
                   }${lib.optionalString (args ? port) (":" + args.port)}/${args.database}''

     

       43
       43
       +
                 else

     

       44
       44
       +
                   null;

     

       45
       45
       +
               defaultText = lib.literalExpression ''

     

       46
       46
       +
                 let

     

       47
       47
       +
                   synapseConfig = config.services.matrix-synapse;

     

       48
       48
       +
                   args = synapseConfig.settings.database.args;

     

       49
       49
       +
                 in

     

       50
       50
       +
                 if synapseConfig.enable then

     

       51
       51
       +
                   '''postgresql://''${args.user}''${lib.optionalString (args ? password) (":" + args.password)}@''${

     

       52
       52
       +
                     lib.escapeURL (if (args ? host) then args.host else "/run/postgresql")

     

       53
       53
       +
                   }''${lib.optionalString (args ? port) (":" + args.port)}''${args.database}'''

     

       54
       54
       +
                 else

     

       55
       55
       +
                   null;

     

       56
       56
       +
               '';

     

       57
       57
       +
               type = lib.types.str;

     

       58
       58
       +
               example = "postgresql://username:password@mydomain.com:port/database";

     

       59
       59
       +
               description = ''

     

       60
       60
       +
                 Connection string to postgresql in the

     

       61
       61
       +
                 [rust `postgres` crate config format](https://docs.rs/postgres/latest/postgres/config/struct.Config.html).

     

       62
       62
       +
                 The module will attempt to build a URL-style connection string out of the `services.matrix-synapse.settings.database.args`

     

       63
       63
       +
                 if a local synapse is enabled.

     

       64
       64
       +
               '';

     

       65
       65
       +
             };

     

       66
       66
       +
             startAt = lib.mkOption {

     

       67
       67
       +
               default = "weekly";

     

       68
       68
       +
               type = with lib.types; either str (listOf str);

     

       69
       69
       +
               description = "How often to run this service in systemd calendar syntax (see {manpage}`systemd.time(7)`)";

     

       70
       70
       +
               example = "daily";

     

       71
       71
       +
             };

     

       72
       72
       +
       

     

       73
       73
       +
             settings = {

     

       74
       74
       +
               chunk_size = lib.mkOption {

     

       75
       75
       +
                 type = lib.types.int;

     

       76
       76
       +
                 default = 500;

     

       77
       77
       +
                 description = ''

     

       78
       78
       +
                   The number of state groups to work on at once. All of the entries from `state_groups_state` are requested

     

       79
       79
       +
                   from the database for state groups that are worked on. Therefore small chunk sizes may be needed on

     

       80
       80
       +
                   machines with low memory.

     

       81
       81
       +
       

     

       82
       82
       +
                   Note: if the compressor fails to find space savings on the chunk as a whole

     

       83
       83
       +
                   (which may well happen in rooms with lots of backfill in) then the entire chunk is skipped.

     

       84
       84
       +
                 '';

     

       85
       85
       +
               };

     

       86
       86
       +
               chunks_to_compress = lib.mkOption {

     

       87
       87
       +
                 type = lib.types.int;

     

       88
       88
       +
                 default = 100;

     

       89
       89
       +
                 description = ''

     

       90
       90
       +
                   `chunks_to_compress` chunks of size `chunk_size` will be compressed. The higher this number is set to,

     

       91
       91
       +
                   the longer the compressor will run for.

     

       92
       92
       +
                 '';

     

       93
       93
       +
               };

     

       94
       94
       +
               levels = lib.mkOption {

     

       95
       95
       +
                 type = with lib.types; listOf int;

     

       96
       96
       +
                 default = [

     

       97
       97
       +
                   100

     

       98
       98
       +
                   50

     

       99
       99
       +
                   25

     

       100
       100
       +
                 ];

     

       101
       101
       +
                 description = ''

     

       102
       102
       +
                   Sizes of each new level in the compression algorithm, as a comma-separated list. The first entry in

     

       103
       103
       +
                   the list is for the lowest, most granular level, with each subsequent entry being for the next highest

     

       104
       104
       +
                   level. The number of entries in the list determines the number of levels that will be used. The sum of

     

       105
       105
       +
                   the sizes of the levels affects the performance of fetching the state from the database, as the sum of

     

       106
       106
       +
                   the sizes is the upper bound on the number of iterations needed to fetch a given set of state.

     

       107
       107
       +
                 '';

     

       108
       108
       +
               };

     

       109
       109
       +
             };

     

       110
       110
       +
           };

     

       111
       111
       +
         };

     

       112
       112
       +
         config = lib.mkIf cfg.enable {

     

       113
       113
       +
           assertions = [

     

       114
       114
       +
             {

     

       115
       115
       +
               assertion = synapseConfig.enable && synapseUsesPostgresql;

     

       116
       116
       +
               message = "`services.synapse-auto-compressor` requires local synapse to use postgresql as a database backend";

     

       117
       117
       +
             }

     

       118
       118
       +
           ];

     

       119
       119
       +
           systemd.services.synapse-auto-compressor = {

     

       120
       120
       +
             description = "synapse-auto-compressor";

     

       121
       121
       +
             requires = lib.optionals synapseUsesLocalPostgresql [

     

       122
       122
       +
               "postgresql.service"

     

       123
       123
       +
             ];

     

       124
       124
       +
             inherit (cfg) startAt;

     

       125
       125
       +
             serviceConfig = {

     

       126
       126
       +
               Type = "oneshot";

     

       127
       127
       +
               DynamicUser = true;

     

       128
       128
       +
               User = "matrix-synapse";

     

       129
       129
       +
               PrivateTmp = true;

     

       130
       130
       +
               ExecStart = utils.escapeSystemdExecArgs [

     

       131
       131
       +
                 "${cfg.package}/bin/synapse_auto_compressor"

     

       132
       132
       +
                 "-p"

     

       133
       133
       +
                 cfg.postgresUrl

     

       134
       134
       +
                 "-c"

     

       135
       135
       +
                 cfg.settings.chunk_size

     

       136
       136
       +
                 "-n"

     

       137
       137
       +
                 cfg.settings.chunks_to_compress

     

       138
       138
       +
                 "-l"

     

       139
       139
       +
                 (lib.concatStringsSep "," (builtins.map builtins.toString cfg.settings.levels))

     

       140
       140
       +
               ];

     

       141
       141
       +
               LockPersonality = true;

     

       142
       142
       +
               MemoryDenyWriteExecute = true;

     

       143
       143
       +
               NoNewPrivileges = true;

     

       144
       144
       +
               PrivateDevices = true;

     

       145
       145
       +
               PrivateMounts = true;

     

       146
       146
       +
               PrivateUsers = true;

     

       147
       147
       +
               RemoveIPC = true;

     

       148
       148
       +
               RestrictNamespaces = true;

     

       149
       149
       +
               RestrictRealtime = true;

     

       150
       150
       +
               RestrictSUIDSGID = true;

     

       151
       151
       +
               ProcSubset = "pid";

     

       152
       152
       +
               ProtectProc = "invisible";

     

       153
       153
       +
               ProtectSystem = "strict";

     

       154
       154
       +
               ProtectHome = true;

     

       155
       155
       +
               ProtectHostname = true;

     

       156
       156
       +
               ProtectClock = true;

     

       157
       157
       +
               ProtectKernelTunables = true;

     

       158
       158
       +
               ProtectKernelModules = true;

     

       159
       159
       +
               ProtectKernelLogs = true;

     

       160
       160
       +
               ProtectControlGroups = true;

     

       161
       161
       +
             };

     

       162
       162
       +
           };

     

       163
       163
       +
         };

     

       164
       164
       +
       }