commit c9086d88376ef142ef8879154aead7e77de53faf · pyrox.dev/nixpkgs

nixos/modules/module-list.nix

···

       1550
       1550
        
         ./services/web-servers/phpfpm/default.nix

     

       1551
       1551
        
         ./services/web-servers/pomerium.nix

     

       1552
       1552
        
         ./services/web-servers/rustus.nix

     

       1553
       1553
       +
         ./services/web-servers/send.nix

     

       1553
       1554
        
         ./services/web-servers/stargazer.nix

     

       1554
       1555
        
         ./services/web-servers/static-web-server.nix

     

       1555
       1556
        
         ./services/web-servers/tomcat.nix

+228

nixos/modules/services/web-servers/send.nix

···

       1
       1
       +
       {

     

       2
       2
       +
         config,

     

       3
       3
       +
         lib,

     

       4
       4
       +
         pkgs,

     

       5
       5
       +
         ...

     

       6
       6
       +
       }:

     

       7
       7
       +
       let

     

       8
       8
       +
         inherit (lib) mkOption types;

     

       9
       9
       +
         cfg = config.services.send;

     

       10
       10
       +
       in

     

       11
       11
       +
       {

     

       12
       12
       +
         options = {

     

       13
       13
       +
           services.send = {

     

       14
       14
       +
             enable = lib.mkEnableOption "Send, a file sharing web sevice for ffsend.";

     

       15
       15
       +
       

     

       16
       16
       +
             package = lib.mkPackageOption pkgs "send" { };

     

       17
       17
       +
       

     

       18
       18
       +
             environment = mkOption {

     

       19
       19
       +
               type =

     

       20
       20
       +
                 with types;

     

       21
       21
       +
                 attrsOf (

     

       22
       22
       +
                   nullOr (oneOf [

     

       23
       23
       +
                     bool

     

       24
       24
       +
                     int

     

       25
       25
       +
                     str

     

       26
       26
       +
                     (listOf int)

     

       27
       27
       +
                   ])

     

       28
       28
       +
                 );

     

       29
       29
       +
               description = ''

     

       30
       30
       +
                 All the available config options and their defaults can be found here: https://github.com/timvisee/send/blob/master/server/config.js,

     

       31
       31
       +
                 some descriptions can found here: https://github.com/timvisee/send/blob/master/docs/docker.md#environment-variables

     

       32
       32
       +
       

     

       33
       33
       +
                 Values under {option}`services.send.environment` will override the predefined values in the Send service.

     

       34
       34
       +
                   - Time/duration should be in seconds

     

       35
       35
       +
                   - Filesize values should be in bytes

     

       36
       36
       +
               '';

     

       37
       37
       +
               example = {

     

       38
       38
       +
                 DEFAULT_DOWNLOADS = 1;

     

       39
       39
       +
                 DETECT_BASE_URL = true;

     

       40
       40
       +
                 EXPIRE_TIMES_SECONDS = [

     

       41
       41
       +
                   300

     

       42
       42
       +
                   3600

     

       43
       43
       +
                   86400

     

       44
       44
       +
                   604800

     

       45
       45
       +
                 ];

     

       46
       46
       +
               };

     

       47
       47
       +
             };

     

       48
       48
       +
       

     

       49
       49
       +
             dataDir = lib.mkOption {

     

       50
       50
       +
               type = types.path;

     

       51
       51
       +
               readOnly = true;

     

       52
       52
       +
               default = "/var/lib/send";

     

       53
       53
       +
               description = ''

     

       54
       54
       +
                 Directory for uploaded files.

     

       55
       55
       +
                 Due to limitations in {option}`systemd.services.send.serviceConfig.DynamicUser`, this item is read only.

     

       56
       56
       +
               '';

     

       57
       57
       +
             };

     

       58
       58
       +
       

     

       59
       59
       +
             baseUrl = mkOption {

     

       60
       60
       +
               type = types.nullOr types.str;

     

       61
       61
       +
               default = null;

     

       62
       62
       +
               description = ''

     

       63
       63
       +
                 Base URL for the Send service.

     

       64
       64
       +
                 Leave it blank to automatically detect the base url.

     

       65
       65
       +
               '';

     

       66
       66
       +
             };

     

       67
       67
       +
       

     

       68
       68
       +
             host = lib.mkOption {

     

       69
       69
       +
               type = types.str;

     

       70
       70
       +
               default = "127.0.0.1";

     

       71
       71
       +
               description = "The hostname or IP address for Send to bind to.";

     

       72
       72
       +
             };

     

       73
       73
       +
       

     

       74
       74
       +
             port = lib.mkOption {

     

       75
       75
       +
               type = types.port;

     

       76
       76
       +
               default = 1443;

     

       77
       77
       +
               description = "Port the Send service listens on.";

     

       78
       78
       +
             };

     

       79
       79
       +
       

     

       80
       80
       +
             openFirewall = lib.mkOption {

     

       81
       81
       +
               type = types.bool;

     

       82
       82
       +
               default = false;

     

       83
       83
       +
               description = "Whether to open firewall ports for send";

     

       84
       84
       +
             };

     

       85
       85
       +
       

     

       86
       86
       +
             redis = {

     

       87
       87
       +
               createLocally = lib.mkOption {

     

       88
       88
       +
                 type = types.bool;

     

       89
       89
       +
                 default = true;

     

       90
       90
       +
                 description = "Whether to create a local redis automatically.";

     

       91
       91
       +
               };

     

       92
       92
       +
       

     

       93
       93
       +
               name = lib.mkOption {

     

       94
       94
       +
                 type = types.str;

     

       95
       95
       +
                 default = "send";

     

       96
       96
       +
                 description = ''

     

       97
       97
       +
                   Name of the redis server.

     

       98
       98
       +
                   Only used if {option}`services.send.redis.createLocally` is set to true.

     

       99
       99
       +
                 '';

     

       100
       100
       +
               };

     

       101
       101
       +
       

     

       102
       102
       +
               host = lib.mkOption {

     

       103
       103
       +
                 type = types.str;

     

       104
       104
       +
                 default = "localhost";

     

       105
       105
       +
                 description = "Redis server address.";

     

       106
       106
       +
               };

     

       107
       107
       +
       

     

       108
       108
       +
               port = lib.mkOption {

     

       109
       109
       +
                 type = types.port;

     

       110
       110
       +
                 default = 6379;

     

       111
       111
       +
                 description = "Port of the redis server.";

     

       112
       112
       +
               };

     

       113
       113
       +
       

     

       114
       114
       +
               passwordFile = mkOption {

     

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

     

       116
       116
       +
                 default = null;

     

       117
       117
       +
                 example = "/run/agenix/send-redis-password";

     

       118
       118
       +
                 description = ''

     

       119
       119
       +
                   The path to the file containing the Redis password.

     

       120
       120
       +
       

     

       121
       121
       +
                   If {option}`services.send.redis.createLocally` is set to true,

     

       122
       122
       +
                   the content of this file will be used as the password for the locally created Redis instance.

     

       123
       123
       +
       

     

       124
       124
       +
                   Leave it blank if no password is required.

     

       125
       125
       +
                 '';

     

       126
       126
       +
               };

     

       127
       127
       +
             };

     

       128
       128
       +
           };

     

       129
       129
       +
         };

     

       130
       130
       +
       

     

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

     

       132
       132
       +
       

     

       133
       133
       +
           services.send.environment.DETECT_BASE_URL = cfg.baseUrl == null;

     

       134
       134
       +
       

     

       135
       135
       +
           assertions = [

     

       136
       136
       +
             {

     

       137
       137
       +
               assertion = cfg.redis.createLocally -> cfg.redis.host == "localhost";

     

       138
       138
       +
               message = "the redis host must be localhost if services.send.redis.createLocally is set to true";

     

       139
       139
       +
             }

     

       140
       140
       +
           ];

     

       141
       141
       +
       

     

       142
       142
       +
           networking.firewall.allowedTCPPorts = lib.optional cfg.openFirewall cfg.port;

     

       143
       143
       +
       

     

       144
       144
       +
           services.redis = lib.optionalAttrs cfg.redis.createLocally {

     

       145
       145
       +
             servers."${cfg.redis.name}" = {

     

       146
       146
       +
               enable = true;

     

       147
       147
       +
               bind = "localhost";

     

       148
       148
       +
               port = cfg.redis.port;

     

       149
       149
       +
             };

     

       150
       150
       +
           };

     

       151
       151
       +
       

     

       152
       152
       +
           systemd.services.send = {

     

       153
       153
       +
             serviceConfig = {

     

       154
       154
       +
               Type = "simple";

     

       155
       155
       +
               Restart = "always";

     

       156
       156
       +
               StateDirectory = "send";

     

       157
       157
       +
               WorkingDirectory = cfg.dataDir;

     

       158
       158
       +
               ReadWritePaths = cfg.dataDir;

     

       159
       159
       +
               LoadCredential = lib.optionalString (

     

       160
       160
       +
                 cfg.redis.passwordFile != null

     

       161
       161
       +
               ) "redis-password:${cfg.redis.passwordFile}";

     

       162
       162
       +
       

     

       163
       163
       +
               # Hardening

     

       164
       164
       +
               RestrictAddressFamilies = [

     

       165
       165
       +
                 "AF_UNIX"

     

       166
       166
       +
                 "AF_INET"

     

       167
       167
       +
                 "AF_INET6"

     

       168
       168
       +
               ];

     

       169
       169
       +
               AmbientCapabilities = lib.optionalString (cfg.port < 1024) "cap_net_bind_service";

     

       170
       170
       +
               DynamicUser = true;

     

       171
       171
       +
               CapabilityBoundingSet = "";

     

       172
       172
       +
               NoNewPrivileges = true;

     

       173
       173
       +
               RemoveIPC = true;

     

       174
       174
       +
               PrivateTmp = true;

     

       175
       175
       +
               ProcSubset = "pid";

     

       176
       176
       +
               ProtectClock = true;

     

       177
       177
       +
               ProtectControlGroups = true;

     

       178
       178
       +
               ProtectHome = true;

     

       179
       179
       +
               ProtectHostname = true;

     

       180
       180
       +
               ProtectKernelLogs = true;

     

       181
       181
       +
               ProtectKernelModules = true;

     

       182
       182
       +
               ProtectKernelTunables = true;

     

       183
       183
       +
               ProtectProc = "invisible";

     

       184
       184
       +
               ProtectSystem = "full";

     

       185
       185
       +
               RestrictNamespaces = true;

     

       186
       186
       +
               RestrictRealtime = true;

     

       187
       187
       +
               RestrictSUIDSGID = true;

     

       188
       188
       +
               SystemCallArchitectures = "native";

     

       189
       189
       +
               UMask = "0077";

     

       190
       190
       +
             };

     

       191
       191
       +
             environment =

     

       192
       192
       +
               {

     

       193
       193
       +
                 IP_ADDRESS = cfg.host;

     

       194
       194
       +
                 PORT = toString cfg.port;

     

       195
       195
       +
                 BASE_URL = if (cfg.baseUrl == null) then "http://${cfg.host}:${toString cfg.port}" else cfg.baseUrl;

     

       196
       196
       +
                 FILE_DIR = cfg.dataDir + "/uploads";

     

       197
       197
       +
                 REDIS_HOST = cfg.redis.host;

     

       198
       198
       +
                 REDIS_PORT = toString cfg.redis.port;

     

       199
       199
       +
               }

     

       200
       200
       +
               // (lib.mapAttrs (

     

       201
       201
       +
                 name: value:

     

       202
       202
       +
                 if lib.isList value then

     

       203
       203
       +
                   "[" + lib.concatStringsSep ", " (map (x: toString x) value) + "]"

     

       204
       204
       +
                 else if lib.isBool value then

     

       205
       205
       +
                   lib.boolToString value

     

       206
       206
       +
                 else

     

       207
       207
       +
                   toString value

     

       208
       208
       +
               ) cfg.environment);

     

       209
       209
       +
             after =

     

       210
       210
       +
               [

     

       211
       211
       +
                 "network.target"

     

       212
       212
       +
               ]

     

       213
       213
       +
               ++ lib.optionals cfg.redis.createLocally [

     

       214
       214
       +
                 "redis-${cfg.redis.name}.service"

     

       215
       215
       +
               ];

     

       216
       216
       +
             description = "Send web service";

     

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

     

       218
       218
       +
             script = ''

     

       219
       219
       +
               ${lib.optionalString (cfg.redis.passwordFile != null) ''

     

       220
       220
       +
                 export REDIS_PASSWORD="$(cat $CREDENTIALS_DIRECTORY/redis-password)"

     

       221
       221
       +
               ''}

     

       222
       222
       +
               ${lib.getExe cfg.package}

     

       223
       223
       +
             '';

     

       224
       224
       +
           };

     

       225
       225
       +
         };

     

       226
       226
       +
       

     

       227
       227
       +
         meta.maintainers = with lib.maintainers; [ moraxyc ];

     

       228
       228
       +
       }

nixos/tests/all-tests.nix

···

       904
       904
        
         seafile = handleTest ./seafile.nix {};

     

       905
       905
        
         searx = runTest ./searx.nix;

     

       906
       906
        
         seatd = handleTest ./seatd.nix {};

     

       907
       907
       +
         send = runTest ./send.nix;

     

       907
       908
        
         service-runner = handleTest ./service-runner.nix {};

     

       908
       909
        
         sftpgo = runTest ./sftpgo.nix;

     

       909
       910
        
         sfxr-qt = handleTest ./sfxr-qt.nix {};

+34

nixos/tests/send.nix

···

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

     

       2
       2
       +
       {

     

       3
       3
       +
         name = "send";

     

       4
       4
       +
       

     

       5
       5
       +
         meta = {

     

       6
       6
       +
           maintainers = with lib.maintainers; [ moraxyc ];

     

       7
       7
       +
         };

     

       8
       8
       +
       

     

       9
       9
       +
         nodes.machine =

     

       10
       10
       +
           { pkgs, ... }:

     

       11
       11
       +
           {

     

       12
       12
       +
             environment.systemPackages = with pkgs; [

     

       13
       13
       +
               curl

     

       14
       14
       +
               ffsend

     

       15
       15
       +
             ];

     

       16
       16
       +
       

     

       17
       17
       +
             services.send = {

     

       18
       18
       +
               enable = true;

     

       19
       19
       +
             };

     

       20
       20
       +
           };

     

       21
       21
       +
       

     

       22
       22
       +
         testScript = ''

     

       23
       23
       +
           machine.wait_for_unit("send.service")

     

       24
       24
       +
       

     

       25
       25
       +
           machine.wait_for_open_port(1443)

     

       26
       26
       +
       

     

       27
       27
       +
           machine.succeed("curl --fail --max-time 10 http://127.0.0.1:1443")

     

       28
       28
       +
       

     

       29
       29
       +
           machine.succeed("echo HelloWorld > /tmp/test")

     

       30
       30
       +
           url = machine.succeed("ffsend upload -q -h http://127.0.0.1:1443/ /tmp/test")

     

       31
       31
       +
           machine.succeed(f'ffsend download --output /tmp/download {url}')

     

       32
       32
       +
           machine.succeed("cat /tmp/download | grep HelloWorld")

     

       33
       33
       +
         '';

     

       34
       34
       +
       }