commit a51a27a78b94f1d4525c604df1fb51eaaa1438d6 · pyrox.dev/nixpkgs

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

···

       150
       150
        
       

     

       151
       151
        
       - `paperless`' `services.paperless.extraConfig` setting has been removed and converted to the freeform type and option named `services.paperless.settings`.

     

       152
       152
        
       

     

       153
       153
       +
       - `services.homepage-dashboard` now takes it's configuration using native Nix expressions, rather than dumping templated configurations into `/var/lib/homepage-dashboard` where they were previously managed manually. There are now new options which allow the configuration of bookmarks, services, widgets and custom CSS/JS natively in Nix.

     

       154
       154
       +
       

     

       153
       155
        
       - The legacy and long deprecated systemd target `network-interfaces.target` has been removed. Use `network.target` instead.

     

       154
       156
        
       

     

       155
       157
        
       - `services.frp.settings` now generates the frp configuration file in TOML format as [recommended by upstream](https://github.com/fatedier/frp#configuration-files), instead of the legacy INI format. This has also introduced other changes in the configuration file structure and options.

+206 -18

nixos/modules/services/misc/homepage-dashboard.nix

···

       6
       6
        
       

     

       7
       7
        
       let

     

       8
       8
        
         cfg = config.services.homepage-dashboard;

     

       9
       9
       +
         # Define the settings format used for this program

     

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

     

       9
       11
        
       in

     

       10
       12
        
       {

     

       11
       13
        
         options = {

     
···

       25
       27
        
               default = 8082;

     

       26
       28
        
               description = lib.mdDoc "Port for Homepage to bind to.";

     

       27
       29
        
             };

     

       30
       30
       +
       

     

       31
       31
       +
             environmentFile = lib.mkOption {

     

       32
       32
       +
               type = lib.types.str;

     

       33
       33
       +
               description = ''

     

       34
       34
       +
                 The path to an environment file that contains environment variables to pass

     

       35
       35
       +
                 to the homepage-dashboard service, for the purpose of passing secrets to

     

       36
       36
       +
                 the service.

     

       37
       37
       +
       

     

       38
       38
       +
                 See the upstream documentation:

     

       39
       39
       +
       

     

       40
       40
       +
                 https://gethomepage.dev/latest/installation/docker/#using-environment-secrets

     

       41
       41
       +
               '';

     

       42
       42
       +
               default = "";

     

       43
       43
       +
             };

     

       44
       44
       +
       

     

       45
       45
       +
             customCSS = lib.mkOption {

     

       46
       46
       +
               type = lib.types.lines;

     

       47
       47
       +
               description = lib.mdDoc ''

     

       48
       48
       +
                 Custom CSS for styling Homepage.

     

       49
       49
       +
       

     

       50
       50
       +
                 See https://gethomepage.dev/latest/configs/custom-css-js/.

     

       51
       51
       +
               '';

     

       52
       52
       +
               default = "";

     

       53
       53
       +
             };

     

       54
       54
       +
       

     

       55
       55
       +
             customJS = lib.mkOption {

     

       56
       56
       +
               type = lib.types.lines;

     

       57
       57
       +
               description = lib.mdDoc ''

     

       58
       58
       +
                 Custom Javascript for Homepage.

     

       59
       59
       +
       

     

       60
       60
       +
                 See https://gethomepage.dev/latest/configs/custom-css-js/.

     

       61
       61
       +
               '';

     

       62
       62
       +
               default = "";

     

       63
       63
       +
             };

     

       64
       64
       +
       

     

       65
       65
       +
             bookmarks = lib.mkOption {

     

       66
       66
       +
               inherit (settingsFormat) type;

     

       67
       67
       +
               description = lib.mdDoc ''

     

       68
       68
       +
                 Homepage bookmarks configuration.

     

       69
       69
       +
       

     

       70
       70
       +
                 See https://gethomepage.dev/latest/configs/bookmarks/.

     

       71
       71
       +
               '';

     

       72
       72
       +
               # Defaults: https://github.com/gethomepage/homepage/blob/main/src/skeleton/bookmarks.yaml

     

       73
       73
       +
               example = [

     

       74
       74
       +
                 {

     

       75
       75
       +
                   Developer = [

     

       76
       76
       +
                     { Github = [{ abbr = "GH"; href = "https://github.com/"; }]; }

     

       77
       77
       +
                   ];

     

       78
       78
       +
                 }

     

       79
       79
       +
                 {

     

       80
       80
       +
                   Entertainment = [

     

       81
       81
       +
                     { YouTube = [{ abbr = "YT"; href = "https://youtube.com/"; }]; }

     

       82
       82
       +
                   ];

     

       83
       83
       +
                 }

     

       84
       84
       +
               ];

     

       85
       85
       +
               default = [ ];

     

       86
       86
       +
             };

     

       87
       87
       +
       

     

       88
       88
       +
             services = lib.mkOption {

     

       89
       89
       +
               inherit (settingsFormat) type;

     

       90
       90
       +
               description = lib.mdDoc ''

     

       91
       91
       +
                 Homepage services configuration.

     

       92
       92
       +
       

     

       93
       93
       +
                 See https://gethomepage.dev/latest/configs/services/.

     

       94
       94
       +
               '';

     

       95
       95
       +
               # Defaults: https://github.com/gethomepage/homepage/blob/main/src/skeleton/services.yaml

     

       96
       96
       +
               example = [

     

       97
       97
       +
                 {

     

       98
       98
       +
                   "My First Group" = [

     

       99
       99
       +
                     {

     

       100
       100
       +
                       "My First Service" = {

     

       101
       101
       +
                         href = "http://localhost/";

     

       102
       102
       +
                         description = "Homepage is awesome";

     

       103
       103
       +
                       };

     

       104
       104
       +
                     }

     

       105
       105
       +
                   ];

     

       106
       106
       +
                 }

     

       107
       107
       +
                 {

     

       108
       108
       +
                   "My Second Group" = [

     

       109
       109
       +
                     {

     

       110
       110
       +
                       "My Second Service" = {

     

       111
       111
       +
                         href = "http://localhost/";

     

       112
       112
       +
                         description = "Homepage is the best";

     

       113
       113
       +
                       };

     

       114
       114
       +
                     }

     

       115
       115
       +
                   ];

     

       116
       116
       +
                 }

     

       117
       117
       +
               ];

     

       118
       118
       +
               default = [ ];

     

       119
       119
       +
             };

     

       120
       120
       +
       

     

       121
       121
       +
             widgets = lib.mkOption {

     

       122
       122
       +
               inherit (settingsFormat) type;

     

       123
       123
       +
               description = lib.mdDoc ''

     

       124
       124
       +
                 Homepage widgets configuration.

     

       125
       125
       +
       

     

       126
       126
       +
                 See https://gethomepage.dev/latest/configs/service-widgets/.

     

       127
       127
       +
               '';

     

       128
       128
       +
               # Defaults: https://github.com/gethomepage/homepage/blob/main/src/skeleton/widgets.yaml

     

       129
       129
       +
               example = [

     

       130
       130
       +
                 {

     

       131
       131
       +
                   resources = {

     

       132
       132
       +
                     cpu = true;

     

       133
       133
       +
                     memory = true;

     

       134
       134
       +
                     disk = "/";

     

       135
       135
       +
                   };

     

       136
       136
       +
                 }

     

       137
       137
       +
                 {

     

       138
       138
       +
                   search = {

     

       139
       139
       +
                     provider = "duckduckgo";

     

       140
       140
       +
                     target = "_blank";

     

       141
       141
       +
                   };

     

       142
       142
       +
                 }

     

       143
       143
       +
               ];

     

       144
       144
       +
               default = [ ];

     

       145
       145
       +
             };

     

       146
       146
       +
       

     

       147
       147
       +
             kubernetes = lib.mkOption {

     

       148
       148
       +
               inherit (settingsFormat) type;

     

       149
       149
       +
               description = lib.mdDoc ''

     

       150
       150
       +
                 Homepage kubernetes configuration.

     

       151
       151
       +
       

     

       152
       152
       +
                 See https://gethomepage.dev/latest/configs/kubernetes/.

     

       153
       153
       +
               '';

     

       154
       154
       +
               default = { };

     

       155
       155
       +
             };

     

       156
       156
       +
       

     

       157
       157
       +
             docker = lib.mkOption {

     

       158
       158
       +
               inherit (settingsFormat) type;

     

       159
       159
       +
               description = lib.mdDoc ''

     

       160
       160
       +
                 Homepage docker configuration.

     

       161
       161
       +
       

     

       162
       162
       +
                 See https://gethomepage.dev/latest/configs/docker/.

     

       163
       163
       +
               '';

     

       164
       164
       +
               default = { };

     

       165
       165
       +
             };

     

       166
       166
       +
       

     

       167
       167
       +
             settings = lib.mkOption {

     

       168
       168
       +
               inherit (settingsFormat) type;

     

       169
       169
       +
               description = lib.mdDoc ''

     

       170
       170
       +
                 Homepage settings.

     

       171
       171
       +
       

     

       172
       172
       +
                 See https://gethomepage.dev/latest/configs/settings/.

     

       173
       173
       +
               '';

     

       174
       174
       +
               # Defaults: https://github.com/gethomepage/homepage/blob/main/src/skeleton/settings.yaml

     

       175
       175
       +
               default = { };

     

       176
       176
       +
             };

     

       28
       177
        
           };

     

       29
       178
        
         };

     

       30
       179
        
       

     

       31
       31
       -
         config = lib.mkIf cfg.enable {

     

       32
       32
       -
           systemd.services.homepage-dashboard = {

     

       33
       33
       -
             description = "Homepage Dashboard";

     

       34
       34
       -
             after = [ "network.target" ];

     

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

     

       180
       180
       +
         config =

     

       181
       181
       +
           let

     

       182
       182
       +
             # If homepage-dashboard is enabled, but none of the configuration values have been updated,

     

       183
       183
       +
             # then default to "unmanaged" configuration which is manually updated in

     

       184
       184
       +
             # var/lib/homepage-dashboard. This is to maintain backwards compatibility, and should be

     

       185
       185
       +
             # deprecated in a future release.

     

       186
       186
       +
             managedConfig = !(

     

       187
       187
       +
               cfg.bookmarks == [ ] &&

     

       188
       188
       +
               cfg.customCSS == "" &&

     

       189
       189
       +
               cfg.customJS == "" &&

     

       190
       190
       +
               cfg.docker == { } &&

     

       191
       191
       +
               cfg.kubernetes == { } &&

     

       192
       192
       +
               cfg.services == [ ] &&

     

       193
       193
       +
               cfg.settings == { } &&

     

       194
       194
       +
               cfg.widgets == [ ]

     

       195
       195
       +
             );

     

       196
       196
       +
       

     

       197
       197
       +
             configDir = if managedConfig then "/etc/homepage-dashboard" else "/var/lib/homepage-dashboard";

     

       36
       198
        
       

     

       37
       37
       -
             environment = {

     

       38
       38
       -
               HOMEPAGE_CONFIG_DIR = "/var/lib/homepage-dashboard";

     

       39
       39
       -
               PORT = "${toString cfg.listenPort}";

     

       199
       199
       +
             msg = "using unmanaged configuration for homepage-dashboard is deprecated and will be removed"

     

       200
       200
       +
               + " in 24.05. please see the NixOS documentation for `services.homepage-dashboard' and add"

     

       201
       201
       +
               + " your bookmarks, services, widgets, and other configuration using the options provided.";

     

       202
       202
       +
           in

     

       203
       203
       +
           lib.mkIf cfg.enable {

     

       204
       204
       +
             warnings = lib.optional (!managedConfig) msg;

     

       205
       205
       +
       

     

       206
       206
       +
             environment.etc = lib.mkIf managedConfig {

     

       207
       207
       +
               "homepage-dashboard/custom.css".text = cfg.customCSS;

     

       208
       208
       +
               "homepage-dashboard/custom.js".text = cfg.customJS;

     

       209
       209
       +
       

     

       210
       210
       +
               "homepage-dashboard/bookmarks.yaml".source = settingsFormat.generate "bookmarks.yaml" cfg.bookmarks;

     

       211
       211
       +
               "homepage-dashboard/docker.yaml".source = settingsFormat.generate "docker.yaml" cfg.docker;

     

       212
       212
       +
               "homepage-dashboard/kubernetes.yaml".source = settingsFormat.generate "kubernetes.yaml" cfg.kubernetes;

     

       213
       213
       +
               "homepage-dashboard/services.yaml".source = settingsFormat.generate "services.yaml" cfg.services;

     

       214
       214
       +
               "homepage-dashboard/settings.yaml".source = settingsFormat.generate "settings.yaml" cfg.settings;

     

       215
       215
       +
               "homepage-dashboard/widgets.yaml".source = settingsFormat.generate "widgets.yaml" cfg.widgets;

     

       40
       216
        
             };

     

       41
       217
        
       

     

       42
       42
       -
             serviceConfig = {

     

       43
       43
       -
               Type = "simple";

     

       44
       44
       -
               DynamicUser = true;

     

       45
       45
       -
               StateDirectory = "homepage-dashboard";

     

       46
       46
       -
               ExecStart = "${lib.getExe cfg.package}";

     

       47
       47
       -
               Restart = "on-failure";

     

       218
       218
       +
             systemd.services.homepage-dashboard = {

     

       219
       219
       +
               description = "Homepage Dashboard";

     

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

     

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

     

       222
       222
       +
       

     

       223
       223
       +
               environment = {

     

       224
       224
       +
                 HOMEPAGE_CONFIG_DIR = configDir;

     

       225
       225
       +
                 PORT = toString cfg.listenPort;

     

       226
       226
       +
                 LOG_TARGETS = lib.mkIf managedConfig "stdout";

     

       227
       227
       +
               };

     

       228
       228
       +
       

     

       229
       229
       +
               serviceConfig = {

     

       230
       230
       +
                 Type = "simple";

     

       231
       231
       +
                 DynamicUser = true;

     

       232
       232
       +
                 EnvironmentFile = lib.mkIf (cfg.environmentFile != null) cfg.environmentFile;

     

       233
       233
       +
                 StateDirectory = lib.mkIf (!managedConfig) "homepage-dashboard";

     

       234
       234
       +
                 ExecStart = lib.getExe cfg.package;

     

       235
       235
       +
                 Restart = "on-failure";

     

       236
       236
       +
               };

     

       48
       237
        
             };

     

       49
       49
       -
           };

     

       50
       238
        
       

     

       51
       51
       -
           networking.firewall = lib.mkIf cfg.openFirewall {

     

       52
       52
       -
             allowedTCPPorts = [ cfg.listenPort ];

     

       239
       239
       +
             networking.firewall = lib.mkIf cfg.openFirewall {

     

       240
       240
       +
               allowedTCPPorts = [ cfg.listenPort ];

     

       241
       241
       +
             };

     

       53
       242
        
           };

     

       54
       54
       -
         };

     

       55
       243
        
       }

+26 -4

nixos/tests/homepage-dashboard.nix

···

       2
       2
        
         name = "homepage-dashboard";

     

       3
       3
        
         meta.maintainers = with lib.maintainers; [ jnsgruk ];

     

       4
       4
        
       

     

       5
       5
       -
         nodes.machine = { pkgs, ... }: {

     

       5
       5
       +
         nodes.unmanaged_conf = { pkgs, ... }: {

     

       6
       6
        
           services.homepage-dashboard.enable = true;

     

       7
       7
        
         };

     

       8
       8
        
       

     

       9
       9
       +
         nodes.managed_conf = { pkgs, ... }: {

     

       10
       10
       +
           services.homepage-dashboard = {

     

       11
       11
       +
             enable = true;

     

       12
       12
       +
             settings.title = "custom";

     

       13
       13
       +
           };

     

       14
       14
       +
         };

     

       15
       15
       +
       

     

       9
       16
        
         testScript = ''

     

       10
       10
       -
           machine.wait_for_unit("homepage-dashboard.service")

     

       11
       11
       -
           machine.wait_for_open_port(8082)

     

       12
       12
       -
           machine.succeed("curl --fail http://localhost:8082/")

     

       17
       17
       +
           # Ensure the services are started on unmanaged machine

     

       18
       18
       +
           unmanaged_conf.wait_for_unit("homepage-dashboard.service")

     

       19
       19
       +
           unmanaged_conf.wait_for_open_port(8082)

     

       20
       20
       +
           unmanaged_conf.succeed("curl --fail http://localhost:8082/")

     

       21
       21
       +
       

     

       22
       22
       +
           # Ensure that /etc/homepage-dashboard doesn't exist, and boilerplate

     

       23
       23
       +
           # configs are copied into place.

     

       24
       24
       +
           unmanaged_conf.fail("test -d /etc/homepage-dashboard")

     

       25
       25
       +
           unmanaged_conf.succeed("test -f /var/lib/private/homepage-dashboard/settings.yaml")

     

       26
       26
       +
       

     

       27
       27
       +
           # Ensure the services are started on managed machine

     

       28
       28
       +
           managed_conf.wait_for_unit("homepage-dashboard.service")

     

       29
       29
       +
           managed_conf.wait_for_open_port(8082)

     

       30
       30
       +
           managed_conf.succeed("curl --fail http://localhost:8082/")

     

       31
       31
       +
       

     

       32
       32
       +
           # Ensure /etc/homepage-dashboard is created and unmanaged conf location isn't.

     

       33
       33
       +
           managed_conf.succeed("test -d /etc/homepage-dashboard")

     

       34
       34
       +
           managed_conf.fail("test -f /var/lib/private/homepage-dashboard/settings.yaml")

     

       13
       35
        
         '';

     

       14
       36
        
       })

+14

pkgs/servers/homepage-dashboard/default.nix

···

       39
       39
        
       

     

       40
       40
        
         npmDepsHash = "sha256-u15lDdXnV3xlXAC9WQQKLIeV/AgtRM1sFNsacw3j6kU=";

     

       41
       41
        
       

     

       42
       42
       +
         # This project is primarily designed to be consumed through Docker.

     

       43
       43
       +
         # By default it logs to stdout, and also to a directory. This makes

     

       44
       44
       +
         # little sense here where all the logs will be collated in the

     

       45
       45
       +
         # systemd journal anyway, so the patch removes the file logging.

     

       46
       46
       +
         # This patch has been suggested upstream, but the contribution won't

     

       47
       47
       +
         # be accepted until it gets at least 10 upvotes, per their policy:

     

       48
       48
       +
         # https://github.com/gethomepage/homepage/discussions/3067

     

       49
       49
       +
         patches = [

     

       50
       50
       +
           (fetchpatch {

     

       51
       51
       +
             url = "https://github.com/gethomepage/homepage/commit/3be28a2c8b68f2404e4083e7f32eebbccdc4d293.patch";

     

       52
       52
       +
             hash = "sha256-5fUOXiHBZ4gdPeOHe1NIaBLaHJTDImsRjSwtueQOEXY=";

     

       53
       53
       +
           })

     

       54
       54
       +
         ];

     

       55
       55
       +
       

     

       42
       56
        
         preBuild = ''

     

       43
       57
        
           mkdir -p config

     

       44
       58
        
         '';