commit 3ad01858c5e0316de7a7e40568ed217a126e5fb7 · pyrox.dev/nixpkgs

nixos/modules/module-list.nix

···

       1681
       1681
        
         ./services/web-apps/simplesamlphp.nix

     

       1682
       1682
        
         ./services/web-apps/slskd.nix

     

       1683
       1683
        
         ./services/web-apps/snipe-it.nix

     

       1684
       1684
       +
         ./services/web-apps/snips-sh.nix

     

       1684
       1685
        
         ./services/web-apps/sogo.nix

     

       1685
       1686
        
         ./services/web-apps/stash.nix

     

       1686
       1687
        
         ./services/web-apps/stirling-pdf.nix

+159

nixos/modules/services/web-apps/snips-sh.nix

···

       1
       1
       +
       {

     

       2
       2
       +
         config,

     

       3
       3
       +
         lib,

     

       4
       4
       +
         pkgs,

     

       5
       5
       +
         ...

     

       6
       6
       +
       }:

     

       7
       7
       +
       let

     

       8
       8
       +
         inherit (lib)

     

       9
       9
       +
           mkOption

     

       10
       10
       +
           mkEnableOption

     

       11
       11
       +
           mkPackageOption

     

       12
       12
       +
           mapAttrs

     

       13
       13
       +
           optional

     

       14
       14
       +
           boolToString

     

       15
       15
       +
           isBool

     

       16
       16
       +
           mkIf

     

       17
       17
       +
           getExe

     

       18
       18
       +
           types

     

       19
       19
       +
           ;

     

       20
       20
       +
       

     

       21
       21
       +
         cfg = config.services.snips-sh;

     

       22
       22
       +
       in

     

       23
       23
       +
       {

     

       24
       24
       +
         meta.maintainers = with lib.maintainers; [

     

       25
       25
       +
           isabelroses

     

       26
       26
       +
           NotAShelf

     

       27
       27
       +
         ];

     

       28
       28
       +
       

     

       29
       29
       +
         options.services.snips-sh = {

     

       30
       30
       +
           enable = mkEnableOption "snips.sh";

     

       31
       31
       +
       

     

       32
       32
       +
           package = mkPackageOption pkgs "snips-sh" {

     

       33
       33
       +
             example = "pkgs.snips-sh.override {withTensorflow = true;}";

     

       34
       34
       +
           };

     

       35
       35
       +
       

     

       36
       36
       +
           stateDir = mkOption {

     

       37
       37
       +
             type = types.path;

     

       38
       38
       +
             default = "/var/lib/snips-sh";

     

       39
       39
       +
             description = "The state directory of the service.";

     

       40
       40
       +
           };

     

       41
       41
       +
       

     

       42
       42
       +
           settings = mkOption {

     

       43
       43
       +
             type = types.submodule {

     

       44
       44
       +
               freeformType = types.attrsOf (

     

       45
       45
       +
                 types.nullOr (

     

       46
       46
       +
                   types.oneOf [

     

       47
       47
       +
                     types.str

     

       48
       48
       +
                     types.int

     

       49
       49
       +
                     types.bool

     

       50
       50
       +
                   ]

     

       51
       51
       +
                 )

     

       52
       52
       +
               );

     

       53
       53
       +
       

     

       54
       54
       +
               options = {

     

       55
       55
       +
                 SNIPS_HTTP_INTERNAL = mkOption {

     

       56
       56
       +
                   type = types.str;

     

       57
       57
       +
                   description = "The internal HTTP address of the service";

     

       58
       58
       +
                 };

     

       59
       59
       +
       

     

       60
       60
       +
                 SNIPS_SSH_INTERNAL = mkOption {

     

       61
       61
       +
                   type = types.str;

     

       62
       62
       +
                   description = "The internal SSH address of the service";

     

       63
       63
       +
                 };

     

       64
       64
       +
               };

     

       65
       65
       +
             };

     

       66
       66
       +
       

     

       67
       67
       +
             default = { };

     

       68
       68
       +
             example = {

     

       69
       69
       +
               SNIPS_HTTP_INTERNAL = "http://0.0.0.0:8080";

     

       70
       70
       +
               SNIPS_SSH_INTERNAL = "ssh://0.0.0.0:2222";

     

       71
       71
       +
             };

     

       72
       72
       +
       

     

       73
       73
       +
             description = ''

     

       74
       74
       +
               The configuration of snips-sh is done through environment variables,

     

       75
       75
       +
               therefore you must use upper snake case (e.g. {env}`SNIPS_HTTP_INTERNAL`).

     

       76
       76
       +
       

     

       77
       77
       +
               Based on the attributes passed to this config option an environment file will be generated

     

       78
       78
       +
               that is passed to snips-sh's systemd service.

     

       79
       79
       +
       

     

       80
       80
       +
               The available configuration options can be found in

     

       81
       81
       +
               [self-hosting guide](https://github.com/robherley/snips.sh/blob/main/docs/self-hosting.md#configuration) to

     

       82
       82
       +
               find about the environment variables you can use.

     

       83
       83
       +
             '';

     

       84
       84
       +
           };

     

       85
       85
       +
       

     

       86
       86
       +
           environmentFile = mkOption {

     

       87
       87
       +
             type = with types; nullOr path;

     

       88
       88
       +
             default = null;

     

       89
       89
       +
             example = "/etc/snips-sh.env";

     

       90
       90
       +
             description = ''

     

       91
       91
       +
               Additional environment file as defined in {manpage}`systemd.exec(5)`.

     

       92
       92
       +
       

     

       93
       93
       +
               Sensitive secrets such as {env}`SNIPS_SSH_HOSTKEYPATH` and {env}`SNIPS_METRICS_STATSD`

     

       94
       94
       +
               may be passed to the service while avoiding potentially making them world-readable in the nix store or

     

       95
       95
       +
               to convert an existing non-nix installation with minimum hassle.

     

       96
       96
       +
       

     

       97
       97
       +
               Note that this file needs to be available on the host on which

     

       98
       98
       +
               `snips-sh` is running.

     

       99
       99
       +
             '';

     

       100
       100
       +
           };

     

       101
       101
       +
         };

     

       102
       102
       +
       

     

       103
       103
       +
         config = mkIf cfg.enable {

     

       104
       104
       +
           systemd = {

     

       105
       105
       +
             tmpfiles.settings."10-snips-sh" = {

     

       106
       106
       +
               "${cfg.stateDir}/data".D = {

     

       107
       107
       +
                 mode = "0755";

     

       108
       108
       +
               };

     

       109
       109
       +
             };

     

       110
       110
       +
       

     

       111
       111
       +
             services.snips-sh = {

     

       112
       112
       +
               wants = [ "network-online.target" ];

     

       113
       113
       +
               after = [ "network-online.target" ];

     

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

     

       115
       115
       +
       

     

       116
       116
       +
               environment = mapAttrs (_: v: if isBool v then boolToString v else toString v) cfg.settings;

     

       117
       117
       +
       

     

       118
       118
       +
               serviceConfig = {

     

       119
       119
       +
                 EnvironmentFile = optional (cfg.environmentFile != null) cfg.environmentFile;

     

       120
       120
       +
                 ExecStart = getExe cfg.package;

     

       121
       121
       +
                 LimitNOFILE = "1048576";

     

       122
       122
       +
                 AmbientCapabilities = "CAP_NET_BIND_SERVICE";

     

       123
       123
       +
                 WorkingDirectory = cfg.stateDir;

     

       124
       124
       +
                 RuntimeDirectory = "snips-sh";

     

       125
       125
       +
                 StateDirectory = "snips-sh";

     

       126
       126
       +
                 StateDirectoryMode = "0700";

     

       127
       127
       +
                 Restart = "always";

     

       128
       128
       +
       

     

       129
       129
       +
                 # hardening

     

       130
       130
       +
                 DynamicUser = true;

     

       131
       131
       +
                 NoNewPrivileges = true;

     

       132
       132
       +
                 ProtectSystem = "strict";

     

       133
       133
       +
                 ProtectHome = true;

     

       134
       134
       +
                 ProtectHostname = true;

     

       135
       135
       +
                 ProtectClock = true;

     

       136
       136
       +
                 ProtectKernelLogs = true;

     

       137
       137
       +
                 ProtectKernelModules = true;

     

       138
       138
       +
                 ProtectKernelTunables = true;

     

       139
       139
       +
                 ProtectControlGroups = true;

     

       140
       140
       +
                 PrivateTmp = true;

     

       141
       141
       +
                 PrivateDevices = true;

     

       142
       142
       +
                 PrivateUsers = true;

     

       143
       143
       +
                 RestrictAddressFamilies = [

     

       144
       144
       +
                   "AF_INET"

     

       145
       145
       +
                   "AF_INET6"

     

       146
       146
       +
                   "AF_UNIX"

     

       147
       147
       +
                 ];

     

       148
       148
       +
                 RestrictNamespaces = true;

     

       149
       149
       +
                 RestrictSUIDSGID = true;

     

       150
       150
       +
                 SystemCallFilter = "@system-service";

     

       151
       151
       +
                 LockPersonality = true;

     

       152
       152
       +
                 MemoryDenyWriteExecute = true;

     

       153
       153
       +
                 CapabilityBoundingSet = "CAP_NET_BIND_SERVICE";

     

       154
       154
       +
                 RemoveIPC = true;

     

       155
       155
       +
               };

     

       156
       156
       +
             };

     

       157
       157
       +
           };

     

       158
       158
       +
         };

     

       159
       159
       +
       }