forked from emily/nixfiles
librespeed: Fixes
This commit is contained in:
parent
f091338a53
commit
a74c1d8585
7 changed files with 405 additions and 295 deletions
|
@ -7,6 +7,7 @@
|
||||||
../../services/nginx.nix
|
../../services/nginx.nix
|
||||||
../../services/uptime-kuma.nix
|
../../services/uptime-kuma.nix
|
||||||
../../services/vaultwarden.nix
|
../../services/vaultwarden.nix
|
||||||
|
../../services/librespeed.nix
|
||||||
./disko.nix
|
./disko.nix
|
||||||
./hardware-configuration.nix
|
./hardware-configuration.nix
|
||||||
];
|
];
|
||||||
|
|
|
@ -8,7 +8,6 @@
|
||||||
../../services/nginx.nix
|
../../services/nginx.nix
|
||||||
../../services/hydra
|
../../services/hydra
|
||||||
../../services/update-nixfiles.nix
|
../../services/update-nixfiles.nix
|
||||||
../../services/librespeed.nix
|
|
||||||
];
|
];
|
||||||
boot.binfmt.emulatedSystems = [ "aarch64-linux" ];
|
boot.binfmt.emulatedSystems = [ "aarch64-linux" ];
|
||||||
|
|
||||||
|
|
|
@ -1,7 +1,8 @@
|
||||||
{ pkgs, ... }: {
|
{ ... }: {
|
||||||
services.librespeed = {
|
services.librespeed = {
|
||||||
enable = true;
|
enable = true;
|
||||||
package = pkgs.librespeed-go;
|
openFirewall = true;
|
||||||
domain = "speed.kyouma.net";
|
domain = "speed.kyouma.net";
|
||||||
|
frontend.enable = true;
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
|
@ -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
|
|
||||||
];
|
|
||||||
}
|
}
|
||||||
|
|
|
@ -187,7 +187,6 @@
|
||||||
enable = true;
|
enable = true;
|
||||||
sources.diagnostics = {
|
sources.diagnostics = {
|
||||||
pylint.enable = true;
|
pylint.enable = true;
|
||||||
statix.enable = true;
|
|
||||||
};
|
};
|
||||||
sources.formatting = {
|
sources.formatting = {
|
||||||
nixfmt.enable = true;
|
nixfmt.enable = true;
|
||||||
|
|
|
@ -1,293 +1,408 @@
|
||||||
{ config, lib, pkgs, ... }:
|
{
|
||||||
|
config,
|
||||||
|
lib,
|
||||||
|
pkgs,
|
||||||
|
...
|
||||||
|
}:
|
||||||
let
|
let
|
||||||
cfg = config.services.librespeed;
|
cfg = config.services.librespeed;
|
||||||
in {
|
in
|
||||||
options.services.librespeed = let
|
{
|
||||||
inherit (lib) mkOption types;
|
options.services.librespeed =
|
||||||
in {
|
let
|
||||||
enable = lib.mkEnableOption "LibreSpeed server";
|
inherit (lib) mkOption types;
|
||||||
package = lib.mkPackageOption pkgs "librespeed-rust" {};
|
in
|
||||||
configureNginx = mkOption {
|
{
|
||||||
description = "Configure nginx as a reverse proxy for LibreSpeed.";
|
enable = lib.mkEnableOption "LibreSpeed server";
|
||||||
default = if (cfg.domain != null) then true else false;
|
package = lib.mkPackageOption pkgs "librespeed-rust" { };
|
||||||
type = types.bool;
|
domain = mkOption {
|
||||||
};
|
description = ''
|
||||||
contactEmail = mkOption {
|
If not `null`, this will add an entry to `services.librespeed.servers` and
|
||||||
description = "Email address listed in the privacy policy.";
|
configure librespeed to use TLS.
|
||||||
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.
|
|
||||||
'';
|
|
||||||
default = null;
|
|
||||||
type = with types; nullOr nonEmptyStr;
|
|
||||||
};
|
|
||||||
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.
|
|
||||||
The contents of the specified paths will be read at service start time and merged with the attributes provided in `settings`.
|
|
||||||
'';
|
|
||||||
default = {};
|
|
||||||
type = with types; nullOr (attrsOf path);
|
|
||||||
};
|
|
||||||
servers = mkOption {
|
|
||||||
description = "LibreSpeed servers that should apper in the server list.";
|
|
||||||
type = types.listOf (types.submodule {
|
|
||||||
options = let
|
|
||||||
inherit (types) nonEmptyStr;
|
|
||||||
in {
|
|
||||||
name = mkOption {
|
|
||||||
description = "Name shown in the server list.";
|
|
||||||
type = nonEmptyStr;
|
|
||||||
};
|
|
||||||
server = mkOption {
|
|
||||||
description = "URL to the server. You may use `//` instead of `http://` or `https://`.";
|
|
||||||
type = nonEmptyStr;
|
|
||||||
};
|
|
||||||
dlURL = mkOption {
|
|
||||||
description = ''
|
|
||||||
URL path to download test on this server.
|
|
||||||
Append `.php` to the default value if the server uses the php implementation.
|
|
||||||
'';
|
|
||||||
default = "backend/garbage";
|
|
||||||
type = nonEmptyStr;
|
|
||||||
};
|
|
||||||
ulURL = mkOption {
|
|
||||||
description = ''
|
|
||||||
URL path to upload test on this server.
|
|
||||||
Append `.php` to the default value if the server uses the php implementation.
|
|
||||||
'';
|
|
||||||
default = "backend/empty";
|
|
||||||
type = nonEmptyStr;
|
|
||||||
};
|
|
||||||
pingURL = mkOption {
|
|
||||||
description = ''
|
|
||||||
URL path to latency/jitter test on this server.
|
|
||||||
Append `.php` to the default value if the server uses the php implementation.
|
|
||||||
'';
|
|
||||||
default = "backend/empty";
|
|
||||||
type = nonEmptyStr;
|
|
||||||
};
|
|
||||||
getIpURL = mkOption {
|
|
||||||
description = ''
|
|
||||||
URL path to IP lookup on this server.
|
|
||||||
Append `.php` to the default value if the server uses the php implementation.
|
|
||||||
'';
|
|
||||||
default = "backend/getIP";
|
|
||||||
type = nonEmptyStr;
|
|
||||||
};
|
|
||||||
};
|
|
||||||
});
|
|
||||||
};
|
|
||||||
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 {
|
|
||||||
assertions = [
|
|
||||||
{
|
|
||||||
assertion = cfg.configureNginx -> cfg.domain != null;
|
|
||||||
message = ''
|
|
||||||
`services.librespeed.configureNginx` requires `services.librespeed.domain` to be set.
|
|
||||||
'';
|
'';
|
||||||
}
|
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");
|
||||||
|
defaultText = lib.literalExpression ''!(cfg.secrets ? "ipinfo_api_key")'';
|
||||||
|
type = types.bool;
|
||||||
|
};
|
||||||
|
openFirewall = mkOption {
|
||||||
|
description = ''
|
||||||
|
Whether to open the firewall for the specified port.
|
||||||
|
'';
|
||||||
|
default = false;
|
||||||
|
type = types.bool;
|
||||||
|
};
|
||||||
|
secrets = mkOption {
|
||||||
|
description = ''
|
||||||
|
Attribute set of filesystem paths.
|
||||||
|
The contents of the specified paths will be read at service start time and merged with the attributes provided in `settings`.
|
||||||
|
'';
|
||||||
|
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.
|
||||||
|
|
||||||
networking.firewall = lib.mkIf (cfg.openFirewall) {
|
See [github.com/librespeed][librespeed] for configuration help.
|
||||||
allowedTCPPorts = [ cfg.settings.listen_port ];
|
|
||||||
};
|
[librespeed]: https://github.com/librespeed/speedtest-rust
|
||||||
services.nginx.virtualHosts = lib.mkIf cfg.configureNginx {
|
'';
|
||||||
${cfg.domain} = {
|
default = { };
|
||||||
locations."/" = {
|
type =
|
||||||
proxyPass = "http://[::1]:${toString cfg.settings.listen_port}";
|
with types;
|
||||||
recommendedProxySettings = true;
|
nullOr (
|
||||||
extraConfig = ''
|
attrsOf (oneOf [
|
||||||
proxy_cache off;
|
(nullOr bool)
|
||||||
proxy_buffering off;
|
int
|
||||||
proxy_request_buffering off;
|
str
|
||||||
|
package
|
||||||
|
])
|
||||||
|
);
|
||||||
|
};
|
||||||
|
frontend = {
|
||||||
|
enable = lib.mkEnableOption ''
|
||||||
|
Enables the LibreSpeed frontend and adds a nginx virtual host if
|
||||||
|
not explicetly disabled and `services.librespeed.domain` is not `null`.
|
||||||
|
'';
|
||||||
|
contactEmail = mkOption {
|
||||||
|
description = "Email address listed in the privacy policy.";
|
||||||
|
default =
|
||||||
|
if (cfg.domain != null) then "webmaster@${cfg.domain}" else "webmaster@${config.networking.fqdn}";
|
||||||
|
defaultText = lib.literalExpression ''
|
||||||
|
if (config.services.librespeed.domain != null) then
|
||||||
|
"webmaster@''${config.services.librespeed.domain}"
|
||||||
|
else
|
||||||
|
"webmaster@''${config.networking.fqdn}";
|
||||||
'';
|
'';
|
||||||
|
type = types.str;
|
||||||
};
|
};
|
||||||
enableACME = true;
|
pageTitle = mkOption {
|
||||||
forceSSL = true;
|
description = "Title of the webpage.";
|
||||||
extraConfig = ''
|
default = "LibreSpeed";
|
||||||
gzip off;
|
type = types.str;
|
||||||
'';
|
};
|
||||||
};
|
useNginx = mkOption {
|
||||||
};
|
description = ''
|
||||||
security.acme.certs = lib.mkIf cfg.configureNginx {
|
Configure nginx for the LibreSpeed frontend.
|
||||||
${cfg.domain} = {};
|
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;
|
||||||
|
defaultText = lib.literalExpression "config.services.librespeed.domain != null";
|
||||||
|
type = types.bool;
|
||||||
|
};
|
||||||
|
settings = mkOption {
|
||||||
|
description = ''
|
||||||
|
Override default settings of the speedtest web client.
|
||||||
|
See [speedtest_worker.js][link] for a list of possible values.
|
||||||
|
|
||||||
services.librespeed.servers = lib.mkIf (cfg.domain != null) [
|
[link]: https://github.com/librespeed/speedtest/blob/master/speedtest_worker.js#L39
|
||||||
{
|
'';
|
||||||
name = cfg.domain;
|
default = {
|
||||||
server = "//${cfg.domain}${lib.optionalString (!cfg.configureNginx) ":${toString cfg.settings.listen_port}"}";
|
telemetry_level = "basic";
|
||||||
}
|
|
||||||
];
|
|
||||||
services.librespeed.settings = let
|
|
||||||
inherit (lib) mkDefault mkIf;
|
|
||||||
|
|
||||||
assets = pkgs.runCommand "librespeed-assets" {
|
|
||||||
preferLocal = true;
|
|
||||||
|
|
||||||
serversList = ''
|
|
||||||
function get_servers() {
|
|
||||||
return ${builtins.toJSON cfg.servers}
|
|
||||||
}
|
|
||||||
'';
|
|
||||||
} ''
|
|
||||||
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 "PUT@YOUR_EMAIL.HERE" ${lib.escapeShellArg (lib.escapeXML cfg.contactEmail)} \
|
|
||||||
--replace-fail "TO BE FILLED BY DEVELOPER" ${lib.escapeShellArg (lib.escapeXML cfg.contactEmail)}
|
|
||||||
'';
|
|
||||||
in {
|
|
||||||
#speed_test_dir = assets;
|
|
||||||
assets_path = assets;
|
|
||||||
bind_address = mkDefault (if cfg.configureNginx then "::1" else "::");
|
|
||||||
listen_port = mkDefault 8989;
|
|
||||||
#base_url = mkDefault "backend";
|
|
||||||
#worker_threads = mkDefault "auto";
|
|
||||||
|
|
||||||
server_lat = 0;
|
|
||||||
server_lng = 0;
|
|
||||||
proxyprotocol_port = 0;
|
|
||||||
redact_ip_addresses = false;
|
|
||||||
|
|
||||||
#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_cet_file = mkDefault "";
|
|
||||||
|
|
||||||
enable_tls = mkDefault false;
|
|
||||||
} // rec {
|
|
||||||
database_type = mkDefault "none";
|
|
||||||
database_file = mkIf (database_type == "sqlite") (mkDefault "/var/lib/librespeed/speedtest.sqlite");
|
|
||||||
};
|
|
||||||
|
|
||||||
systemd.services = let
|
|
||||||
configFile = let
|
|
||||||
mapValue = arg: if (lib.isBool arg) then
|
|
||||||
lib.boolToString arg
|
|
||||||
else if (lib.isInt arg) then
|
|
||||||
toString arg
|
|
||||||
else "\"${lib.escape [ "\"" ] (toString arg)}\"";
|
|
||||||
in
|
|
||||||
with lib; pipe cfg.settings [
|
|
||||||
(filterAttrs (_: val: val != null))
|
|
||||||
(mapAttrs (name: val: "${name}=${mapValue val}"))
|
|
||||||
(attrValues)
|
|
||||||
(concatLines)
|
|
||||||
(pkgs.writeText "${cfg.package.name}-config.toml")
|
|
||||||
];
|
|
||||||
in {
|
|
||||||
librespeed-secrets = lib.mkIf (cfg.secrets != {}) {
|
|
||||||
description = "LibreSpeed secret helper";
|
|
||||||
|
|
||||||
ExecStart = let
|
|
||||||
script = pkgs.writeShellApplication {
|
|
||||||
name = "librespeed-secrets";
|
|
||||||
runtimeInputs = [ pkgs.coreutils ];
|
|
||||||
text = ''
|
|
||||||
cp ${configFile} ''${RUNTIME_DIRECTORY%%:*}/config.toml
|
|
||||||
'' + lib.pipe cfg.secrets [
|
|
||||||
(lib.mapAttrs (name: file: ''
|
|
||||||
cat >>''${RUNTIME_DIRECTORY%%:*}/config.toml <<EOF
|
|
||||||
${name}="$(<${lib.escapeShellArg file})"
|
|
||||||
EOF
|
|
||||||
''))
|
|
||||||
(lib.concatLines lib.attrValues)
|
|
||||||
];
|
|
||||||
};
|
};
|
||||||
in lib.getExe script;
|
type =
|
||||||
|
with types;
|
||||||
serviceConfig = {
|
nullOr (
|
||||||
Type = "oneshot";
|
attrsOf (oneOf [
|
||||||
RemainAfterExit = true;
|
bool
|
||||||
RuntimeDirectory = "librespeed";
|
int
|
||||||
UMask = "u=rw";
|
str
|
||||||
|
float
|
||||||
|
])
|
||||||
|
);
|
||||||
};
|
};
|
||||||
};
|
servers = mkOption {
|
||||||
librespeed = {
|
description = "LibreSpeed servers that should apper in the server list.";
|
||||||
description = "LibreSpeed server daemon";
|
type = types.listOf (
|
||||||
wantedBy = [ "multi-user.target" ];
|
types.submodule {
|
||||||
wants = [ "network-online.target" ];
|
options =
|
||||||
requires = lib.optionals (cfg.secrets != {}) [ "librespeed-secrets.service" ];
|
let
|
||||||
|
inherit (types) nonEmptyStr;
|
||||||
serviceConfig = {
|
in
|
||||||
Type = "simple";
|
{
|
||||||
Restart = "always";
|
name = mkOption {
|
||||||
|
description = "Name shown in the server list.";
|
||||||
DynamicUser = true;
|
type = nonEmptyStr;
|
||||||
|
};
|
||||||
#ExecStartPre = lib.mkIf (!cfg.secrets ? "ipinfo_api_key") "${lib.getExe cfg.package} --update-ipdb";
|
server = mkOption {
|
||||||
ExecStart = "${lib.getExe cfg.package} -c ${if (cfg.secrets == {}) then configFile else "\${RUNTIME_DIRECTORY%%:*}/config.toml"}";
|
description = "URL to the server. You may use `//` instead of `http://` or `https://`.";
|
||||||
WorkingDirectory = "/var/cache/librespeed";
|
type = nonEmptyStr;
|
||||||
RuntimeDirectory = "librespeed";
|
};
|
||||||
RuntimeDirectoryPreserve = true;
|
dlURL = mkOption {
|
||||||
StateDirectory = "librespeed";
|
description = ''
|
||||||
CacheDirectory = "librespeed";
|
URL path to download test on this server.
|
||||||
SyslogIdentifier = "librespeed";
|
Append `.php` to the default value if the server uses the php implementation.
|
||||||
|
'';
|
||||||
ReadOnlyPaths = [ cfg.package ];
|
default = "backend/garbage";
|
||||||
RestrictSUIDSGID = true;
|
type = nonEmptyStr;
|
||||||
RestrictNamespaces = true;
|
};
|
||||||
PrivateTmp = true;
|
ulURL = mkOption {
|
||||||
PrivateDevices = true;
|
description = ''
|
||||||
PrivateUsers = true;
|
URL path to upload test on this server.
|
||||||
ProtectHostname = true;
|
Append `.php` to the default value if the server uses the php implementation.
|
||||||
ProtectClock = true;
|
'';
|
||||||
ProtectKernelTunables = true;
|
default = "backend/empty";
|
||||||
ProtectKernelModules = true;
|
type = nonEmptyStr;
|
||||||
ProtectKernelLogs = true;
|
};
|
||||||
ProtectControlGroups = true;
|
pingURL = mkOption {
|
||||||
ProtectSystem = "strict";
|
description = ''
|
||||||
ProtectHome = true;
|
URL path to latency/jitter test on this server.
|
||||||
ProtectProc = "invisible";
|
Append `.php` to the default value if the server uses the php implementation.
|
||||||
SystemCallArchitectures = "native";
|
'';
|
||||||
SystemCallFilter = "@system-service";
|
default = "backend/empty";
|
||||||
SystemCallErrorNumber = "EPERM";
|
type = nonEmptyStr;
|
||||||
LockPersonality = true;
|
};
|
||||||
NoNewPrivileges = true;
|
getIpURL = mkOption {
|
||||||
|
description = ''
|
||||||
|
URL path to IP lookup on this server.
|
||||||
|
Append `.php` to the default value if the server uses the php implementation.
|
||||||
|
'';
|
||||||
|
default = "backend/getIP";
|
||||||
|
type = nonEmptyStr;
|
||||||
|
};
|
||||||
|
};
|
||||||
|
}
|
||||||
|
);
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
};
|
config = lib.mkIf cfg.enable (
|
||||||
|
let
|
||||||
|
librespeedAssets =
|
||||||
|
pkgs.runCommand "librespeed-assets"
|
||||||
|
(
|
||||||
|
let
|
||||||
|
mapValue =
|
||||||
|
arg:
|
||||||
|
if (lib.isBool arg) then
|
||||||
|
lib.boolToString arg
|
||||||
|
else if ((lib.isInt arg) || (lib.isFloat arg)) then
|
||||||
|
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
|
||||||
|
{
|
||||||
|
preferLocal = true;
|
||||||
|
|
||||||
|
serversList = ''
|
||||||
|
function get_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 "s.setParameter(\"telemetry_level\",\"basic\"); //enable telemetry" "override_settings();" \
|
||||||
|
--replace-fail "LibreSpeed Example" ${lib.escapeShellArg (lib.escapeXML cfg.frontend.pageTitle)} \
|
||||||
|
--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
|
||||||
|
{
|
||||||
|
assertions = [
|
||||||
|
{
|
||||||
|
assertion = cfg.frontend.useNginx -> cfg.domain != null;
|
||||||
|
message = ''
|
||||||
|
`services.librespeed.frontend.useNginx` requires `services.librespeed.frontend.domain` to be set.
|
||||||
|
'';
|
||||||
|
}
|
||||||
|
];
|
||||||
|
|
||||||
|
networking.firewall = lib.mkIf cfg.openFirewall {
|
||||||
|
allowedTCPPorts = [ cfg.settings.listen_port ];
|
||||||
|
};
|
||||||
|
services.nginx.virtualHosts = lib.mkIf (cfg.frontend.enable && cfg.frontend.useNginx) {
|
||||||
|
${cfg.domain} = {
|
||||||
|
locations."/".root = librespeedAssets;
|
||||||
|
locations."= /servers.json".return = "200 '${builtins.toJSON cfg.frontend.servers}'";
|
||||||
|
locations."/backend/".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-challenge";
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
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.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_cert_file =
|
||||||
|
if (cfg.domain != null) then
|
||||||
|
(mkDefault "/run/credentials/librespeed.service/cert.pem")
|
||||||
|
else
|
||||||
|
(mkDefault "");
|
||||||
|
tls_key_file =
|
||||||
|
if (cfg.domain != null) then
|
||||||
|
(mkDefault "/run/credentials/librespeed.service/key.pem")
|
||||||
|
else
|
||||||
|
(mkDefault "");
|
||||||
|
|
||||||
|
enable_tls = mkDefault (cfg.domain != null);
|
||||||
|
};
|
||||||
|
|
||||||
|
systemd.services =
|
||||||
|
let
|
||||||
|
configFile =
|
||||||
|
let
|
||||||
|
mapValue =
|
||||||
|
arg:
|
||||||
|
if (lib.isBool arg) then
|
||||||
|
lib.boolToString arg
|
||||||
|
else if (lib.isInt arg) then
|
||||||
|
toString arg
|
||||||
|
else
|
||||||
|
"\"${lib.escape [ "\"" ] (toString arg)}\"";
|
||||||
|
in
|
||||||
|
with lib;
|
||||||
|
pipe cfg.settings [
|
||||||
|
(filterAttrs (_: val: val != null))
|
||||||
|
(mapAttrs (name: val: "${name}=${mapValue val}"))
|
||||||
|
(attrValues)
|
||||||
|
(concatLines)
|
||||||
|
(pkgs.writeText "${cfg.package.name}-config.toml")
|
||||||
|
];
|
||||||
|
in
|
||||||
|
{
|
||||||
|
librespeed-secrets = lib.mkIf (cfg.secrets != { }) {
|
||||||
|
description = "LibreSpeed secret helper";
|
||||||
|
|
||||||
|
ExecStart =
|
||||||
|
let
|
||||||
|
script = pkgs.writeShellApplication {
|
||||||
|
name = "librespeed-secrets";
|
||||||
|
runtimeInputs = [ pkgs.coreutils ];
|
||||||
|
text =
|
||||||
|
''
|
||||||
|
cp ${configFile} ''${RUNTIME_DIRECTORY%%:*}/config.toml
|
||||||
|
''
|
||||||
|
+ lib.pipe cfg.secrets [
|
||||||
|
(lib.mapAttrs (
|
||||||
|
name: file: ''
|
||||||
|
cat >>''${RUNTIME_DIRECTORY%%:*}/config.toml <<EOF
|
||||||
|
${name}="$(<${lib.escapeShellArg file})"
|
||||||
|
EOF
|
||||||
|
''
|
||||||
|
))
|
||||||
|
(lib.concatLines lib.attrValues)
|
||||||
|
];
|
||||||
|
};
|
||||||
|
in
|
||||||
|
lib.getExe script;
|
||||||
|
|
||||||
|
serviceConfig = {
|
||||||
|
Type = "oneshot";
|
||||||
|
RemainAfterExit = true;
|
||||||
|
RuntimeDirectory = "librespeed";
|
||||||
|
UMask = "u=rw";
|
||||||
|
};
|
||||||
|
};
|
||||||
|
librespeed = {
|
||||||
|
description = "LibreSpeed server daemon";
|
||||||
|
wantedBy = [ "multi-user.target" ];
|
||||||
|
wants = [ "network-online.target" ];
|
||||||
|
requires = lib.optionals (cfg.secrets != { }) [ "librespeed-secrets.service" ];
|
||||||
|
|
||||||
|
serviceConfig = {
|
||||||
|
Type = "simple";
|
||||||
|
Restart = "always";
|
||||||
|
|
||||||
|
DynamicUser = true;
|
||||||
|
|
||||||
|
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";
|
||||||
|
RuntimeDirectoryPreserve = true;
|
||||||
|
StateDirectory = "librespeed";
|
||||||
|
CacheDirectory = "librespeed";
|
||||||
|
SyslogIdentifier = "librespeed";
|
||||||
|
|
||||||
|
ReadOnlyPaths = [ cfg.package ];
|
||||||
|
RestrictSUIDSGID = true;
|
||||||
|
RestrictNamespaces = true;
|
||||||
|
PrivateTmp = true;
|
||||||
|
PrivateDevices = true;
|
||||||
|
PrivateUsers = true;
|
||||||
|
ProtectHostname = true;
|
||||||
|
ProtectClock = true;
|
||||||
|
ProtectKernelTunables = true;
|
||||||
|
ProtectKernelModules = true;
|
||||||
|
ProtectKernelLogs = true;
|
||||||
|
ProtectControlGroups = true;
|
||||||
|
ProtectSystem = "strict";
|
||||||
|
ProtectHome = true;
|
||||||
|
ProtectProc = "invisible";
|
||||||
|
SystemCallArchitectures = "native";
|
||||||
|
SystemCallFilter = "@system-service";
|
||||||
|
SystemCallErrorNumber = "EPERM";
|
||||||
|
LockPersonality = true;
|
||||||
|
NoNewPrivileges = true;
|
||||||
|
};
|
||||||
|
};
|
||||||
|
};
|
||||||
|
}
|
||||||
|
);
|
||||||
|
|
||||||
meta.maintainers = with lib.maintainers; [ snaki ];
|
meta.maintainers = with lib.maintainers; [ snaki ];
|
||||||
}
|
}
|
||||||
|
|
|
@ -4,12 +4,13 @@
|
||||||
rustPlatform,
|
rustPlatform,
|
||||||
}:
|
}:
|
||||||
let
|
let
|
||||||
version = "1.3.2";
|
# https://github.com/librespeed/speedtest-rust/pull/7
|
||||||
|
version = "unstable-2024-09-28";
|
||||||
src = fetchFromGitHub {
|
src = fetchFromGitHub {
|
||||||
owner = "librespeed";
|
owner = "librespeed";
|
||||||
repo = "speedtest-rust";
|
repo = "speedtest-rust";
|
||||||
rev = "refs/tags/v${version}";
|
rev = "a74f25d07da3eb665ce806e015c537264f7254c9";
|
||||||
hash = "sha256-z3lORjjJ89o+Du4mvKGydwxHU6Ra2jU5ue5Zsl/oIfY=";
|
hash = "sha256-+G1DFHQONXXg/5apSBlBkRvuLT4qCJaeFnQSLWt0CD0=";
|
||||||
};
|
};
|
||||||
in
|
in
|
||||||
rustPlatform.buildRustPackage {
|
rustPlatform.buildRustPackage {
|
||||||
|
|
Loading…
Reference in a new issue