2e751c0772
the conversion procedure is simple: - find all things that look like options, ie calls to either `mkOption` or `lib.mkOption` that take an attrset. remember the attrset as the option - for all options, find a `description` attribute who's value is not a call to `mdDoc` or `lib.mdDoc` - textually convert the entire value of the attribute to MD with a few simple regexes (the set from mdize-module.sh) - if the change produced a change in the manual output, discard - if the change kept the manual unchanged, add some text to the description to make sure we've actually found an option. if the manual changes this time, keep the converted description this procedure converts 80% of nixos options to markdown. around 2000 options remain to be inspected, but most of those fail the "does not change the manual output check": currently the MD conversion process does not faithfully convert docbook tags like <code> and <package>, so any option using such tags will not be converted at all.
82 lines
2.4 KiB
Nix
82 lines
2.4 KiB
Nix
{ config, lib, pkgs, ... }:
|
|
|
|
with lib;
|
|
|
|
let
|
|
cfg = config.services.corerad;
|
|
settingsFormat = pkgs.formats.toml {};
|
|
|
|
in {
|
|
meta.maintainers = with maintainers; [ mdlayher ];
|
|
|
|
options.services.corerad = {
|
|
enable = mkEnableOption "CoreRAD IPv6 NDP RA daemon";
|
|
|
|
settings = mkOption {
|
|
type = settingsFormat.type;
|
|
example = literalExpression ''
|
|
{
|
|
interfaces = [
|
|
# eth0 is an upstream interface monitoring for IPv6 router advertisements.
|
|
{
|
|
name = "eth0";
|
|
monitor = true;
|
|
}
|
|
# eth1 is a downstream interface advertising IPv6 prefixes for SLAAC.
|
|
{
|
|
name = "eth1";
|
|
advertise = true;
|
|
prefix = [{ prefix = "::/64"; }];
|
|
}
|
|
];
|
|
# Optionally enable Prometheus metrics.
|
|
debug = {
|
|
address = "localhost:9430";
|
|
prometheus = true;
|
|
};
|
|
}
|
|
'';
|
|
description = lib.mdDoc ''
|
|
Configuration for CoreRAD, see <https://github.com/mdlayher/corerad/blob/main/internal/config/reference.toml>
|
|
for supported values. Ignored if configFile is set.
|
|
'';
|
|
};
|
|
|
|
configFile = mkOption {
|
|
type = types.path;
|
|
example = literalExpression ''"''${pkgs.corerad}/etc/corerad/corerad.toml"'';
|
|
description = lib.mdDoc "Path to CoreRAD TOML configuration file.";
|
|
};
|
|
|
|
package = mkOption {
|
|
default = pkgs.corerad;
|
|
defaultText = literalExpression "pkgs.corerad";
|
|
type = types.package;
|
|
description = lib.mdDoc "CoreRAD package to use.";
|
|
};
|
|
};
|
|
|
|
config = mkIf cfg.enable {
|
|
# Prefer the config file over settings if both are set.
|
|
services.corerad.configFile = mkDefault (settingsFormat.generate "corerad.toml" cfg.settings);
|
|
|
|
systemd.services.corerad = {
|
|
description = "CoreRAD IPv6 NDP RA daemon";
|
|
after = [ "network.target" ];
|
|
wantedBy = [ "multi-user.target" ];
|
|
serviceConfig = {
|
|
LimitNPROC = 512;
|
|
LimitNOFILE = 1048576;
|
|
CapabilityBoundingSet = "CAP_NET_ADMIN CAP_NET_RAW";
|
|
AmbientCapabilities = "CAP_NET_ADMIN CAP_NET_RAW";
|
|
NoNewPrivileges = true;
|
|
DynamicUser = true;
|
|
Type = "notify";
|
|
NotifyAccess = "main";
|
|
ExecStart = "${getBin cfg.package}/bin/corerad -c=${cfg.configFile}";
|
|
Restart = "on-failure";
|
|
RestartKillSignal = "SIGHUP";
|
|
};
|
|
};
|
|
};
|
|
}
|