treewide: add documentation for nixos systemd units

h7x4 ab0564bd aaac00e7

Changed files
+60 -1
nixos
modules
hardware
sensor
security
services
computing
torque
finance
libeufin
taler
hardware
mail
monitoring
network-filesystems
networking
scheduling
security
web-apps
web-servers
phpfpm
tasks
filesystems
+1
nixos/modules/hardware/sensor/hddtemp.nix
···
config = mkIf cfg.enable {
systemd.services.hddtemp = {
description = "HDD/SSD temperature";
wantedBy = [ "multi-user.target" ];
serviceConfig = {
Type = "forking";
···
config = mkIf cfg.enable {
systemd.services.hddtemp = {
description = "HDD/SSD temperature";
+
documentation = [ "man:hddtemp(8)" ];
wantedBy = [ "multi-user.target" ];
serviceConfig = {
Type = "forking";
+1
nixos/modules/security/auditd.nix
···
systemd.services.auditd = {
description = "Linux Audit daemon";
wantedBy = [ "sysinit.target" ];
after = [
"local-fs.target"
···
systemd.services.auditd = {
description = "Linux Audit daemon";
+
documentation = [ "man:auditd(8)" ];
wantedBy = [ "sysinit.target" ];
after = [
"local-fs.target"
+1
nixos/modules/security/isolate.nix
···
systemd.services.isolate = {
description = "Isolate control group hierarchy daemon";
wantedBy = [ "multi-user.target" ];
serviceConfig = {
Type = "notify";
ExecStart = "${isolate}/bin/isolate-cg-keeper";
···
systemd.services.isolate = {
description = "Isolate control group hierarchy daemon";
wantedBy = [ "multi-user.target" ];
+
documentation = [ "man:isolate(1)" ];
serviceConfig = {
Type = "notify";
ExecStart = "${isolate}/bin/isolate-cg-keeper";
+2
nixos/modules/services/computing/torque/server.nix
···
};
systemd.services.torque-server = {
path = [ torque ];
wantedBy = [ "multi-user.target" ];
···
};
systemd.services.torque-scheduler = {
path = [ torque ];
requires = [ "torque-server-init.service" ];
···
};
systemd.services.torque-server = {
+
documentation = [ "man:pbs_server(8)" ];
path = [ torque ];
wantedBy = [ "multi-user.target" ];
···
};
systemd.services.torque-scheduler = {
+
documentation = [ "man:pbs_sched(8)" ];
path = [ torque ];
requires = [ "torque-server-init.service" ];
+2
nixos/modules/services/finance/libeufin/nexus.nix
···
services.libeufin.nexus.settings.libeufin-nexusdb-postgres.CONFIG = lib.mkIf (
cfgMain.bank.enable && cfgMain.bank.createLocalDatabase
) "postgresql:///libeufin-bank";
};
}
···
services.libeufin.nexus.settings.libeufin-nexusdb-postgres.CONFIG = lib.mkIf (
cfgMain.bank.enable && cfgMain.bank.createLocalDatabase
) "postgresql:///libeufin-bank";
+
+
systemd.services.libeufin-nexus.documentation = [ "man:libeufin-nexus(1)" ];
};
}
+8
nixos/modules/services/finance/taler/common.nix
···
requires = [ "taler-${talerComponent}-dbinit.service" ];
after = [ "taler-${talerComponent}-dbinit.service" ];
wantedBy = [ "multi-user.target" ]; # TODO slice?
}))
# Database Initialisation
{
"taler-${talerComponent}-dbinit" = {
path = [ config.services.postgresql.package ];
serviceConfig = {
Type = "oneshot";
DynamicUser = true;
···
requires = [ "taler-${talerComponent}-dbinit.service" ];
after = [ "taler-${talerComponent}-dbinit.service" ];
wantedBy = [ "multi-user.target" ]; # TODO slice?
+
documentation = [
+
"man:taler-${talerComponent}-${name}(1)"
+
"info:taler-${talerComponent}"
+
];
}))
# Database Initialisation
{
"taler-${talerComponent}-dbinit" = {
path = [ config.services.postgresql.package ];
+
documentation = [
+
"man:taler-${talerComponent}-dbinit(1)"
+
"info:taler-${talerComponent}"
+
];
serviceConfig = {
Type = "oneshot";
DynamicUser = true;
+1
nixos/modules/services/hardware/thermald.nix
···
systemd.services.thermald = {
description = "Thermal Daemon Service";
wantedBy = [ "multi-user.target" ];
serviceConfig = {
PrivateNetwork = true;
···
systemd.services.thermald = {
description = "Thermal Daemon Service";
+
documentation = [ "man:thermald(8)" ];
wantedBy = [ "multi-user.target" ];
serviceConfig = {
PrivateNetwork = true;
+1
nixos/modules/services/hardware/triggerhappy.nix
···
systemd.services.triggerhappy = {
wantedBy = [ "multi-user.target" ];
description = "Global hotkey daemon";
serviceConfig = {
ExecStart = "${pkgs.triggerhappy}/bin/thd ${
lib.optionalString (cfg.user != "root") "--user ${cfg.user}"
···
systemd.services.triggerhappy = {
wantedBy = [ "multi-user.target" ];
description = "Global hotkey daemon";
+
documentation = [ "man:thd(1)" ];
serviceConfig = {
ExecStart = "${pkgs.triggerhappy}/bin/thd ${
lib.optionalString (cfg.user != "root") "--user ${cfg.user}"
+1
nixos/modules/services/mail/postfix.nix
···
systemd.services.postfix = {
description = "Postfix mail server";
wantedBy = [ "multi-user.target" ];
after = [
"network.target"
···
systemd.services.postfix = {
description = "Postfix mail server";
+
documentation = [ "man:postfix(1)" ];
wantedBy = [ "multi-user.target" ];
after = [
"network.target"
+1
nixos/modules/services/monitoring/glances.nix
···
systemd.services."glances" = {
description = "Glances";
after = [ "network.target" ];
wantedBy = [ "multi-user.target" ];
···
systemd.services."glances" = {
description = "Glances";
+
documentation = [ "man:glances(1)" ];
after = [ "network.target" ];
wantedBy = [ "multi-user.target" ];
+2
nixos/modules/services/network-filesystems/tahoe.nix
···
in
lib.nameValuePair "tahoe.introducer-${node}" {
description = "Tahoe LAFS node ${node}";
wantedBy = [ "multi-user.target" ];
path = [ settings.package ];
restartTriggers = [
···
in
lib.nameValuePair "tahoe.${node}" {
description = "Tahoe LAFS node ${node}";
wantedBy = [ "multi-user.target" ];
path = [ settings.package ];
restartTriggers = [
···
in
lib.nameValuePair "tahoe.introducer-${node}" {
description = "Tahoe LAFS node ${node}";
+
documentation = [ "info:tahoe-lafs" ];
wantedBy = [ "multi-user.target" ];
path = [ settings.package ];
restartTriggers = [
···
in
lib.nameValuePair "tahoe.${node}" {
description = "Tahoe LAFS node ${node}";
+
documentation = [ "info:tahoe-lafs" ];
wantedBy = [ "multi-user.target" ];
path = [ settings.package ];
restartTriggers = [
+6
nixos/modules/services/networking/avahi-daemon.nix
···
description = "Avahi mDNS/DNS-SD Stack";
wantedBy = [ "multi-user.target" ];
requires = [ "avahi-daemon.socket" ];
# Make NSS modules visible so that `avahi_nss_support ()' can
# return a sensible value.
···
description = "Avahi mDNS/DNS-SD Stack";
wantedBy = [ "multi-user.target" ];
requires = [ "avahi-daemon.socket" ];
+
documentation = [
+
"man:avahi-daemon(8)"
+
"man:avahi-daemon.conf(5)"
+
"man:avahi.hosts(5)"
+
"man:avahi.service(5)"
+
];
# Make NSS modules visible so that `avahi_nss_support ()' can
# return a sensible value.
+2
nixos/modules/services/networking/dhcpcd.nix
···
in
{ description = "DHCP Client";
wantedBy = [ "multi-user.target" ] ++ lib.optional (!hasDefaultGatewaySet) "network-online.target";
wants = [ "network.target" "resolvconf.service" ];
after = [ "resolvconf.service" ];
···
in
{ description = "DHCP Client";
+
documentation = [ "man:dhcpcd(8)" ];
+
wantedBy = [ "multi-user.target" ] ++ lib.optional (!hasDefaultGatewaySet) "network-online.target";
wants = [ "network.target" "resolvconf.service" ];
after = [ "resolvconf.service" ];
+1
nixos/modules/services/networking/gnunet.nix
···
systemd.services.gnunet = {
description = "GNUnet";
after = [ "network.target" ];
wantedBy = [ "multi-user.target" ];
restartTriggers = [ config.environment.etc."gnunet.conf".source ];
···
systemd.services.gnunet = {
description = "GNUnet";
+
documentation = [ "info:gnunet" ];
after = [ "network.target" ];
wantedBy = [ "multi-user.target" ];
restartTriggers = [ config.environment.etc."gnunet.conf".source ];
+4
nixos/modules/services/networking/gvpe.nix
···
config = mkIf cfg.enable {
systemd.services.gvpe = {
description = "GNU Virtual Private Ethernet node";
after = [ "network.target" ];
wantedBy = [ "multi-user.target" ];
···
config = mkIf cfg.enable {
systemd.services.gvpe = {
description = "GNU Virtual Private Ethernet node";
+
documentation = [
+
"info:gvpe"
+
"man:gvpe(8)"
+
];
after = [ "network.target" ];
wantedBy = [ "multi-user.target" ];
+1
nixos/modules/services/networking/privoxy.nix
···
systemd.services.privoxy = {
description = "Filtering web proxy";
after = [
"network.target"
"nss-lookup.target"
···
systemd.services.privoxy = {
description = "Filtering web proxy";
+
documentation = [ "man:privoxy(8)" ];
after = [
"network.target"
"nss-lookup.target"
+1
nixos/modules/services/networking/soju.nix
···
wantedBy = [ "multi-user.target" ];
wants = [ "network-online.target" ];
after = [ "network-online.target" ];
serviceConfig = {
DynamicUser = true;
Restart = "always";
···
wantedBy = [ "multi-user.target" ];
wants = [ "network-online.target" ];
after = [ "network-online.target" ];
+
documentation = [ "man:soju(1)" ];
serviceConfig = {
DynamicUser = true;
Restart = "always";
+4
nixos/modules/services/networking/tinc.nix
···
("tinc.${network}")
(let version = getVersion data.package; in {
description = "Tinc Daemon - ${network}";
wantedBy = [ "multi-user.target" ];
path = [ data.package ];
reloadTriggers = mkIf (versionAtLeast version "1.1pre") [ (builtins.toJSON etcConfig) ];
···
("tinc.${network}")
(let version = getVersion data.package; in {
description = "Tinc Daemon - ${network}";
+
documentation = [
+
"info:tinc"
+
"man:tincd(8)"
+
];
wantedBy = [ "multi-user.target" ];
path = [ data.package ];
reloadTriggers = mkIf (versionAtLeast version "1.1pre") [ (builtins.toJSON etcConfig) ];
+1
nixos/modules/services/scheduling/atd.nix
···
systemd.services.atd = {
description = "Job Execution Daemon (atd)";
wantedBy = [ "multi-user.target" ];
path = [ at ];
···
systemd.services.atd = {
description = "Job Execution Daemon (atd)";
+
documentation = [ "man:atd(8)" ];
wantedBy = [ "multi-user.target" ];
path = [ at ];
+3
nixos/modules/services/security/clamav.nix
···
systemd.services.clamav-daemon = lib.mkIf cfg.daemon.enable {
description = "ClamAV daemon (clamd)";
after = lib.optionals cfg.updater.enable [ "clamav-freshclam.service" ];
wants = lib.optionals cfg.updater.enable [ "clamav-freshclam.service" ];
wantedBy = [ "multi-user.target" ];
···
systemd.services.clamav-freshclam = lib.mkIf cfg.updater.enable {
description = "ClamAV virus database updater (freshclam)";
restartTriggers = [ freshclamConfigFile ];
requires = [ "network-online.target" ];
after = [ "network-online.target" ];
···
systemd.services.clamdscan = lib.mkIf cfg.scanner.enable {
description = "ClamAV virus scanner";
after = lib.optionals cfg.updater.enable [ "clamav-freshclam.service" ];
wants = lib.optionals cfg.updater.enable [ "clamav-freshclam.service" ];
···
systemd.services.clamav-daemon = lib.mkIf cfg.daemon.enable {
description = "ClamAV daemon (clamd)";
+
documentation = [ "man:clamd(8)" ];
after = lib.optionals cfg.updater.enable [ "clamav-freshclam.service" ];
wants = lib.optionals cfg.updater.enable [ "clamav-freshclam.service" ];
wantedBy = [ "multi-user.target" ];
···
systemd.services.clamav-freshclam = lib.mkIf cfg.updater.enable {
description = "ClamAV virus database updater (freshclam)";
+
documentation = [ "man:freshclam(1)" ];
restartTriggers = [ freshclamConfigFile ];
requires = [ "network-online.target" ];
after = [ "network-online.target" ];
···
systemd.services.clamdscan = lib.mkIf cfg.scanner.enable {
description = "ClamAV virus scanner";
+
documentation = [ "man:clamdscan(1)" ];
after = lib.optionals cfg.updater.enable [ "clamav-freshclam.service" ];
wants = lib.optionals cfg.updater.enable [ "clamav-freshclam.service" ];
+1
nixos/modules/services/security/endlessh.nix
···
config = lib.mkIf cfg.enable {
systemd.services.endlessh = {
description = "SSH tarpit";
requires = [ "network.target" ];
wantedBy = [ "multi-user.target" ];
serviceConfig =
···
config = lib.mkIf cfg.enable {
systemd.services.endlessh = {
description = "SSH tarpit";
+
documentation = [ "man:endlessh(1)" ];
requires = [ "network.target" ];
wantedBy = [ "multi-user.target" ];
serviceConfig =
+4
nixos/modules/services/security/munge.nix
···
users.groups.munge = { };
systemd.services.munged = {
wantedBy = [ "multi-user.target" ];
wants = [
"network-online.target"
···
users.groups.munge = { };
systemd.services.munged = {
+
documentation = [
+
"man:munged(8)"
+
"man:mungekey(8)"
+
];
wantedBy = [ "multi-user.target" ];
wants = [
"network-online.target"
+1
nixos/modules/services/security/physlock.nix
···
systemd.services.physlock = {
enable = true;
description = "Physlock";
wantedBy =
lib.optional cfg.lockOn.suspend "suspend.target"
···
systemd.services.physlock = {
enable = true;
+
documentation = [ "man:physlock(1)" ];
description = "Physlock";
wantedBy =
lib.optional cfg.lockOn.suspend "suspend.target"
+1
nixos/modules/services/security/sks.nix
···
{
sks-db = {
description = "SKS database server";
after = [ "network.target" ];
wantedBy = [ "multi-user.target" ];
preStart = ''
···
{
sks-db = {
description = "SKS database server";
+
documentation = [ "man:sks(8)" ];
after = [ "network.target" ];
wantedBy = [ "multi-user.target" ];
preStart = ''
+1
nixos/modules/services/security/tor.nix
···
systemd.services.tor = {
description = "Tor Daemon";
path = [ pkgs.tor ];
wantedBy = [ "multi-user.target" ];
···
systemd.services.tor = {
description = "Tor Daemon";
+
documentation = [ "man:tor(8)" ];
path = [ pkgs.tor ];
wantedBy = [ "multi-user.target" ];
+5 -1
nixos/modules/services/web-apps/hledger-web.nix
···
in
{
description = "hledger-web - web-app for the hledger accounting tool.";
-
documentation = [ "https://hledger.org/hledger-web.html" ];
wantedBy = [ "multi-user.target" ];
after = [ "networking.target" ];
serviceConfig = mkMerge [
···
in
{
description = "hledger-web - web-app for the hledger accounting tool.";
+
documentation = [
+
"info:hledger-web"
+
"man:hledger-web(1)"
+
"https://hledger.org/hledger-web.html"
+
];
wantedBy = [ "multi-user.target" ];
after = [ "networking.target" ];
serviceConfig = mkMerge [
+1
nixos/modules/services/web-servers/phpfpm/default.nix
···
after = [ "network.target" ];
wantedBy = [ "phpfpm.target" ];
partOf = [ "phpfpm.target" ];
serviceConfig = let
cfgFile = fpmCfgFile pool poolOpts;
iniFile = phpIni poolOpts;
···
after = [ "network.target" ];
wantedBy = [ "phpfpm.target" ];
partOf = [ "phpfpm.target" ];
+
documentation = [ "man:php-fpm(8)" ];
serviceConfig = let
cfgFile = fpmCfgFile pool poolOpts;
iniFile = phpIni poolOpts;
+1
nixos/modules/tasks/filesystems/btrfs.nix
···
in
nameValuePair "btrfs-scrub-${fs'}" {
description = "btrfs scrub on ${fs}";
# scrub prevents suspend2ram or proper shutdown
conflicts = [
"shutdown.target"
···
in
nameValuePair "btrfs-scrub-${fs'}" {
description = "btrfs scrub on ${fs}";
+
documentation = [ "man:btrfs-scrub(8)" ];
# scrub prevents suspend2ram or proper shutdown
conflicts = [
"shutdown.target"
+1
nixos/modules/tasks/powertop.nix
···
config = mkIf (cfg.enable) {
systemd.services = {
powertop = {
wantedBy = [ "multi-user.target" ];
after = [ "multi-user.target" ];
description = "Powertop tunings";
···
config = mkIf (cfg.enable) {
systemd.services = {
powertop = {
+
documentation = [ "man:powertop(8)" ];
wantedBy = [ "multi-user.target" ];
after = [ "multi-user.target" ];
description = "Powertop tunings";