commit 27d160b60bb2f46444f19f026d3f109b0571fd29 · pyrox.dev/nixpkgs

+56 -7

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

···

       8
        
         cfg = config.services.glance;

     

       9
        
       

     

       10
        
         inherit (lib)

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       11
        
           mkEnableOption

     

       12
       -
           mkPackageOption

     

       13
       -
           mkOption

     

       14
        
           mkIf

     

       15
       -
           getExe

     

       0
        
       
     

       16
        
           types

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       17
        
           ;

     

       18
        
       

     

       19
        
         settingsFormat = pkgs.formats.yaml { };

     

       0
        
       
     

       0
        
       
     

       20
        
       in

     

       21
        
       {

     

       22
        
         options.services.glance = {

     
···

       69
        
                             { type = "calendar"; }

     

       70
        
                             {

     

       71
        
                               type = "weather";

     

       72
       -
                               location = "Nivelles, Belgium";

     

       0
        
       
     

       0
        
       
     

       73
        
                             }

     

       74
        
                           ];

     

       75
        
                         }

     
···

       84
        
               Configuration written to a yaml file that is read by glance. See

     

       85
        
               <https://github.com/glanceapp/glance/blob/main/docs/configuration.md>

     

       86
        
               for more.

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       87
        
             '';

     

       88
        
           };

     

       89
        
       

     
···

       102
        
             description = "Glance feed dashboard server";

     

       103
        
             wantedBy = [ "multi-user.target" ];

     

       104
        
             after = [ "network.target" ];

     

       0
        
       
     

       105
        
       

     

       106
        
             serviceConfig = {

     

       107
       -
               ExecStart =

     

       108
        
                 let

     

       109
       -
                   glance-yaml = settingsFormat.generate "glance.yaml" cfg.settings;

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       110
        
                 in

     

       111
       -
                 "${getExe cfg.package} --config ${glance-yaml}";

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       112
        
               WorkingDirectory = "/var/lib/glance";

     

       113
        
               StateDirectory = "glance";

     

       114
        
               RuntimeDirectory = "glance";

···

       8
        
         cfg = config.services.glance;

     

       9
        
       

     

       10
        
         inherit (lib)

     

       11
       +
           catAttrs

     

       12
       +
           concatMapStrings

     

       13
       +
           getExe

     

       14
        
           mkEnableOption

     

       0
        
       
     

       0
        
       
     

       15
        
           mkIf

     

       16
       +
           mkOption

     

       17
       +
           mkPackageOption

     

       18
        
           types

     

       19
       +
           ;

     

       20
       +
       

     

       21
       +
         inherit (builtins)

     

       22
       +
           concatLists

     

       23
       +
           isAttrs

     

       24
       +
           isList

     

       25
       +
           attrNames

     

       26
       +
           getAttr

     

       27
        
           ;

     

       28
        
       

     

       29
        
         settingsFormat = pkgs.formats.yaml { };

     

       30
       +
         settingsFile = settingsFormat.generate "glance.yaml" cfg.settings;

     

       31
       +
         mergedSettingsFile = "/run/glance/glance.yaml";

     

       32
        
       in

     

       33
        
       {

     

       34
        
         options.services.glance = {

     
···

       81
        
                             { type = "calendar"; }

     

       82
        
                             {

     

       83
        
                               type = "weather";

     

       84
       +
                               location = {

     

       85
       +
                                 _secret = "/var/lib/secrets/glance/location";

     

       86
       +
                               };

     

       87
        
                             }

     

       88
        
                           ];

     

       89
        
                         }

     
···

       98
        
               Configuration written to a yaml file that is read by glance. See

     

       99
        
               <https://github.com/glanceapp/glance/blob/main/docs/configuration.md>

     

       100
        
               for more.

     

       101
       +
       

     

       102
       +
               Settings containing secret data should be set to an

     

       103
       +
               attribute set containing the attribute

     

       104
       +
               <literal>_secret</literal> - a string pointing to a file

     

       105
       +
               containing the value the option should be set to. See the

     

       106
       +
               example in `services.glance.settings.pages` at the weather widget

     

       107
       +
               with a location secret to get a better picture of this.

     

       108
        
             '';

     

       109
        
           };

     

       110
        
       

     
···

       123
        
             description = "Glance feed dashboard server";

     

       124
        
             wantedBy = [ "multi-user.target" ];

     

       125
        
             after = [ "network.target" ];

     

       126
       +
             path = [ pkgs.replace-secret ];

     

       127
        
       

     

       128
        
             serviceConfig = {

     

       129
       +
               ExecStartPre =

     

       130
        
                 let

     

       131
       +
                   findSecrets =

     

       132
       +
                     data:

     

       133
       +
                     if isAttrs data then

     

       134
       +
                       if data ? _secret then

     

       135
       +
                         [ data ]

     

       136
       +
                       else

     

       137
       +
                         concatLists (map (attr: findSecrets (getAttr attr data)) (attrNames data))

     

       138
       +
                     else if isList data then

     

       139
       +
                       concatLists (map findSecrets data)

     

       140
       +
                     else

     

       141
       +
                       [ ];

     

       142
       +
                   secretPaths = catAttrs "_secret" (findSecrets cfg.settings);

     

       143
       +
                   mkSecretReplacement = secretPath: ''

     

       144
       +
                     replace-secret ${

     

       145
       +
                       lib.escapeShellArgs [

     

       146
       +
                         "_secret: ${secretPath}"

     

       147
       +
                         secretPath

     

       148
       +
                         mergedSettingsFile

     

       149
       +
                       ]

     

       150
       +
                     }

     

       151
       +
                   '';

     

       152
       +
                   secretReplacements = concatMapStrings mkSecretReplacement secretPaths;

     

       153
        
                 in

     

       154
       +
                 # Use "+" to run as root because the secrets may not be accessible to glance

     

       155
       +
                 "+"

     

       156
       +
                 + pkgs.writeShellScript "glance-start-pre" ''

     

       157
       +
                   install -m 600 -o $USER ${settingsFile} ${mergedSettingsFile}

     

       158
       +
                   ${secretReplacements}

     

       159
       +
                 '';

     

       160
       +
               ExecStart = "${getExe cfg.package} --config ${mergedSettingsFile}";

     

       161
        
               WorkingDirectory = "/var/lib/glance";

     

       162
        
               StateDirectory = "glance";

     

       163
        
               RuntimeDirectory = "glance";

+42 -6

nixos/tests/glance.nix

···

       5
        
       

     

       6
        
         nodes = {

     

       7
        
           machine_default =

     

       8
       -
             { pkgs, ... }:

     

       9
        
             {

     

       10
        
               services.glance = {

     

       11
        
                 enable = true;

     

       12
        
               };

     

       13
        
             };

     

       14
        
       

     

       15
       -
           machine_custom_port =

     

       16
        
             { pkgs, ... }:

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       17
        
             {

     

       18
        
               services.glance = {

     

       19
        
                 enable = true;

     

       20
       -
                 settings.server.port = 5678;

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       21
        
               };

     

       22
        
             };

     

       23
        
         };

     
···

       25
        
         extraPythonPackages =

     

       26
        
           p: with p; [

     

       27
        
             beautifulsoup4

     

       0
        
       
     

       0
        
       
     

       28
        
             types-beautifulsoup4

     

       29
        
           ];

     

       30
        
       

     

       31
        
         testScript = ''

     

       32
        
           from bs4 import BeautifulSoup

     

       0
        
       
     

       33
        
       

     

       34
        
           machine_default.start()

     

       35
        
           machine_default.wait_for_unit("glance.service")

     

       36
        
           machine_default.wait_for_open_port(8080)

     

       37
        
       

     

       38
       -
           machine_custom_port.start()

     

       39
       -
           machine_custom_port.wait_for_unit("glance.service")

     

       40
       -
           machine_custom_port.wait_for_open_port(5678)

     

       41
        
       

     

       42
        
           soup = BeautifulSoup(machine_default.succeed("curl http://localhost:8080"))

     

       43
        
           expected_version = "v${config.nodes.machine_default.services.glance.package.version}"

     

       44
        
           assert any(a.text == expected_version for a in soup.select(".footer a"))

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       45
        
         '';

     

       46
        
       

     

       47
        
         meta.maintainers = [ lib.maintainers.drupol ];

···

       5
        
       

     

       6
        
         nodes = {

     

       7
        
           machine_default =

     

       8
       +
             { ... }:

     

       9
        
             {

     

       10
        
               services.glance = {

     

       11
        
                 enable = true;

     

       12
        
               };

     

       13
        
             };

     

       14
        
       

     

       15
       +
           machine_configured =

     

       16
        
             { pkgs, ... }:

     

       17
       +
             let

     

       18
       +
               # Do not use this in production. This will make the secret world-readable

     

       19
       +
               # in the Nix store

     

       20
       +
               secrets.glance-location.path = builtins.toString (

     

       21
       +
                 pkgs.writeText "location-secret" "Nivelles, Belgium"

     

       22
       +
               );

     

       23
       +
             in

     

       24
        
             {

     

       25
        
               services.glance = {

     

       26
        
                 enable = true;

     

       27
       +
                 settings = {

     

       28
       +
                   server.port = 5678;

     

       29
       +
                   pages = [

     

       30
       +
                     {

     

       31
       +
                       name = "Home";

     

       32
       +
                       columns = [

     

       33
       +
                         {

     

       34
       +
                           size = "full";

     

       35
       +
                           widgets = [

     

       36
       +
                             { type = "calendar"; }

     

       37
       +
                             {

     

       38
       +
                               type = "weather";

     

       39
       +
                               location = {

     

       40
       +
                                 _secret = secrets.glance-location.path;

     

       41
       +
                               };

     

       42
       +
                             }

     

       43
       +
                           ];

     

       44
       +
                         }

     

       45
       +
                       ];

     

       46
       +
                     }

     

       47
       +
                   ];

     

       48
       +
                 };

     

       49
        
               };

     

       50
        
             };

     

       51
        
         };

     
···

       53
        
         extraPythonPackages =

     

       54
        
           p: with p; [

     

       55
        
             beautifulsoup4

     

       56
       +
             pyyaml

     

       57
       +
             types-pyyaml

     

       58
        
             types-beautifulsoup4

     

       59
        
           ];

     

       60
        
       

     

       61
        
         testScript = ''

     

       62
        
           from bs4 import BeautifulSoup

     

       63
       +
           import yaml

     

       64
        
       

     

       65
        
           machine_default.start()

     

       66
        
           machine_default.wait_for_unit("glance.service")

     

       67
        
           machine_default.wait_for_open_port(8080)

     

       68
        
       

     

       69
       +
           machine_configured.start()

     

       70
       +
           machine_configured.wait_for_unit("glance.service")

     

       71
       +
           machine_configured.wait_for_open_port(5678)

     

       72
        
       

     

       73
        
           soup = BeautifulSoup(machine_default.succeed("curl http://localhost:8080"))

     

       74
        
           expected_version = "v${config.nodes.machine_default.services.glance.package.version}"

     

       75
        
           assert any(a.text == expected_version for a in soup.select(".footer a"))

     

       76
       +
       

     

       77
       +
           yaml_contents = machine_configured.succeed("cat /run/glance/glance.yaml")

     

       78
       +
           yaml_parsed = yaml.load(yaml_contents, Loader=yaml.FullLoader)

     

       79
       +
           location = yaml_parsed["pages"][0]["columns"][0]["widgets"][1]["location"]

     

       80
       +
           assert location == "Nivelles, Belgium"

     

       81
        
         '';

     

       82
        
       

     

       83
        
         meta.maintainers = [ lib.maintainers.drupol ];