librespeed: Fixes

config/services/librespeed.nix

@@ -1,7 +1,8 @@
-{ pkgs, ... }: {
+{ ... }: {
   services.librespeed = {
     enable = true;
-    package = pkgs.librespeed-go;
+    openFirewall = true;
     domain = "speed.kyouma.net";
+    frontend.enable = true;
   };
 }

modules/default.nix

@@ -1,11 +1,5 @@
-{ ... }: {
+{ lib, ... }: let
-  imports = [
+  mapModules = builtins.attrNames (lib.filterAttrs (_: type: type == "directory") (builtins.readDir ./.));
-    ./deployment
+in {
-    ./graphical
+  imports = builtins.map (dir: ./${dir}) mapModules;
-    ./librespeed
-    ./machine-type
-    ./nginx
-    ./ooklaserver
-    ./update-nixfiles
-  ];
 }

modules/librespeed/default.nix

@@ -7,37 +7,29 @@ in {
   in {
     enable = lib.mkEnableOption "LibreSpeed server";
     package = lib.mkPackageOption pkgs "librespeed-rust" {};
-    configureNginx = mkOption {
-      description = "Configure nginx as a reverse proxy for LibreSpeed.";
-      default = if (cfg.domain != null) then true else false;
-      type = types.bool;
-    };
-    contactEmail = mkOption {
-      description = "Email address listed in the privacy policy.";
-      default = if (cfg.domain != null) then "webmaster@${cfg.domain}" else "webmaster@${config.networking.fqdn}";
-      type = types.str;
-    };
     domain = mkOption {
       description = ''
         If not `null`, this will add an entry to `services.librespeed.servers` and
-        configure an nginx reverse proxy at the specified FQDN, unless explicitly disabled.
+        configure librespeed to use TLS.
       '';
       default = null;
       type = with types; nullOr nonEmptyStr;
     };
+    downloadIPDB = mkOption {
+      description = ''
+        Whether to download the IP info database before starting librespeed.
+        Disable this if you want to use the Go implementation.
+      '';
+      default = (!cfg.secrets ? "ipinfo_api_key");
+      type = types.bool;
+    };
     openFirewall = mkOption {
       description = ''
         Whether to open the firewall for the specified port.
-        This is only necessary if no reverse proxy is used.
       '';
       default = false;
       type = types.bool;
     };
-    pageTitle = mkOption {
-      description = "Title of the webpage.";
-      default = "LibreSpeed";
-      type = types.str;
-    };
     secrets = mkOption {
       description = ''
         Attribute set of filesystem paths.
@@ -46,6 +38,60 @@ in {
       default = {};
       type = with types; nullOr (attrsOf path);
     };
+    settings = mkOption {
+      description = ''
+        LibreSpeed configuration written as Nix expression.
+        All values set to `null` will be excluded from the evaluated config.
+        This is useful if you want to omit certain defaults when using a different LibreSpeed implementation.
+
+        See [github.com/librespeed][librespeed] for configuration help.
+
+        [librespeed]: https://github.com/librespeed/speedtest-rust
+      '';
+      default = {};
+      type = with types; nullOr (attrsOf (oneOf [
+        (nullOr bool)
+        int
+        str
+        package
+      ]));
+    };
+    frontend = {
+      enable = lib.mkEnableOption "LibreSpeed frontend.";
+      contactEmail = mkOption {
+        description = "Email address listed in the privacy policy.";
+        default = if (cfg.domain != null) then "webmaster@${cfg.domain}" else "webmaster@${config.networking.fqdn}";
+        type = types.str;
+      };
+      pageTitle = mkOption {
+        description = "Title of the webpage.";
+        default = "LibreSpeed";
+        type = types.str;
+      };
+      useNginx = mkOption {
+        description = ''
+          Configure nginx for the LibreSpeed frontend.
+          This will only create a virtual host for the frontend and won't proxy all requests,
+          because the reported upload and download speeds are inaccurate if proxied.
+        '';
+        default = cfg.domain != null;
+        type = types.bool;
+      };
+      settings = mkOption {
+        description = ''
+          Override default test parameters.
+          See [speedtest_worker.js][link] for a list of possible values.
+
+          [link]: https://github.com/librespeed/speedtest/blob/master/speedtest_worker.js#L39
+        '';
+        default = {};
+        type = with types; nullOr (attrsOf (oneOf [
+          bool
+          int
+          str
+          float
+        ]));
+      };
       servers = mkOption {
         description = "LibreSpeed servers that should apper in the server list.";
         type = types.listOf (types.submodule {
@@ -95,109 +141,105 @@ in {
           };
         });
       };
-    settings = mkOption {
-      description = ''
-        LibreSpeed configuration written as Nix expression.
-        All values set to `null` will be excluded from the evaluated config.
-        This is useful if you want to omit certain defaults when using a different LibreSpeed implementation.
-
-        See [github.com/librespeed][librespeed] for configuration help.
-
-        [librespeed]: https://github.com/librespeed/speedtest-rust
-      '';
-      default = {};
-      type = with types; nullOr (attrsOf (oneOf [
-        (nullOr bool)
-        int
-        str
-        package
-      ]));
     };
   };
-  config = lib.mkIf cfg.enable {
+  config = lib.mkIf cfg.enable (let
-    assertions = [
+    librespeedAssets = pkgs.runCommand "librespeed-assets" (let
-      {
+      mapValue = arg: if (lib.isBool arg) then
-        assertion = cfg.configureNginx -> cfg.domain != null;
+        lib.boolToString arg
-        message = ''
+      else if ((lib.isInt arg) || (lib.isFloat arg)) then
-          `services.librespeed.configureNginx` requires `services.librespeed.domain` to be set.
+        toString arg
-        '';
+      else
-      }
+        "\"${lib.escape [ "\"" ] (toString arg)}\"";
+
+      mapSettings = lib.pipe cfg.frontend.settings [
+        (lib.mapAttrs (name: val: "  s.setParameter(\"${lib.escape [ "\"" ] name}\",${mapValue val});"))
+        (lib.attrValues)
+        (lib.concatLines)
       ];
-
+    in {
-    networking.firewall = lib.mkIf (cfg.openFirewall) {
-      allowedTCPPorts = [ cfg.settings.listen_port ];
-    };
-    services.nginx.virtualHosts = lib.mkIf cfg.configureNginx {
-      ${cfg.domain} = {
-        locations."/" = {
-          proxyPass = "http://[::1]:${toString cfg.settings.listen_port}";
-          recommendedProxySettings = true;
-          extraConfig = ''
-            proxy_cache off;
-            proxy_buffering off;
-            proxy_request_buffering off;
-          '';
-        };
-        enableACME = true;
-        forceSSL = true;
-        extraConfig = ''
-          gzip off;
-        '';
-      };
-    };
-    security.acme.certs = lib.mkIf cfg.configureNginx {
-      ${cfg.domain} = {};
-    };
-
-    services.librespeed.servers = lib.mkIf (cfg.domain != null) [
-      {
-        name = cfg.domain;
-        server = "//${cfg.domain}${lib.optionalString (!cfg.configureNginx) ":${toString cfg.settings.listen_port}"}";
-      }
-    ];
-    services.librespeed.settings = let
-      inherit (lib) mkDefault mkIf;
-
-      assets = pkgs.runCommand "librespeed-assets" {
       preferLocal = true;
 
       serversList = ''
         function get_servers() {
-            return ${builtins.toJSON cfg.servers}
+          return ${builtins.toJSON cfg.frontend.servers}
+        }
+        function override_settings () {
+        ${mapSettings}
         }
       '';
-      } ''
+    }) ''
       cp -r ${pkgs.librespeed-rust}/assets $out
       chmod 666 $out/servers_list.js
       cat >$out/servers_list.js <<<"$serversList"
       substitute ${pkgs.librespeed-rust}/assets/index.html $out/index.html \
-          --replace-fail "LibreSpeed Example" ${lib.escapeShellArg (lib.escapeXML cfg.pageTitle)} \
+        --replace-fail "s.setParameter(\"telemetry_level\",\"basic\"); //enable telemetry" "override_settings();" \
-          --replace-fail "PUT@YOUR_EMAIL.HERE" ${lib.escapeShellArg (lib.escapeXML cfg.contactEmail)} \
+        --replace-fail "LibreSpeed Example" ${lib.escapeShellArg (lib.escapeXML cfg.frontend.pageTitle)} \
-          --replace-fail "TO BE FILLED BY DEVELOPER" ${lib.escapeShellArg (lib.escapeXML cfg.contactEmail)}
+        --replace-fail "PUT@YOUR_EMAIL.HERE" ${lib.escapeShellArg (lib.escapeXML cfg.frontend.contactEmail)} \
+        --replace-fail "TO BE FILLED BY DEVELOPER" ${lib.escapeShellArg (lib.escapeXML cfg.frontend.contactEmail)}
     '';
   in {
-      #speed_test_dir = assets;
+    assertions = [
-      assets_path = assets;
+      {
-      bind_address = mkDefault (if cfg.configureNginx then "::1" else "::");
+        assertion = cfg.frontend.useNginx -> cfg.domain != null;
-      listen_port = mkDefault 8989;
+        message = ''
-      #base_url = mkDefault "backend";
+          `services.librespeed.frontend.useNginx` requires `services.librespeed.frontend.domain` to be set.
-      #worker_threads = mkDefault "auto";
+        '';
+      }
+    ];
 
-      server_lat = 0;
+    networking.firewall = lib.mkIf cfg.openFirewall {
-      server_lng = 0;
+      allowedTCPPorts = [ cfg.settings.listen_port ];
-      proxyprotocol_port = 0;
+    };
-      redact_ip_addresses = false;
+    services.nginx.virtualHosts = lib.mkIf (cfg.frontend.enable && cfg.frontend.useNginx) {
+      ${cfg.domain} = {
+        locations."/".root = librespeedAssets;
+        locations."/backend/".extraConfig = "return 301 https://$host:${toString cfg.settings.listen_port}$request_uri;";
+        enableACME = true;
+        forceSSL = true;
+      };
+    };
+    security.acme.certs = lib.mkIf (cfg.domain != null) {
+      ${cfg.domain} = {
+        reloadServices = [ "librespeed.service" ];
+        webroot = "/var/lib/acme/acme-challange";
+      };
+    };
+
+    services.librespeed.frontend.servers = lib.mkIf (cfg.frontend.enable && (cfg.domain != null)) [
+      {
+        name = cfg.domain;
+        server = "//${cfg.domain}:${toString cfg.settings.listen_port}";
+      }
+    ];
+    services.librespeed.frontend.settings = lib.mkIf cfg.frontend.enable {
+      telemetry_level = "basic";
+      time_dl_max = 334;
+      time_auto = false;
+    };
+
+    services.librespeed.settings = let
+      inherit (lib) mkDefault mkIf;
+    in {
+      assets_path = if (cfg.frontend.enable && !cfg.frontend.useNginx) then librespeedAssets 
+      else pkgs.writeTextDir "index.html" "";
+
+      bind_address = mkDefault "::";
+      listen_port = mkDefault 8989;
+      base_url = mkDefault "backend";
+      worker_threads = mkDefault "auto";
+
+      database_type = mkDefault "none";
+      database_file = mkDefault "/var/lib/librespeed/speedtest.sqlite";
 
       #librespeed-rust will fail to start if the following config parameters are omitted.
       ipinfo_api_key = mkIf (!cfg.secrets ? "ipinfo_api_key") "";
       stats_password = mkIf (!cfg.secrets ? "stats_password") "";
-      #tls_key_file = mkDefault "";
+      tls_cert_file = if (cfg.domain != null) then (mkDefault "/run/credentials/librespeed.service/cert.pem") else (mkDefault "");
-      #tls_cet_file = mkDefault "";
+      tls_key_file = if (cfg.domain != null) then (mkDefault "/run/credentials/librespeed.service/key.pem") else (mkDefault "");
+
+      enable_tls = mkDefault (cfg.domain != null);
 
-      enable_tls = mkDefault false;
-    } // rec {
-      database_type = mkDefault "none";
-      database_file = mkIf (database_type == "sqlite") (mkDefault "/var/lib/librespeed/speedtest.sqlite");
     };
 
     systemd.services = let
@@ -255,7 +297,12 @@ in {
 
           DynamicUser = true;
 
-          #ExecStartPre = lib.mkIf (!cfg.secrets ? "ipinfo_api_key") "${lib.getExe cfg.package} --update-ipdb";
+          LoadCredential = lib.mkIf (cfg.domain != null) [
+            "cert.pem:${config.security.acme.certs.${cfg.domain}.directory}/cert.pem"
+            "key.pem:${config.security.acme.certs.${cfg.domain}.directory}/key.pem"
+          ];
+
+          ExecStartPre = lib.mkIf cfg.downloadIPDB "${lib.getExe cfg.package} --update-ipdb";
           ExecStart = "${lib.getExe cfg.package} -c ${if (cfg.secrets == {}) then configFile else "\${RUNTIME_DIRECTORY%%:*}/config.toml"}";
           WorkingDirectory = "/var/cache/librespeed";
           RuntimeDirectory = "librespeed";
@@ -287,7 +334,7 @@ in {
         };
       };
     };
-  };
+  });
 
   meta.maintainers = with lib.maintainers; [ snaki ];
 }

pkgs/librespeed-rust/default.nix

@@ -4,12 +4,12 @@
   rustPlatform,
 }:
 let
-  version = "1.3.2";
+  version = "unstable-2024-09-28";
   src = fetchFromGitHub {
     owner = "librespeed";
     repo = "speedtest-rust";
-    rev = "refs/tags/v${version}";
+    rev = "a74f25d07da3eb665ce806e015c537264f7254c9";
-    hash = "sha256-z3lORjjJ89o+Du4mvKGydwxHU6Ra2jU5ue5Zsl/oIfY=";
+    hash = "sha256-+G1DFHQONXXg/5apSBlBkRvuLT4qCJaeFnQSLWt0CD0=";
   };
 in
 rustPlatform.buildRustPackage {