···

       
402
       
 
       


     

       
403
       
 
       
- `halloy` package was updated past 2024.5 which introduced a breaking change by switching the config format from YAML to TOML. See https://github.com/squidowl/halloy/releases/tag/2024.5 for details.

     

       
404
       
 
       


     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
405
       
 
       
- The `wpaperd` package has a breaking change moving to 1.0.1, previous version 0.3.0 had 2 different configuration files, one for wpaperd and one for the wallpapers. Remove the former and move the latter (`wallpaper.toml`) to `config.toml`.

     

       
406
       
 
       


     

       
407
       
 
       
- Ada packages (libraries and tools) have been moved into the `gnatPackages` scope. `gnatPackages` uses the default GNAT compiler, `gnat12Packages` and `gnat13Packages` use the respective matching compiler version.

     

···

       
402
       
 
       


     

       
403
       
 
       
- `halloy` package was updated past 2024.5 which introduced a breaking change by switching the config format from YAML to TOML. See https://github.com/squidowl/halloy/releases/tag/2024.5 for details.

     

       
404
       
 
       


     

       
405
       
+
       
- If `services.smokeping.webService` was enabled, smokeping is now served via nginx instead of thttpd. This change brings the following consequences:

     

       
406
       
+
       
  - The default port for smokeping is now the nginx default port 80 instead of 8081.

     

       
407
       
+
       
  - The option `services.smokeping.port` has been removed. To customize the port, use `services.nginx.virtualHosts.smokeping.listen.*.port`.

     

       
408
       
+
       


     

       
409
       
 
       
- The `wpaperd` package has a breaking change moving to 1.0.1, previous version 0.3.0 had 2 different configuration files, one for wpaperd and one for the wallpapers. Remove the former and move the latter (`wallpaper.toml`) to `config.toml`.

     

       
410
       
 
       


     

       
411
       
 
       
- Ada packages (libraries and tools) have been moved into the `gnatPackages` scope. `gnatPackages` uses the default GNAT compiler, `gnat12Packages` and `gnat13Packages` use the respective matching compiler version.

     

···

       
47
       
 
       
in

     

       
48
       
 
       


     

       
49
       
 
       
{

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
50
       
 
       
  options = {

     

       
51
       
 
       
    services.smokeping = {

     

       
52
       
 
       
      enable = mkEnableOption "smokeping service";

     
···

       
71
       
 
       
      };

     

       
72
       
 
       
      cgiUrl = mkOption {

     

       
73
       
 
       
        type = types.str;

     

       
74
       
-
       
        default = "http://${cfg.hostName}:${toString cfg.port}/smokeping.cgi";

     

       
75
       
-
       
        defaultText = literalExpression ''"http://''${hostName}:''${toString port}/smokeping.cgi"'';

     

       
76
       
 
       
        example = "https://somewhere.example.com/smokeping.cgi";

     

       
77
       
 
       
        description = "URL to the smokeping cgi.";

     

       
78
       
 
       
      };

     
···

       
176
       
 
       
          Setting it to `null` skips passing the -h option to thttpd,

     

       
177
       
 
       
          which makes it bind to all interfaces.

     

       
178
       
 
       
        '';

     

       
179
       
-
       
      };

     

       
180
       
-
       
      port = mkOption {

     

       
181
       
-
       
        type = types.port;

     

       
182
       
-
       
        default = 8081;

     

       
183
       
-
       
        description = "TCP port to use for the web server.";

     

       
184
       
 
       
      };

     

       
185
       
 
       
      presentationConfig = mkOption {

     

       
186
       
 
       
        type = types.lines;

     
···

       
312
       
 
       
      description = "smokeping daemon user";

     

       
313
       
 
       
      home = smokepingHome;

     

       
314
       
 
       
      createHome = true;

     

       
315
       
-
       
      # When `cfg.webService` is enabled, `thttpd` makes SmokePing available

     

       
316
       
-
       
      # under `${cfg.host}:${cfg.port}/smokeping.fcgi` as per the `ln -s` below.

     

       
317
       
-
       
      # We also want that going to `${cfg.host}:${cfg.port}` without `smokeping.fcgi`

     

       
318
       
-
       
      # makes it easy for the user to find SmokePing.

     

       
319
       
-
       
      # However `thttpd` does not seem to support easy redirections from `/` to `smokeping.fcgi`

     

       
320
       
-
       
      # and only allows directory listings or `/` -> `index.html` resolution if the directory

     

       
321
       
-
       
      # has `chmod 755` (see https://acme.com/software/thttpd/thttpd_man.html#PERMISSIONS,

     

       
322
       
-
       
      # " directories should be 755 if you want to allow indexing").

     

       
323
       
-
       
      # Otherwise it shows `403 Forbidden` on `/`.

     

       
324
       
-
       
      # Thus, we need to make `smokepingHome` (which is given to `thttpd -d` below) `755`.

     

       
325
       
-
       
      homeMode = "755";

     

       
326
       
 
       
    };

     

       
327
       
 
       
    users.groups.${cfg.user} = { };

     

       
328
       
 
       
    systemd.services.smokeping = {

     
···

       
342
       
 
       
        ${cfg.package}/bin/smokeping --static --config=${configPath}

     

       
343
       
 
       
      '';

     

       
344
       
 
       
    };

     

       
345
       
-
       
    systemd.services.thttpd = mkIf cfg.webService {

     

       
346
       
-
       
      requiredBy = [ "multi-user.target" ];

     

       
347
       
-
       
      requires = [ "smokeping.service" ];

     

       
348
       
-
       
      path = with pkgs; [ bash rrdtool smokeping thttpd ];

     

       
349
       
-
       
      serviceConfig = {

     

       
350
       
-
       
        Restart = "always";

     

       
351
       
-
       
        ExecStart = lib.concatStringsSep " " (lib.concatLists [

     

       
352
       
-
       
          [ "${pkgs.thttpd}/bin/thttpd" ]

     

       
353
       
-
       
          [ "-u ${cfg.user}" ]

     

       
354
       
-
       
          [ ''-c "**.fcgi"'' ]

     

       
355
       
-
       
          [ "-d ${smokepingHome}" ]

     

       
356
       
-
       
          (lib.optional (cfg.host != null) "-h ${cfg.host}")

     

       
357
       
-
       
          [ "-p ${builtins.toString cfg.port}" ]

     

       
358
       
-
       
          [ "-D -nos" ]

     

       
359
       
-
       
        ]);

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
360
       
 
       
      };

     

       
361
       
 
       
    };

     

       
362
       
 
       
  };

     

···

       
47
       
 
       
in

     

       
48
       
 
       


     

       
49
       
 
       
{

     

       
50
       
+
       
  imports = [

     

       
51
       
+
       
    (mkRemovedOptionModule [ "services" "smokeping" "port" ] ''

     

       
52
       
+
       
      The smokeping web service is now served by nginx.

     

       
53
       
+
       
      In order to change the port, you need to change the nginx configuration under `services.nginx.virtualHosts.smokeping.listen.*.port`.

     

       
54
       
+
       
    '')

     

       
55
       
+
       
  ];

     

       
56
       
+
       


     

       
57
       
 
       
  options = {

     

       
58
       
 
       
    services.smokeping = {

     

       
59
       
 
       
      enable = mkEnableOption "smokeping service";

     
···

       
78
       
 
       
      };

     

       
79
       
 
       
      cgiUrl = mkOption {

     

       
80
       
 
       
        type = types.str;

     

       
81
       
+
       
        default = "http://${cfg.hostName}/smokeping.cgi";

     

       
82
       
+
       
        defaultText = literalExpression ''"http://''${hostName}/smokeping.cgi"'';

     

       
83
       
 
       
        example = "https://somewhere.example.com/smokeping.cgi";

     

       
84
       
 
       
        description = "URL to the smokeping cgi.";

     

       
85
       
 
       
      };

     
···

       
183
       
 
       
          Setting it to `null` skips passing the -h option to thttpd,

     

       
184
       
 
       
          which makes it bind to all interfaces.

     

       
185
       
 
       
        '';

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
186
       
 
       
      };

     

       
187
       
 
       
      presentationConfig = mkOption {

     

       
188
       
 
       
        type = types.lines;

     
···

       
314
       
 
       
      description = "smokeping daemon user";

     

       
315
       
 
       
      home = smokepingHome;

     

       
316
       
 
       
      createHome = true;

     

       
317
       
+
       
      # When `cfg.webService` is enabled, `nginx` requires read permissions on the home directory.

     

       
318
       
+
       
      homeMode = "711";

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
319
       
 
       
    };

     

       
320
       
 
       
    users.groups.${cfg.user} = { };

     

       
321
       
 
       
    systemd.services.smokeping = {

     
···

       
335
       
 
       
        ${cfg.package}/bin/smokeping --static --config=${configPath}

     

       
336
       
 
       
      '';

     

       
337
       
 
       
    };

     

       
338
       
+
       


     

       
339
       
+
       
    # use nginx to serve the smokeping web service

     

       
340
       
+
       
    services.fcgiwrap.enable = mkIf cfg.webService true;

     

       
341
       
+
       
    services.nginx = mkIf cfg.webService {

     

       
342
       
+
       
      enable = true;

     

       
343
       
+
       
      virtualHosts."smokeping" = {

     

       
344
       
+
       
        serverName = mkDefault cfg.host;

     

       
345
       
+
       
        locations."/" = {

     

       
346
       
+
       
          root = smokepingHome;

     

       
347
       
+
       
          index = "smokeping.fcgi";

     

       
348
       
+
       
        };

     

       
349
       
+
       
        locations."/smokeping.fcgi" = {

     

       
350
       
+
       
          extraConfig = ''

     

       
351
       
+
       
            include ${config.services.nginx.package}/conf/fastcgi_params;

     

       
352
       
+
       
            fastcgi_pass unix:${config.services.fcgiwrap.socketAddress};

     

       
353
       
+
       
            fastcgi_param SCRIPT_FILENAME ${smokepingHome}/smokeping.fcgi;

     

       
354
       
+
       
            fastcgi_param DOCUMENT_ROOT ${smokepingHome};

     

       
355
       
+
       
          '';

     

       
356
       
+
       
        };

     

       
357
       
 
       
      };

     

       
358
       
 
       
    };

     

       
359
       
 
       
  };

     

···

       
11
       
 
       
        networking.domain = "example.com"; # FQDN: sm.example.com

     

       
12
       
 
       
        services.smokeping = {

     

       
13
       
 
       
          enable = true;

     

       
14
       
-
       
          port = 8081;

     

       
15
       
 
       
          mailHost = "127.0.0.2";

     

       
16
       
 
       
          probeConfig = ''

     

       
17
       
 
       
            + FPing

     
···

       
25
       
 
       
  testScript = ''

     

       
26
       
 
       
    start_all()

     

       
27
       
 
       
    sm.wait_for_unit("smokeping")

     

       
28
       
-
       
    sm.wait_for_unit("thttpd")

     

       
29
       
 
       
    sm.wait_for_file("/var/lib/smokeping/data/Local/LocalMachine.rrd")

     

       
30
       
-
       
    sm.succeed("curl -s -f localhost:8081/smokeping.fcgi?target=Local")

     

       
31
       
 
       
    # Check that there's a helpful page without explicit path as well.

     

       
32
       
-
       
    sm.succeed("curl -s -f localhost:8081")

     

       
33
       
 
       
    sm.succeed("ls /var/lib/smokeping/cache/Local/LocalMachine_mini.png")

     

       
34
       
 
       
    sm.succeed("ls /var/lib/smokeping/cache/index.html")

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
0
       
 
       

     

       
35
       
 
       
  '';

     

       
36
       
 
       
})

     

···

       
11
       
 
       
        networking.domain = "example.com"; # FQDN: sm.example.com

     

       
12
       
 
       
        services.smokeping = {

     

       
13
       
 
       
          enable = true;

     

       
0
       
 
       

     

       
14
       
 
       
          mailHost = "127.0.0.2";

     

       
15
       
 
       
          probeConfig = ''

     

       
16
       
 
       
            + FPing

     
···

       
24
       
 
       
  testScript = ''

     

       
25
       
 
       
    start_all()

     

       
26
       
 
       
    sm.wait_for_unit("smokeping")

     

       
27
       
+
       
    sm.wait_for_unit("nginx")

     

       
28
       
 
       
    sm.wait_for_file("/var/lib/smokeping/data/Local/LocalMachine.rrd")

     

       
29
       
+
       
    sm.succeed("curl -s -f localhost/smokeping.fcgi?target=Local")

     

       
30
       
 
       
    # Check that there's a helpful page without explicit path as well.

     

       
31
       
+
       
    sm.succeed("curl -s -f localhost")

     

       
32
       
 
       
    sm.succeed("ls /var/lib/smokeping/cache/Local/LocalMachine_mini.png")

     

       
33
       
 
       
    sm.succeed("ls /var/lib/smokeping/cache/index.html")

     

       
34
       
+
       


     

       
35
       
+
       
    # stop and start the service like nixos-rebuild would do

     

       
36
       
+
       
    # see https://github.com/NixOS/nixpkgs/issues/265953)

     

       
37
       
+
       
    sm.succeed("systemctl stop smokeping")

     

       
38
       
+
       
    sm.succeed("systemctl start smokeping")

     

       
39
       
+
       
    # ensure all services restarted properly

     

       
40
       
+
       
    sm.succeed("systemctl --failed | grep -q '0 loaded units listed'")

     

       
41
       
 
       
  '';

     

       
42
       
 
       
})