commit 965558108f6745e4060f73ea79de1a714956f219 · pyrox.dev/nixpkgs

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

···

       162
       162
        
       

     

       163
       163
        
       - [`yarr`](https://github.com/nkanaev/yarr), a small, web-based feed aggregator and RSS reader. Available as [services.yarr](#opt-services.yarr.enable).

     

       164
       164
        
       

     

       165
       165
       +
       - [OliveTin](https://www.olivetin.app/), gives safe and simple access to predefined shell commands from a web interface. Available as [services.olivetin](#opt-services.olivetin.enable).

     

       166
       166
       +
       

     

       165
       167
        
       - [Stash](https://github.com/stashapp/stash), An organizer for your adult videos/images, written in Go. Available as [services.stash](#opt-services.stash.enable).

     

       166
       168
        
       

     

       167
       169
        
       - [vsmartcard-vpcd](https://frankmorgner.github.io/vsmartcard/virtualsmartcard/README.html), a virtual smart card driver. Available as [services.vsmartcard-vpcd](#opt-services.vsmartcard-vpcd.enable).

nixos/modules/module-list.nix

···

       1604
       1604
        
         ./services/web-apps/mediagoblin.nix

     

       1605
       1605
        
         ./services/web-apps/open-web-calendar.nix

     

       1606
       1606
        
         ./services/web-apps/mobilizon.nix

     

       1607
       1607
       +
         ./services/web-apps/olivetin.nix

     

       1607
       1608
        
         ./services/web-apps/openwebrx.nix

     

       1608
       1609
        
         ./services/web-apps/outline.nix

     

       1609
       1610
        
         ./services/web-apps/pds.nix

+152

nixos/modules/services/web-apps/olivetin.nix

···

       1
       1
       +
       {

     

       2
       2
       +
         config,

     

       3
       3
       +
         pkgs,

     

       4
       4
       +
         lib,

     

       5
       5
       +
         ...

     

       6
       6
       +
       }:

     

       7
       7
       +
       

     

       8
       8
       +
       let

     

       9
       9
       +
         cfg = config.services.olivetin;

     

       10
       10
       +
       

     

       11
       11
       +
         settingsFormat = pkgs.formats.yaml { };

     

       12
       12
       +
       in

     

       13
       13
       +
       

     

       14
       14
       +
       {

     

       15
       15
       +
         meta.maintainers = with lib.maintainers; [ defelo ];

     

       16
       16
       +
       

     

       17
       17
       +
         options.services.olivetin = {

     

       18
       18
       +
           enable = lib.mkEnableOption "OliveTin";

     

       19
       19
       +
       

     

       20
       20
       +
           package = lib.mkPackageOption pkgs "olivetin" { };

     

       21
       21
       +
       

     

       22
       22
       +
           user = lib.mkOption {

     

       23
       23
       +
             type = lib.types.str;

     

       24
       24
       +
             description = "The user account under which OliveTin runs.";

     

       25
       25
       +
             default = "olivetin";

     

       26
       26
       +
           };

     

       27
       27
       +
       

     

       28
       28
       +
           group = lib.mkOption {

     

       29
       29
       +
             type = lib.types.str;

     

       30
       30
       +
             description = "The group under which OliveTin runs.";

     

       31
       31
       +
             default = "olivetin";

     

       32
       32
       +
           };

     

       33
       33
       +
       

     

       34
       34
       +
           path = lib.mkOption {

     

       35
       35
       +
             type =

     

       36
       36
       +
               with lib.types;

     

       37
       37
       +
               listOf (oneOf [

     

       38
       38
       +
                 package

     

       39
       39
       +
                 str

     

       40
       40
       +
               ]);

     

       41
       41
       +
             description = ''

     

       42
       42
       +
               Packages added to the service's {env}`PATH`.

     

       43
       43
       +
             '';

     

       44
       44
       +
             defaultText = lib.literalExpression ''

     

       45
       45
       +
               with pkgs; [ bash ]

     

       46
       46
       +
             '';

     

       47
       47
       +
           };

     

       48
       48
       +
       

     

       49
       49
       +
           settings = lib.mkOption {

     

       50
       50
       +
             description = ''

     

       51
       51
       +
               Configuration of OliveTin. See <https://docs.olivetin.app/config.html> for more information.

     

       52
       52
       +
             '';

     

       53
       53
       +
             default = { };

     

       54
       54
       +
       

     

       55
       55
       +
             type = lib.types.submodule {

     

       56
       56
       +
               freeformType = settingsFormat.type;

     

       57
       57
       +
       

     

       58
       58
       +
               options = {

     

       59
       59
       +
                 ListenAddressSingleHTTPFrontend = lib.mkOption {

     

       60
       60
       +
                   type = lib.types.str;

     

       61
       61
       +
                   description = ''

     

       62
       62
       +
                     The address to listen on for the internal "microproxy" frontend.

     

       63
       63
       +
                   '';

     

       64
       64
       +
                   default = "127.0.0.1:8000";

     

       65
       65
       +
                   example = "0.0.0.0:8000";

     

       66
       66
       +
                 };

     

       67
       67
       +
               };

     

       68
       68
       +
             };

     

       69
       69
       +
           };

     

       70
       70
       +
       

     

       71
       71
       +
           extraConfigFiles = lib.mkOption {

     

       72
       72
       +
             type = lib.types.listOf lib.types.path;

     

       73
       73
       +
             default = [ ];

     

       74
       74
       +
             example = [ "/run/secrets/olivetin.yaml" ];

     

       75
       75
       +
             description = ''

     

       76
       76
       +
               Config files to merge into the settings defined in [](#opt-services.olivetin.settings).

     

       77
       77
       +
               This is useful to avoid putting secrets into the nix store.

     

       78
       78
       +
               See <https://docs.olivetin.app/config.html> for more information.

     

       79
       79
       +
             '';

     

       80
       80
       +
           };

     

       81
       81
       +
         };

     

       82
       82
       +
       

     

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

     

       84
       84
       +
           services.olivetin = {

     

       85
       85
       +
             path = with pkgs; [ bash ];

     

       86
       86
       +
           };

     

       87
       87
       +
       

     

       88
       88
       +
           systemd.services.olivetin = {

     

       89
       89
       +
             description = "OliveTin";

     

       90
       90
       +
       

     

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

     

       92
       92
       +
       

     

       93
       93
       +
             wants = [

     

       94
       94
       +
               "network-online.target"

     

       95
       95
       +
               "local-fs.target"

     

       96
       96
       +
             ];

     

       97
       97
       +
             after = [

     

       98
       98
       +
               "network-online.target"

     

       99
       99
       +
               "local-fs.target"

     

       100
       100
       +
             ];

     

       101
       101
       +
       

     

       102
       102
       +
             inherit (cfg) path;

     

       103
       103
       +
       

     

       104
       104
       +
             preStart = ''

     

       105
       105
       +
               tmp="$(mktemp -d)"

     

       106
       106
       +
               trap 'rm -rf "$tmp"' EXIT

     

       107
       107
       +
               cd "$tmp"

     

       108
       108
       +
       

     

       109
       109
       +
               cp ${settingsFormat.generate "olivetin-config.yaml" cfg.settings} config.yaml

     

       110
       110
       +
               chmod +w config.yaml

     

       111
       111
       +
               for ((i=0; i < ${toString (lib.length cfg.extraConfigFiles)}; i++)); do

     

       112
       112
       +
                 ${lib.getExe pkgs.yq} -yi '

     

       113
       113
       +
                   def merge($y):

     

       114
       114
       +
                     . as $x |

     

       115
       115
       +
                     if ($x | type == "object") and ($y | type == "object") then

     

       116
       116
       +
                       $x + $y + with_entries(select(.key | in($y)) | .key as $key | .value |= merge($y[$key]))

     

       117
       117
       +
                     elif ($x | type == "array") and ($y | type == "array") then

     

       118
       118
       +
                       $x + $y

     

       119
       119
       +
                     else

     

       120
       120
       +
                       $y

     

       121
       121
       +
                     end;

     

       122
       122
       +
                   merge($f | fromjson)

     

       123
       123
       +
                 ' config.yaml --rawfile f <(${lib.getExe pkgs.yq} -c . "$CREDENTIALS_DIRECTORY/config-$i.yaml")

     

       124
       124
       +
               done

     

       125
       125
       +
               chmod -w config.yaml

     

       126
       126
       +
       

     

       127
       127
       +
               mkdir -p /run/olivetin/config

     

       128
       128
       +
               mv config.yaml /run/olivetin/config/config.yaml

     

       129
       129
       +
             '';

     

       130
       130
       +
       

     

       131
       131
       +
             serviceConfig = {

     

       132
       132
       +
               User = cfg.user;

     

       133
       133
       +
               Group = cfg.group;

     

       134
       134
       +
               RuntimeDirectory = "olivetin";

     

       135
       135
       +
               Restart = "always";

     

       136
       136
       +
       

     

       137
       137
       +
               LoadCredential = lib.imap0 (i: path: "config-${toString i}.yaml:${path}") cfg.extraConfigFiles;

     

       138
       138
       +
       

     

       139
       139
       +
               ExecStart = "${lib.getExe cfg.package} -configdir /run/olivetin/config";

     

       140
       140
       +
             };

     

       141
       141
       +
           };

     

       142
       142
       +
       

     

       143
       143
       +
           users.users = lib.mkIf (cfg.user == "olivetin") {

     

       144
       144
       +
             olivetin = {

     

       145
       145
       +
               group = cfg.group;

     

       146
       146
       +
               isSystemUser = true;

     

       147
       147
       +
             };

     

       148
       148
       +
           };

     

       149
       149
       +
       

     

       150
       150
       +
           users.groups = lib.mkIf (cfg.group == "olivetin") { olivetin = { }; };

     

       151
       151
       +
         };

     

       152
       152
       +
       }