movefasta/nixpkgs
1
0
Fork 0
mirror of https://github.com/NixOS/nixpkgs.git synced 2025-06-09 19:13:26 +03:00
Code Issues Projects Releases Packages Wiki Activity

treewide: add documentation for nixos systemd units

Browse source
This commit is contained in:
h7x4 2025-03-12 17:59:34 +01:00
parent aaac00e726
commit ab0564bd10
No known key found for this signature in database
GPG key ID: 9F2F7D8250F35146
29 changed files with 60 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

1
nixos/modules/hardware/sensor/hddtemp.nix
View file

@ -75,6 +75,7 @@ in
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
View file

@ -15,6 +15,7 @@
systemd.services.auditd = {
description = "Linux Audit daemon";
documentation = [ "man:auditd(8)" ];
wantedBy = [ "sysinit.target" ];
after = [
"local-fs.target"

1
nixos/modules/security/isolate.nix
View file

@ -128,6 +128,7 @@ in
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
View file

@ -70,6 +70,7 @@ in
};
systemd.services.torque-server = {
documentation = [ "man:pbs_server(8)" ];
path = [ torque ];
wantedBy = [ "multi-user.target" ];
@ -93,6 +94,7 @@ in
};
systemd.services.torque-scheduler = {
documentation = [ "man:pbs_sched(8)" ];
path = [ torque ];
requires = [ "torque-server-init.service" ];

2
nixos/modules/services/finance/libeufin/nexus.nix
View file

@ -127,5 +127,7 @@
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
View file

@ -68,11 +68,19 @@ in
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
View file

@ -49,6 +49,7 @@ in
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
View file

@ -122,6 +122,7 @@ in
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
View file

@ -871,6 +871,7 @@ in
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
View file

@ -68,6 +68,7 @@ in
systemd.services."glances" = {
description = "Glances";
documentation = [ "man:glances(1)" ];
after = [ "network.target" ];
wantedBy = [ "multi-user.target" ];

2
nixos/modules/services/network-filesystems/tahoe.nix
View file

@ -218,6 +218,7 @@ in
in
lib.nameValuePair "tahoe.introducer-${node}" {
description = "Tahoe LAFS node ${node}";
documentation = [ "info:tahoe-lafs" ];
wantedBy = [ "multi-user.target" ];
path = [ settings.package ];
restartTriggers = [
@ -329,6 +330,7 @@ in
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
View file

@ -305,6 +305,12 @@ in
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
View file

@ -209,6 +209,8 @@ in
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
View file

@ -149,6 +149,7 @@ in
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
View file

@ -114,6 +114,10 @@ in
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
View file

@ -229,6 +229,7 @@ in
systemd.services.privoxy = {
description = "Filtering web proxy";
documentation = [ "man:privoxy(8)" ];
after = [
"network.target"
"nss-lookup.target"

1
nixos/modules/services/networking/soju.nix
View file

@ -142,6 +142,7 @@ in
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
View file

@ -366,6 +366,10 @@ in
("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
View file

@ -82,6 +82,7 @@ in
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
View file

@ -169,6 +169,7 @@ in
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" ];
@ -199,6 +200,7 @@ in
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" ];
@ -276,6 +278,7 @@ in
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
View file

@ -48,6 +48,7 @@ in
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
View file

@ -46,6 +46,10 @@ in
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
View file

@ -116,6 +116,7 @@ in
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
View file

@ -119,6 +119,7 @@ in
{
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
View file

@ -1324,6 +1324,7 @@ in
systemd.services.tor = {
description = "Tor Daemon";
documentation = [ "man:tor(8)" ];
path = [ pkgs.tor ];
wantedBy = [ "multi-user.target" ];

6
nixos/modules/services/web-apps/hledger-web.nix
View file

@ -128,7 +128,11 @@ in
in
{
description = "hledger-web - web-app for the hledger accounting tool.";
documentation = [ "https://hledger.org/hledger-web.html" ];
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
View file

@ -254,6 +254,7 @@ in {
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
View file

@ -166,6 +166,7 @@ in
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
View file

@ -51,6 +51,7 @@ in
config = mkIf (cfg.enable) {
systemd.services = {
powertop = {
documentation = [ "man:powertop(8)" ];
wantedBy = [ "multi-user.target" ];
after = [ "multi-user.target" ];
description = "Powertop tunings";