commit a4c4060efbbf07159cf24d6a14a7a8cb90043ea0 · pyrox.dev/nixpkgs

nixos/modules/module-list.nix

···

       477
       477
        
         ./services/mail/roundcube.nix

     

       478
       478
        
         ./services/mail/sympa.nix

     

       479
       479
        
         ./services/mail/nullmailer.nix

     

       480
       480
       +
         ./services/matrix/mjolnir.nix

     

       480
       481
        
         ./services/matrix/pantalaimon.nix

     

       481
       482
        
         ./services/misc/airsonic.nix

     

       482
       483
        
         ./services/misc/ankisyncd.nix

+239

nixos/modules/services/matrix/mjolnir.nix

···

       1
       1
       +
       { config, lib, pkgs, ... }:

     

       2
       2
       +
       

     

       3
       3
       +
       with lib;

     

       4
       4
       +
       let

     

       5
       5
       +
         cfg = config.services.mjolnir;

     

       6
       6
       +
       

     

       7
       7
       +
         yamlConfig = {

     

       8
       8
       +
           inherit (cfg) dataPath managementRoom protectedRooms;

     

       9
       9
       +
       

     

       10
       10
       +
           accessToken = "@ACCESS_TOKEN@"; # will be replaced in "generateConfig"

     

       11
       11
       +
           homeserverUrl =

     

       12
       12
       +
             if cfg.pantalaimon.enable then

     

       13
       13
       +
               "http://${cfg.pantalaimon.options.listenAddress}:${toString cfg.pantalaimon.options.listenPort}"

     

       14
       14
       +
             else

     

       15
       15
       +
               cfg.homeserverUrl;

     

       16
       16
       +
       

     

       17
       17
       +
           pantalaimon = {

     

       18
       18
       +
             inherit (cfg.pantalaimon) username;

     

       19
       19
       +
       

     

       20
       20
       +
             use = cfg.pantalaimon.enable;

     

       21
       21
       +
             password = "@PANTALAIMON_PASSWORD@"; # will be replaced in "generateConfig"

     

       22
       22
       +
           };

     

       23
       23
       +
         };

     

       24
       24
       +
       

     

       25
       25
       +
         moduleConfigFile = pkgs.writeText "module-config.yaml" (

     

       26
       26
       +
           generators.toYAML { } (filterAttrs (_: v: v != null)

     

       27
       27
       +
             (fold recursiveUpdate { } [ yamlConfig cfg.settings ])));

     

       28
       28
       +
       

     

       29
       29
       +
         # these config files will be merged one after the other to build the final config

     

       30
       30
       +
         configFiles = [

     

       31
       31
       +
           "${pkgs.mjolnir}/share/mjolnir/config/default.yaml"

     

       32
       32
       +
           moduleConfigFile

     

       33
       33
       +
         ];

     

       34
       34
       +
       

     

       35
       35
       +
         # this will generate the default.yaml file with all configFiles as inputs and

     

       36
       36
       +
         # replace all secret strings using replace-secret

     

       37
       37
       +
         generateConfig = pkgs.writeShellScript "mjolnir-generate-config" (

     

       38
       38
       +
           let

     

       39
       39
       +
             yqEvalStr = concatImapStringsSep " * " (pos: _: "select(fileIndex == ${toString (pos - 1)})") configFiles;

     

       40
       40
       +
             yqEvalArgs = concatStringsSep " " configFiles;

     

       41
       41
       +
           in

     

       42
       42
       +
           ''

     

       43
       43
       +
             set -euo pipefail

     

       44
       44
       +
       

     

       45
       45
       +
             umask 077

     

       46
       46
       +
       

     

       47
       47
       +
             # mjolnir will try to load a config from "./config/default.yaml" in the working directory

     

       48
       48
       +
             # -> let's place the generated config there

     

       49
       49
       +
             mkdir -p ${cfg.dataPath}/config

     

       50
       50
       +
       

     

       51
       51
       +
             # merge all config files into one, overriding settings of the previous one with the next config

     

       52
       52
       +
             # e.g. "eval-all 'select(fileIndex == 0) * select(fileIndex == 1)' filea.yaml fileb.yaml" will merge filea.yaml with fileb.yaml

     

       53
       53
       +
             ${pkgs.yq-go}/bin/yq eval-all -P '${yqEvalStr}' ${yqEvalArgs} > ${cfg.dataPath}/config/default.yaml

     

       54
       54
       +
       

     

       55
       55
       +
             ${optionalString (cfg.accessTokenFile != null) ''

     

       56
       56
       +
               ${pkgs.replace-secret}/bin/replace-secret '@ACCESS_TOKEN@' '${cfg.accessTokenFile}' ${cfg.dataPath}/config/default.yaml

     

       57
       57
       +
             ''}

     

       58
       58
       +
             ${optionalString (cfg.pantalaimon.passwordFile != null) ''

     

       59
       59
       +
               ${pkgs.replace-secret}/bin/replace-secret '@PANTALAIMON_PASSWORD@' '${cfg.pantalaimon.passwordFile}' ${cfg.dataPath}/config/default.yaml

     

       60
       60
       +
             ''}

     

       61
       61
       +
           ''

     

       62
       62
       +
         );

     

       63
       63
       +
       in

     

       64
       64
       +
       {

     

       65
       65
       +
         options.services.mjolnir = {

     

       66
       66
       +
           enable = mkEnableOption "Mjolnir, a moderation tool for Matrix";

     

       67
       67
       +
       

     

       68
       68
       +
           homeserverUrl = mkOption {

     

       69
       69
       +
             type = types.str;

     

       70
       70
       +
             default = "https://matrix.org";

     

       71
       71
       +
             description = ''

     

       72
       72
       +
               Where the homeserver is located (client-server URL).

     

       73
       73
       +
       

     

       74
       74
       +
               If <literal>pantalaimon.enable</literal> is <literal>true</literal>, this option will become the homeserver to which <literal>pantalaimon</literal> connects.

     

       75
       75
       +
               The listen address of <literal>pantalaimon</literal> will then become the <literal>homeserverUrl</literal> of <literal>mjolnir</literal>.

     

       76
       76
       +
             '';

     

       77
       77
       +
           };

     

       78
       78
       +
       

     

       79
       79
       +
           accessTokenFile = mkOption {

     

       80
       80
       +
             type = with types; nullOr path;

     

       81
       81
       +
             default = null;

     

       82
       82
       +
             description = ''

     

       83
       83
       +
               File containing the matrix access token for the <literal>mjolnir</literal> user.

     

       84
       84
       +
             '';

     

       85
       85
       +
           };

     

       86
       86
       +
       

     

       87
       87
       +
           pantalaimon = mkOption {

     

       88
       88
       +
             description = ''

     

       89
       89
       +
               <literal>pantalaimon</literal> options (enables E2E Encryption support).

     

       90
       90
       +
       

     

       91
       91
       +
               This will create a <literal>pantalaimon</literal> instance with the name "mjolnir".

     

       92
       92
       +
             '';

     

       93
       93
       +
             default = { };

     

       94
       94
       +
             type = types.submodule {

     

       95
       95
       +
               options = {

     

       96
       96
       +
                 enable = mkEnableOption ''

     

       97
       97
       +
                   If true, accessToken is ignored and the username/password below will be

     

       98
       98
       +
                   used instead. The access token of the bot will be stored in the dataPath.

     

       99
       99
       +
                 '';

     

       100
       100
       +
       

     

       101
       101
       +
                 username = mkOption {

     

       102
       102
       +
                   type = types.str;

     

       103
       103
       +
                   description = "The username to login with.";

     

       104
       104
       +
                 };

     

       105
       105
       +
       

     

       106
       106
       +
                 passwordFile = mkOption {

     

       107
       107
       +
                   type = with types; nullOr path;

     

       108
       108
       +
                   default = null;

     

       109
       109
       +
                   description = ''

     

       110
       110
       +
                     File containing the matrix password for the <literal>mjolnir</literal> user.

     

       111
       111
       +
                   '';

     

       112
       112
       +
                 };

     

       113
       113
       +
       

     

       114
       114
       +
                 options = mkOption {

     

       115
       115
       +
                   type = types.submodule (import ./pantalaimon-options.nix);

     

       116
       116
       +
                   default = { };

     

       117
       117
       +
                   description = ''

     

       118
       118
       +
                     passthrough additional options to the <literal>pantalaimon</literal> service.

     

       119
       119
       +
                   '';

     

       120
       120
       +
                 };

     

       121
       121
       +
               };

     

       122
       122
       +
             };

     

       123
       123
       +
           };

     

       124
       124
       +
       

     

       125
       125
       +
           dataPath = mkOption {

     

       126
       126
       +
             type = types.path;

     

       127
       127
       +
             default = "/var/lib/mjolnir";

     

       128
       128
       +
             description = ''

     

       129
       129
       +
               The directory the bot should store various bits of information in.

     

       130
       130
       +
             '';

     

       131
       131
       +
           };

     

       132
       132
       +
       

     

       133
       133
       +
           managementRoom = mkOption {

     

       134
       134
       +
             type = types.str;

     

       135
       135
       +
             default = "#moderators:example.org";

     

       136
       136
       +
             description = ''

     

       137
       137
       +
               The room ID where people can use the bot. The bot has no access controls, so

     

       138
       138
       +
               anyone in this room can use the bot - secure your room!

     

       139
       139
       +
               This should be a room alias or room ID - not a matrix.to URL.

     

       140
       140
       +
               Note: <literal>mjolnir</literal> is fairly verbose - expect a lot of messages from it.

     

       141
       141
       +
             '';

     

       142
       142
       +
           };

     

       143
       143
       +
       

     

       144
       144
       +
           protectedRooms = mkOption {

     

       145
       145
       +
             type = types.listOf types.str;

     

       146
       146
       +
             default = [ ];

     

       147
       147
       +
             example = literalExample ''

     

       148
       148
       +
               [

     

       149
       149
       +
                 "https://matrix.to/#/#yourroom:example.org"

     

       150
       150
       +
                 "https://matrix.to/#/#anotherroom:example.org"

     

       151
       151
       +
               ]

     

       152
       152
       +
             '';

     

       153
       153
       +
             description = ''

     

       154
       154
       +
               A list of rooms to protect (matrix.to URLs).

     

       155
       155
       +
             '';

     

       156
       156
       +
           };

     

       157
       157
       +
       

     

       158
       158
       +
           settings = mkOption {

     

       159
       159
       +
             default = { };

     

       160
       160
       +
             type = (pkgs.formats.yaml { }).type;

     

       161
       161
       +
             example = literalExample ''

     

       162
       162
       +
               {

     

       163
       163
       +
                 autojoinOnlyIfManager = true;

     

       164
       164
       +
                 automaticallyRedactForReasons = [ "spam" "advertising" ];

     

       165
       165
       +
               }

     

       166
       166
       +
             '';

     

       167
       167
       +
             description = ''

     

       168
       168
       +
               Additional settings (see <link xlink:href="https://github.com/matrix-org/mjolnir/blob/main/config/default.yaml">mjolnir default config</link> for available settings). These settings will override settings made by the module config.

     

       169
       169
       +
             '';

     

       170
       170
       +
           };

     

       171
       171
       +
         };

     

       172
       172
       +
       

     

       173
       173
       +
         config = mkIf config.services.mjolnir.enable {

     

       174
       174
       +
           assertions = [

     

       175
       175
       +
             {

     

       176
       176
       +
               assertion = !(cfg.pantalaimon.enable && cfg.pantalaimon.passwordFile == null);

     

       177
       177
       +
               message = "Specify pantalaimon.passwordFile";

     

       178
       178
       +
             }

     

       179
       179
       +
             {

     

       180
       180
       +
               assertion = !(cfg.pantalaimon.enable && cfg.accessTokenFile != null);

     

       181
       181
       +
               message = "Do not specify accessTokenFile when using pantalaimon";

     

       182
       182
       +
             }

     

       183
       183
       +
             {

     

       184
       184
       +
               assertion = !(!cfg.pantalaimon.enable && cfg.accessTokenFile == null);

     

       185
       185
       +
               message = "Specify accessTokenFile when not using pantalaimon";

     

       186
       186
       +
             }

     

       187
       187
       +
           ];

     

       188
       188
       +
       

     

       189
       189
       +
           services.pantalaimon-headless.instances."mjolnir" = mkIf cfg.pantalaimon.enable

     

       190
       190
       +
             {

     

       191
       191
       +
               homeserver = cfg.homeserverUrl;

     

       192
       192
       +
             } // cfg.pantalaimon.options;

     

       193
       193
       +
       

     

       194
       194
       +
           systemd.services.mjolnir = {

     

       195
       195
       +
             description = "mjolnir - a moderation tool for Matrix";

     

       196
       196
       +
             wants = [ "network-online.target" ] ++ optionals (cfg.pantalaimon.enable) [ "pantalaimon-mjolnir.service" ];

     

       197
       197
       +
             after = [ "network-online.target" ] ++ optionals (cfg.pantalaimon.enable) [ "pantalaimon-mjolnir.service" ];

     

       198
       198
       +
             wantedBy = [ "multi-user.target" ];

     

       199
       199
       +
       

     

       200
       200
       +
             serviceConfig = {

     

       201
       201
       +
               ExecStart = ''${pkgs.mjolnir}/bin/mjolnir'';

     

       202
       202
       +
               ExecStartPre = [ generateConfig ];

     

       203
       203
       +
               WorkingDirectory = cfg.dataPath;

     

       204
       204
       +
               StateDirectory = "mjolnir";

     

       205
       205
       +
               StateDirectoryMode = "0700";

     

       206
       206
       +
               ProtectSystem = "strict";

     

       207
       207
       +
               ProtectHome = true;

     

       208
       208
       +
               PrivateTmp = true;

     

       209
       209
       +
               NoNewPrivileges = true;

     

       210
       210
       +
               PrivateDevices = true;

     

       211
       211
       +
               User = "mjolnir";

     

       212
       212
       +
               Restart = "on-failure";

     

       213
       213
       +
       

     

       214
       214
       +
               /* TODO: wait for #102397 to be resolved. Then load secrets from $CREDENTIALS_DIRECTORY+"/NAME"

     

       215
       215
       +
               DynamicUser = true;

     

       216
       216
       +
               LoadCredential = [] ++

     

       217
       217
       +
                 optionals (cfg.accessTokenFile != null) [

     

       218
       218
       +
                   "access_token:${cfg.accessTokenFile}"

     

       219
       219
       +
                 ] ++

     

       220
       220
       +
                 optionals (cfg.pantalaimon.passwordFile != null) [

     

       221
       221
       +
                   "pantalaimon_password:${cfg.pantalaimon.passwordFile}"

     

       222
       222
       +
                 ];

     

       223
       223
       +
               */

     

       224
       224
       +
             };

     

       225
       225
       +
           };

     

       226
       226
       +
       

     

       227
       227
       +
           users = {

     

       228
       228
       +
             users.mjolnir = {

     

       229
       229
       +
               group = "mjolnir";

     

       230
       230
       +
               isSystemUser = true;

     

       231
       231
       +
             };

     

       232
       232
       +
             groups.mjolnir = { };

     

       233
       233
       +
           };

     

       234
       234
       +
         };

     

       235
       235
       +
       

     

       236
       236
       +
         meta = {

     

       237
       237
       +
           maintainers = with maintainers; [ jojosch ];

     

       238
       238
       +
         };

     

       239
       239
       +
       }