commit 00e9e54702c7df302a930c1041c3cf262c5a6f33 · pyrox.dev/nixpkgs

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

···

       25
        
       

     

       26
        
       - [Playerctld](https://github.com/altdesktop/playerctl), a daemon to track media player activity. Available as [services.playerctld](option.html#opt-services.playerctld).

     

       27
        
       

     

       0
        
       
     

       0
        
       
     

       28
        
       ## Backward Incompatibilities {#sec-release-24.11-incompatibilities}

     

       29
        
       

     

       30
        
       - `transmission` package has been aliased with a `trace` warning to `transmission_3`. Since [Transmission 4 has been released last year](https://github.com/transmission/transmission/releases/tag/4.0.0), and Transmission 3 will eventually go away, it was decided perform this warning alias to make people aware of the new version. The `services.transmission.package` defaults to `transmission_3` as well because the upgrade can cause data loss in certain specific usage patterns (examples: [#5153](https://github.com/transmission/transmission/issues/5153), [#6796](https://github.com/transmission/transmission/issues/6796)). Please make sure to back up to your data directory per your usage:

···

       25
        
       

     

       26
        
       - [Playerctld](https://github.com/altdesktop/playerctl), a daemon to track media player activity. Available as [services.playerctld](option.html#opt-services.playerctld).

     

       27
        
       

     

       28
       +
       - [Glance](https://github.com/glanceapp/glance), a self-hosted dashboard that puts all your feeds in one place. Available as [services.glance](option.html#opt-services.glance).

     

       29
       +
       

     

       30
        
       ## Backward Incompatibilities {#sec-release-24.11-incompatibilities}

     

       31
        
       

     

       32
        
       - `transmission` package has been aliased with a `trace` warning to `transmission_3`. Since [Transmission 4 has been released last year](https://github.com/transmission/transmission/releases/tag/4.0.0), and Transmission 3 will eventually go away, it was decided perform this warning alias to make people aware of the new version. The `services.transmission.package` defaults to `transmission_3` as well because the upgrade can cause data loss in certain specific usage patterns (examples: [#5153](https://github.com/transmission/transmission/issues/5153), [#6796](https://github.com/transmission/transmission/issues/6796)). Please make sure to back up to your data directory per your usage:

nixos/modules/module-list.nix

···

       1379
        
         ./services/web-apps/freshrss.nix

     

       1380
        
         ./services/web-apps/galene.nix

     

       1381
        
         ./services/web-apps/gerrit.nix

     

       0
        
       
     

       1382
        
         ./services/web-apps/gotify-server.nix

     

       1383
        
         ./services/web-apps/gotosocial.nix

     

       1384
        
         ./services/web-apps/grocy.nix

···

       1379
        
         ./services/web-apps/freshrss.nix

     

       1380
        
         ./services/web-apps/galene.nix

     

       1381
        
         ./services/web-apps/gerrit.nix

     

       1382
       +
         ./services/web-apps/glance.nix

     

       1383
        
         ./services/web-apps/gotify-server.nix

     

       1384
        
         ./services/web-apps/gotosocial.nix

     

       1385
        
         ./services/web-apps/grocy.nix

+39

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

···

       1
       +
       # Glance {#module-services-glance}

     

       2
       +
       

     

       3
       +
       Glance is a self-hosted dashboard that puts all your feeds in one place.

     

       4
       +
       

     

       5
       +
       Visit [the Glance project page](https://github.com/glanceapp/glance) to learn

     

       6
       +
       more about it.

     

       7
       +
       

     

       8
       +
       ## Quickstart {#module-services-glance-quickstart}

     

       9
       +
       

     

       10
       +
       Checkout the [configuration docs](https://github.com/glanceapp/glance/blob/main/docs/configuration.md) to learn more.

     

       11
       +
       Use the following configuration to start a public instance of Glance locally:

     

       12
       +
       

     

       13
       +
       ```nix

     

       14
       +
       {

     

       15
       +
         services.glance = {

     

       16
       +
           enable = true;

     

       17
       +
           settings = {

     

       18
       +
             pages = [

     

       19
       +
               {

     

       20
       +
                 name = "Home";

     

       21
       +
                 columns = [

     

       22
       +
                   {

     

       23
       +
                     size = "full";

     

       24
       +
                     widgets = [

     

       25
       +
                       { type = "calendar"; }

     

       26
       +
                       {

     

       27
       +
                         type = "weather";

     

       28
       +
                         location = "Nivelles, Belgium";

     

       29
       +
                       }

     

       30
       +
                     ];

     

       31
       +
                   }

     

       32
       +
                 ];

     

       33
       +
               }

     

       34
       +
             ];

     

       35
       +
           };

     

       36
       +
           openFirewall = true;

     

       37
       +
         };

     

       38
       +
       }

     

       39
       +
       ```

+141

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

···

       1
       +
       {

     

       2
       +
         config,

     

       3
       +
         lib,

     

       4
       +
         pkgs,

     

       5
       +
         ...

     

       6
       +
       }:

     

       7
       +
       let

     

       8
       +
         cfg = config.services.glance;

     

       9
       +
       

     

       10
       +
         inherit (lib)

     

       11
       +
           mkEnableOption

     

       12
       +
           mkPackageOption

     

       13
       +
           mkOption

     

       14
       +
           mkIf

     

       15
       +
           getExe

     

       16
       +
           types

     

       17
       +
           ;

     

       18
       +
       

     

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

     

       20
       +
       in

     

       21
       +
       {

     

       22
       +
         options.services.glance = {

     

       23
       +
           enable = mkEnableOption "glance";

     

       24
       +
           package = mkPackageOption pkgs "glance" { };

     

       25
       +
       

     

       26
       +
           settings = mkOption {

     

       27
       +
             type = types.submodule {

     

       28
       +
               freeformType = settingsFormat.type;

     

       29
       +
               options = {

     

       30
       +
                 server = {

     

       31
       +
                   host = mkOption {

     

       32
       +
                     description = "Glance bind address";

     

       33
       +
                     default = "127.0.0.1";

     

       34
       +
                     example = "0.0.0.0";

     

       35
       +
                     type = types.str;

     

       36
       +
                   };

     

       37
       +
                   port = mkOption {

     

       38
       +
                     description = "Glance port to listen on";

     

       39
       +
                     default = 8080;

     

       40
       +
                     example = 5678;

     

       41
       +
                     type = types.port;

     

       42
       +
                   };

     

       43
       +
                 };

     

       44
       +
                 pages = mkOption {

     

       45
       +
                   type = settingsFormat.type;

     

       46
       +
                   description = ''

     

       47
       +
                     List of pages to be present on the dashboard.

     

       48
       +
       

     

       49
       +
                     See <https://github.com/glanceapp/glance/blob/main/docs/configuration.md#pages--columns>

     

       50
       +
                   '';

     

       51
       +
                   default = [

     

       52
       +
                     {

     

       53
       +
                       name = "Calendar";

     

       54
       +
                       columns = [

     

       55
       +
                         {

     

       56
       +
                           size = "full";

     

       57
       +
                           widgets = [ { type = "calendar"; } ];

     

       58
       +
                         }

     

       59
       +
                       ];

     

       60
       +
                     }

     

       61
       +
                   ];

     

       62
       +
                   example = [

     

       63
       +
                     {

     

       64
       +
                       name = "Home";

     

       65
       +
                       columns = [

     

       66
       +
                         {

     

       67
       +
                           size = "full";

     

       68
       +
                           widgets = [

     

       69
       +
                             { type = "calendar"; }

     

       70
       +
                             {

     

       71
       +
                               type = "weather";

     

       72
       +
                               location = "Nivelles, Belgium";

     

       73
       +
                             }

     

       74
       +
                           ];

     

       75
       +
                         }

     

       76
       +
                       ];

     

       77
       +
                     }

     

       78
       +
                   ];

     

       79
       +
                 };

     

       80
       +
               };

     

       81
       +
             };

     

       82
       +
             default = { };

     

       83
       +
             description = ''

     

       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.

     

       87
       +
             '';

     

       88
       +
           };

     

       89
       +
       

     

       90
       +
           openFirewall = mkOption {

     

       91
       +
             type = types.bool;

     

       92
       +
             default = false;

     

       93
       +
             description = ''

     

       94
       +
               Whether to open the firewall for Glance.

     

       95
       +
               This adds `services.glance.settings.server.port` to `networking.firewall.allowedTCPPorts`.

     

       96
       +
             '';

     

       97
       +
           };

     

       98
       +
         };

     

       99
       +
       

     

       100
       +
         config = mkIf cfg.enable {

     

       101
       +
           systemd.services.glance = {

     

       102
       +
             description = "Glance feed dashboard server";

     

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

     

       104
       +
             after = [ "network.target" ];

     

       105
       +
       

     

       106
       +
             serviceConfig = {

     

       107
       +
               ExecStart =

     

       108
       +
                 let

     

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

     

       110
       +
                 in

     

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

     

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

     

       113
       +
               StateDirectory = "glance";

     

       114
       +
               RuntimeDirectory = "glance";

     

       115
       +
               RuntimeDirectoryMode = "0755";

     

       116
       +
               PrivateTmp = true;

     

       117
       +
               DynamicUser = true;

     

       118
       +
               DevicePolicy = "closed";

     

       119
       +
               LockPersonality = true;

     

       120
       +
               MemoryDenyWriteExecute = true;

     

       121
       +
               PrivateUsers = true;

     

       122
       +
               ProtectHome = true;

     

       123
       +
               ProtectHostname = true;

     

       124
       +
               ProtectKernelLogs = true;

     

       125
       +
               ProtectKernelModules = true;

     

       126
       +
               ProtectKernelTunables = true;

     

       127
       +
               ProtectControlGroups = true;

     

       128
       +
               ProcSubset = "pid";

     

       129
       +
               RestrictNamespaces = true;

     

       130
       +
               RestrictRealtime = true;

     

       131
       +
               SystemCallArchitectures = "native";

     

       132
       +
               UMask = "0077";

     

       133
       +
             };

     

       134
       +
           };

     

       135
       +
       

     

       136
       +
           networking.firewall = mkIf cfg.openFirewall { allowedTCPPorts = [ cfg.settings.server.port ]; };

     

       137
       +
         };

     

       138
       +
       

     

       139
       +
         meta.doc = ./glance.md;

     

       140
       +
         meta.maintainers = [ lib.maintainers.drupol ];

     

       141
       +
       }

nixos/tests/all-tests.nix

···

       361
        
         gitlab = runTest ./gitlab.nix;

     

       362
        
         gitolite = handleTest ./gitolite.nix {};

     

       363
        
         gitolite-fcgiwrap = handleTest ./gitolite-fcgiwrap.nix {};

     

       0
        
       
     

       364
        
         glusterfs = handleTest ./glusterfs.nix {};

     

       365
        
         gnome = handleTest ./gnome.nix {};

     

       366
        
         gnome-extensions = handleTest ./gnome-extensions.nix {};

···

       361
        
         gitlab = runTest ./gitlab.nix;

     

       362
        
         gitolite = handleTest ./gitolite.nix {};

     

       363
        
         gitolite-fcgiwrap = handleTest ./gitolite-fcgiwrap.nix {};

     

       364
       +
         glance = runTest ./glance.nix;

     

       365
        
         glusterfs = handleTest ./glusterfs.nix {};

     

       366
        
         gnome = handleTest ./gnome.nix {};

     

       367
        
         gnome-extensions = handleTest ./gnome-extensions.nix {};

+36

nixos/tests/glance.nix

···

       1
       +
       { lib, ... }:

     

       2
       +
       

     

       3
       +
       {

     

       4
       +
         name = "glance";

     

       5
       +
       

     

       6
       +
         nodes = {

     

       7
       +
           machine_default =

     

       8
       +
             { pkgs, ... }:

     

       9
       +
             {

     

       10
       +
               services.glance = {

     

       11
       +
                 enable = true;

     

       12
       +
               };

     

       13
       +
             };

     

       14
       +
       

     

       15
       +
           machine_custom_port =

     

       16
       +
             { pkgs, ... }:

     

       17
       +
             {

     

       18
       +
               services.glance = {

     

       19
       +
                 enable = true;

     

       20
       +
                 settings.server.port = 5678;

     

       21
       +
               };

     

       22
       +
             };

     

       23
       +
         };

     

       24
       +
       

     

       25
       +
         testScript = ''

     

       26
       +
           machine_default.start()

     

       27
       +
           machine_default.wait_for_unit("glance.service")

     

       28
       +
           machine_default.wait_for_open_port(8080)

     

       29
       +
       

     

       30
       +
           machine_custom_port.start()

     

       31
       +
           machine_custom_port.wait_for_unit("glance.service")

     

       32
       +
           machine_custom_port.wait_for_open_port(5678)

     

       33
       +
         '';

     

       34
       +
       

     

       35
       +
         meta.maintainers = [ lib.maintainers.drupol ];

     

       36
       +
       }