commit 4b153aad5d363b9d88ca4b47b4628f8032d05863 · pyrox.dev/nixpkgs

nixos/doc/manual/redirects.json

···

       749
       749
        
         "module-services-davis-basic-usage": [

     

       750
       750
        
           "index.html#module-services-davis-basic-usage"

     

       751
       751
        
         ],

     

       752
       752
       +
         "module-services-draupnir": [

     

       753
       753
       +
           "index.html#module-services-draupnir"

     

       754
       754
       +
         ],

     

       755
       755
       +
         "module-services-draupnir-setup": [

     

       756
       756
       +
           "index.html#module-services-draupnir-setup"

     

       757
       757
       +
         ],

     

       758
       758
       +
         "module-services-draupnir-setup-ems": [

     

       759
       759
       +
           "index.html#module-services-draupnir-setup-ems"

     

       760
       760
       +
         ],

     

       752
       761
        
         "module-services-castopod": [

     

       753
       762
        
           "index.html#module-services-castopod"

     

       754
       763
        
         ],

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

···

       22
       22
        
       

     

       23
       23
        
       - [Broadcast Box](https://github.com/Glimesh/broadcast-box), a WebRTC broadcast server. Available as [services.broadcast-box](options.html#opt-services.broadcast-box.enable).

     

       24
       24
        
       

     

       25
       25
       +
       - [Draupnir](https://github.com/the-draupnir-project/draupnir), a Matrix moderation bot. Available as [services.draupnir](#opt-services.draupnir.enable).

     

       26
       26
       +
       

     

       25
       27
        
       - [SuiteNumérique Docs](https://github.com/suitenumerique/docs), a collaborative note taking, wiki and documentation web platform and alternative to Notion or Outline. Available as [services.lasuite-docs](#opt-services.lasuite-docs.enable).

     

       26
       28
        
       

     

       27
       29
        
       ## Backward Incompatibilities {#sec-release-25.11-incompatibilities}

nixos/modules/module-list.nix

···

       757
       757
        
         ./services/matrix/conduit.nix

     

       758
       758
        
         ./services/matrix/continuwuity.nix

     

       759
       759
        
         ./services/matrix/dendrite.nix

     

       760
       760
       +
         ./services/matrix/draupnir.nix

     

       760
       761
        
         ./services/matrix/hebbot.nix

     

       761
       762
        
         ./services/matrix/hookshot.nix

     

       762
       763
        
         ./services/matrix/lk-jwt-service.nix

+62

nixos/modules/services/matrix/draupnir.md

···

       1
       1
       +
       # Draupnir (Matrix Moderation Bot) {#module-services-draupnir}

     

       2
       2
       +
       

     

       3
       3
       +
       This chapter will show you how to set up your own, self-hosted

     

       4
       4
       +
       [Draupnir](https://github.com/the-draupnir-project/Draupnir) instance.

     

       5
       5
       +
       

     

       6
       6
       +
       As an all-in-one moderation tool, it can protect your server from

     

       7
       7
       +
       malicious invites, spam messages, and whatever else you don't want.

     

       8
       8
       +
       In addition to server-level protection, Draupnir is great for communities

     

       9
       9
       +
       wanting to protect their rooms without having to use their personal

     

       10
       10
       +
       accounts for moderation.

     

       11
       11
       +
       

     

       12
       12
       +
       The bot by default includes support for bans, redactions, anti-spam,

     

       13
       13
       +
       server ACLs, room directory changes, room alias transfers, account

     

       14
       14
       +
       deactivation, room shutdown, and more. (This depends on homeserver configuration and implementation.)

     

       15
       15
       +
       

     

       16
       16
       +
       See the [README](https://github.com/the-draupnir-project/draupnir#readme)

     

       17
       17
       +
       page and the [Moderator's guide](https://the-draupnir-project.github.io/draupnir-documentation/moderator/setting-up-and-configuring)

     

       18
       18
       +
       for additional instructions on how to setup and use Draupnir.

     

       19
       19
       +
       

     

       20
       20
       +
       For [additional settings](#opt-services.draupnir.settings)

     

       21
       21
       +
       see [the default configuration](https://github.com/the-draupnir-project/Draupnir/blob/main/config/default.yaml).

     

       22
       22
       +
       

     

       23
       23
       +
       ## Draupnir Setup {#module-services-draupnir-setup}

     

       24
       24
       +
       

     

       25
       25
       +
       First create a new unencrypted, private room which will be used as the management room for Draupnir.

     

       26
       26
       +
       This is the room in which moderators will interact with Draupnir and where it will log possible errors and debugging information.

     

       27
       27
       +
       You'll need to set this room ID or alias in [services.draupnir.settings.managementRoom](#opt-services.draupnir.settings.managementRoom).

     

       28
       28
       +
       

     

       29
       29
       +
       Next, create a new user for Draupnir on your homeserver, if one does not already exist.

     

       30
       30
       +
       

     

       31
       31
       +
       The Draupnir Matrix user expects to be free of any rate limiting.

     

       32
       32
       +
       See [Synapse #6286](https://github.com/matrix-org/synapse/issues/6286)

     

       33
       33
       +
       for an example on how to achieve this.

     

       34
       34
       +
       

     

       35
       35
       +
       If you want Draupnir to be able to deactivate users, move room aliases, shut down rooms, etc.

     

       36
       36
       +
       you'll need to make the Draupnir user a Matrix server admin.

     

       37
       37
       +
       

     

       38
       38
       +
       Now invite the Draupnir user to the management room.

     

       39
       39
       +
       Draupnir will automatically try to join this room on startup.

     

       40
       40
       +
       

     

       41
       41
       +
       ```nix

     

       42
       42
       +
       {

     

       43
       43
       +
         services.draupnir = {

     

       44
       44
       +
           enable = true;

     

       45
       45
       +
       

     

       46
       46
       +
           settings = {

     

       47
       47
       +
             homeserverUrl = "https://matrix.org";

     

       48
       48
       +
             managementRoom = "!yyy:example.org";

     

       49
       49
       +
           };

     

       50
       50
       +
       

     

       51
       51
       +
           secrets = {

     

       52
       52
       +
             accessToken = "/path/to/secret/containing/access-token";

     

       53
       53
       +
           };

     

       54
       54
       +
         };

     

       55
       55
       +
       }

     

       56
       56
       +
       ```

     

       57
       57
       +
       

     

       58
       58
       +
       ### Element Matrix Services (EMS) {#module-services-draupnir-setup-ems}

     

       59
       59
       +
       

     

       60
       60
       +
       If you are using a managed ["Element Matrix Services (EMS)"](https://ems.element.io/)

     

       61
       61
       +
       server, you will need to consent to the terms and conditions. Upon startup, an error

     

       62
       62
       +
       log entry with a URL to the consent page will be generated.

+257

nixos/modules/services/matrix/draupnir.nix

···

       1
       1
       +
       {

     

       2
       2
       +
         config,

     

       3
       3
       +
         options,

     

       4
       4
       +
         lib,

     

       5
       5
       +
         pkgs,

     

       6
       6
       +
         ...

     

       7
       7
       +
       }:

     

       8
       8
       +
       

     

       9
       9
       +
       let

     

       10
       10
       +
         cfg = config.services.draupnir;

     

       11
       11
       +
         opt = options.services.draupnir;

     

       12
       12
       +
       

     

       13
       13
       +
         format = pkgs.formats.yaml { };

     

       14
       14
       +
         configFile = format.generate "draupnir.yaml" cfg.settings;

     

       15
       15
       +
       

     

       16
       16
       +
         inherit (lib)

     

       17
       17
       +
           literalExpression

     

       18
       18
       +
           mkEnableOption

     

       19
       19
       +
           mkOption

     

       20
       20
       +
           mkPackageOption

     

       21
       21
       +
           mkRemovedOptionModule

     

       22
       22
       +
           mkRenamedOptionModule

     

       23
       23
       +
           types

     

       24
       24
       +
           ;

     

       25
       25
       +
       in

     

       26
       26
       +
       {

     

       27
       27
       +
         imports = [

     

       28
       28
       +
           # Removed options for those migrating from the Mjolnir module

     

       29
       29
       +
           (mkRenamedOptionModule

     

       30
       30
       +
             [ "services" "draupnir" "dataPath" ]

     

       31
       31
       +
             [ "services" "draupnir" "settings" "dataPath" ]

     

       32
       32
       +
           )

     

       33
       33
       +
           (mkRenamedOptionModule

     

       34
       34
       +
             [ "services" "draupnir" "homeserverUrl" ]

     

       35
       35
       +
             [ "services" "draupnir" "settings" "homeserverUrl" ]

     

       36
       36
       +
           )

     

       37
       37
       +
           (mkRenamedOptionModule

     

       38
       38
       +
             [ "services" "draupnir" "managementRoom" ]

     

       39
       39
       +
             [ "services" "draupnir" "settings" "managementRoom" ]

     

       40
       40
       +
           )

     

       41
       41
       +
           (mkRenamedOptionModule

     

       42
       42
       +
             [ "services" "draupnir" "accessTokenFile" ]

     

       43
       43
       +
             [ "services" "draupnir" "secrets" "accessToken" ]

     

       44
       44
       +
           )

     

       45
       45
       +
           (mkRemovedOptionModule [ "services" "draupnir" "pantalaimon" ] ''

     

       46
       46
       +
             `services.draupnir.pantalaimon.*` has been removed because it depends on the deprecated and vulnerable

     

       47
       47
       +
             libolm library for end-to-end encryption and upstream support for Pantalaimon in Draupnir is limited.

     

       48
       48
       +
             See <https://the-draupnir-project.github.io/draupnir-documentation/bot/encryption> for details.

     

       49
       49
       +
             If you nontheless require E2EE via Pantalaimon, you can configure `services.pantalaimon-headless.instances`

     

       50
       50
       +
             yourself and use that with `services.draupnir.settings.pantalaimon` and `services.draupnir.secrets.pantalaimon.password`.

     

       51
       51
       +
           '')

     

       52
       52
       +
         ];

     

       53
       53
       +
       

     

       54
       54
       +
         options.services.draupnir = {

     

       55
       55
       +
           enable = mkEnableOption "Draupnir, a moderations bot for Matrix";

     

       56
       56
       +
       

     

       57
       57
       +
           package = mkPackageOption pkgs "draupnir" { };

     

       58
       58
       +
       

     

       59
       59
       +
           settings = mkOption {

     

       60
       60
       +
             example = literalExpression ''

     

       61
       61
       +
               {

     

       62
       62
       +
                 homeserverUrl = "https://matrix.org";

     

       63
       63
       +
                 managementRoom = "#moderators:example.org";

     

       64
       64
       +
       

     

       65
       65
       +
                 autojoinOnlyIfManager = true;

     

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

     

       67
       67
       +
               }

     

       68
       68
       +
             '';

     

       69
       69
       +
             description = ''

     

       70
       70
       +
               Free-form settings written to Draupnir's configuration file.

     

       71
       71
       +
               See [Draupnir's default configuration](https://github.com/the-draupnir-project/Draupnir/blob/main/config/default.yaml) for available settings.

     

       72
       72
       +
             '';

     

       73
       73
       +
             default = { };

     

       74
       74
       +
             type = types.submodule {

     

       75
       75
       +
               freeformType = format.type;

     

       76
       76
       +
               options = {

     

       77
       77
       +
                 homeserverUrl = mkOption {

     

       78
       78
       +
                   type = types.str;

     

       79
       79
       +
                   example = "https://matrix.org";

     

       80
       80
       +
                   description = ''

     

       81
       81
       +
                     Base URL of the Matrix homeserver that provides the Client-Server API.

     

       82
       82
       +
       

     

       83
       83
       +
                     ::: {.note}

     

       84
       84
       +
                     When using Pantalaimon, set this to the Pantalaimon URL and

     

       85
       85
       +
                     {option}`${opt.settings}.rawHomeserverUrl` to the public URL.

     

       86
       86
       +
                     :::

     

       87
       87
       +
                   '';

     

       88
       88
       +
                 };

     

       89
       89
       +
       

     

       90
       90
       +
                 rawHomeserverUrl = mkOption {

     

       91
       91
       +
                   type = types.str;

     

       92
       92
       +
                   example = "https://matrix.org";

     

       93
       93
       +
                   default = cfg.settings.homeserverUrl;

     

       94
       94
       +
                   defaultText = literalExpression "config.${opt.settings}.homeserverUrl";

     

       95
       95
       +
                   description = ''

     

       96
       96
       +
                     Public base URL of the Matrix homeserver that provides the Client-Server API when using the Draupnir's

     

       97
       97
       +
                     [Report forwarding feature](https://the-draupnir-project.github.io/draupnir-documentation/bot/homeserver-administration#report-forwarding).

     

       98
       98
       +
       

     

       99
       99
       +
                     ::: {.warning}

     

       100
       100
       +
                     When using Pantalaimon, do not set this to the Pantalaimon URL!

     

       101
       101
       +
                     :::

     

       102
       102
       +
                   '';

     

       103
       103
       +
                 };

     

       104
       104
       +
       

     

       105
       105
       +
                 managementRoom = mkOption {

     

       106
       106
       +
                   type = types.str;

     

       107
       107
       +
                   example = "#moderators:example.org";

     

       108
       108
       +
                   description = ''

     

       109
       109
       +
                     The room ID or alias where moderators can use the bot's functionality.

     

       110
       110
       +
       

     

       111
       111
       +
                     The bot has no access controls, so anyone in this room can use the bot - secure this room!

     

       112
       112
       +
                     Do not enable end-to-end encryption for this room, unless set up with Pantalaimon.

     

       113
       113
       +
       

     

       114
       114
       +
                     ::: {.warning}

     

       115
       115
       +
                     When using a room alias, make sure the alias used is on the local homeserver!

     

       116
       116
       +
                     This prevents an issue where the control room becomes undefined when the alias can't be resolved.

     

       117
       117
       +
                     :::

     

       118
       118
       +
                   '';

     

       119
       119
       +
                 };

     

       120
       120
       +
       

     

       121
       121
       +
                 dataPath = mkOption {

     

       122
       122
       +
                   type = types.path;

     

       123
       123
       +
                   readOnly = true;

     

       124
       124
       +
                   default = "/var/lib/draupnir";

     

       125
       125
       +
                   description = ''

     

       126
       126
       +
                     The path Draupnir will store its state/data in.

     

       127
       127
       +
       

     

       128
       128
       +
                     ::: {.warning}

     

       129
       129
       +
                     This option is read-only.

     

       130
       130
       +
                     :::

     

       131
       131
       +
       

     

       132
       132
       +
                     ::: {.note}

     

       133
       133
       +
                     If you want to customize where this data is stored, use a bind mount.

     

       134
       134
       +
                     :::

     

       135
       135
       +
                   '';

     

       136
       136
       +
                 };

     

       137
       137
       +
               };

     

       138
       138
       +
             };

     

       139
       139
       +
           };

     

       140
       140
       +
       

     

       141
       141
       +
           secrets = {

     

       142
       142
       +
             accessToken = mkOption {

     

       143
       143
       +
               type = types.nullOr types.path;

     

       144
       144
       +
               default = null;

     

       145
       145
       +
               description = ''

     

       146
       146
       +
                 File containing the access token for Draupnir's Matrix account

     

       147
       147
       +
                 to be used in place of {option}`${opt.settings}.accessToken`.

     

       148
       148
       +
               '';

     

       149
       149
       +
             };

     

       150
       150
       +
       

     

       151
       151
       +
             pantalaimon.password = mkOption {

     

       152
       152
       +
               type = types.nullOr types.path;

     

       153
       153
       +
               default = null;

     

       154
       154
       +
               description = ''

     

       155
       155
       +
                 File containing the password for Draupnir's Matrix account when used in

     

       156
       156
       +
                 conjunction with Pantalaimon to be used in place of

     

       157
       157
       +
                 {option}`${opt.settings}.pantalaimon.password`.

     

       158
       158
       +
       

     

       159
       159
       +
                 ::: {.warning}

     

       160
       160
       +
                 Take note that upstream has limited Pantalaimon and E2EE support:

     

       161
       161
       +
                 <https://the-draupnir-project.github.io/draupnir-documentation/bot/encryption> and

     

       162
       162
       +
                 <https://the-draupnir-project.github.io/draupnir-documentation/shared/dogfood#e2ee-support>.

     

       163
       163
       +
                 :::

     

       164
       164
       +
               '';

     

       165
       165
       +
             };

     

       166
       166
       +
       

     

       167
       167
       +
             web.synapseHTTPAntispam.authorization = mkOption {

     

       168
       168
       +
               type = types.nullOr types.path;

     

       169
       169
       +
               default = null;

     

       170
       170
       +
               description = ''

     

       171
       171
       +
                 File containing the secret token when using the Synapse HTTP Antispam module

     

       172
       172
       +
                 to be used in place of

     

       173
       173
       +
                 {option}`${opt.settings}.web.synapseHTTPAntispam.authorization`.

     

       174
       174
       +
       

     

       175
       175
       +
                 See <https://the-draupnir-project.github.io/draupnir-documentation/bot/synapse-http-antispam> for details.

     

       176
       176
       +
               '';

     

       177
       177
       +
             };

     

       178
       178
       +
           };

     

       179
       179
       +
         };

     

       180
       180
       +
       

     

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

     

       182
       182
       +
           assertions = [

     

       183
       183
       +
             {

     

       184
       184
       +
               # Removed option for those migrating from the Mjolnir module - mkRemovedOption module does *not* work with submodules.

     

       185
       185
       +
               assertion = !(cfg.settings ? protectedRooms);

     

       186
       186
       +
               message = "Unset ${opt.settings}.protectedRooms, as it is unsupported on Draupnir. Add these rooms via `!draupnir rooms add` instead.";

     

       187
       187
       +
             }

     

       188
       188
       +
           ];

     

       189
       189
       +
       

     

       190
       190
       +
           systemd.services.draupnir = {

     

       191
       191
       +
             description = "Draupnir - a moderation bot for Matrix";

     

       192
       192
       +
             wants = [

     

       193
       193
       +
               "network-online.target"

     

       194
       194
       +
               "matrix-synapse.service"

     

       195
       195
       +
               "conduit.service"

     

       196
       196
       +
               "dendrite.service"

     

       197
       197
       +
             ];

     

       198
       198
       +
             after = [

     

       199
       199
       +
               "network-online.target"

     

       200
       200
       +
               "matrix-synapse.service"

     

       201
       201
       +
               "conduit.service"

     

       202
       202
       +
               "dendrite.service"

     

       203
       203
       +
             ];

     

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

     

       205
       205
       +
       

     

       206
       206
       +
             startLimitIntervalSec = 0;

     

       207
       207
       +
             serviceConfig = {

     

       208
       208
       +
               ExecStart = toString (

     

       209
       209
       +
                 [

     

       210
       210
       +
                   (lib.getExe cfg.package)

     

       211
       211
       +
                   "--draupnir-config"

     

       212
       212
       +
                   configFile

     

       213
       213
       +
                 ]

     

       214
       214
       +
                 ++ lib.optionals (cfg.secrets.accessToken != null) [

     

       215
       215
       +
                   "--access-token-path"

     

       216
       216
       +
                   "%d/access_token"

     

       217
       217
       +
                 ]

     

       218
       218
       +
                 ++ lib.optionals (cfg.secrets.pantalaimon.password != null) [

     

       219
       219
       +
                   "--pantalaimon-password-path"

     

       220
       220
       +
                   "%d/pantalaimon_password"

     

       221
       221
       +
                 ]

     

       222
       222
       +
                 ++ lib.optionals (cfg.secrets.web.synapseHTTPAntispam.authorization != null) [

     

       223
       223
       +
                   "--http-antispam-authorization-path"

     

       224
       224
       +
                   "%d/http_antispam_authorization"

     

       225
       225
       +
                 ]

     

       226
       226
       +
               );

     

       227
       227
       +
       

     

       228
       228
       +
               WorkingDirectory = "/var/lib/draupnir";

     

       229
       229
       +
               StateDirectory = "draupnir";

     

       230
       230
       +
               StateDirectoryMode = "0700";

     

       231
       231
       +
               ProtectHome = true;

     

       232
       232
       +
               PrivateDevices = true;

     

       233
       233
       +
               Restart = "on-failure";

     

       234
       234
       +
               RestartSec = "5s";

     

       235
       235
       +
               DynamicUser = true;

     

       236
       236
       +
               LoadCredential =

     

       237
       237
       +
                 lib.optionals (cfg.secrets.accessToken != null) [

     

       238
       238
       +
                   "access_token:${cfg.secrets.accessToken}"

     

       239
       239
       +
                 ]

     

       240
       240
       +
                 ++ lib.optionals (cfg.secrets.pantalaimon.password != null) [

     

       241
       241
       +
                   "pantalaimon_password:${cfg.secrets.pantalaimon.password}"

     

       242
       242
       +
                 ]

     

       243
       243
       +
                 ++ lib.optionals (cfg.secrets.web.synapseHTTPAntispam.authorization != null) [

     

       244
       244
       +
                   "http_antispam_authorization:${cfg.secrets.web.synapseHTTPAntispam.authorization}"

     

       245
       245
       +
                 ];

     

       246
       246
       +
             };

     

       247
       247
       +
           };

     

       248
       248
       +
         };

     

       249
       249
       +
       

     

       250
       250
       +
         meta = {

     

       251
       251
       +
           doc = ./draupnir.md;

     

       252
       252
       +
           maintainers = with lib.maintainers; [

     

       253
       253
       +
             RorySys

     

       254
       254
       +
             emilylange

     

       255
       255
       +
           ];

     

       256
       256
       +
         };

     

       257
       257
       +
       }