diff options
Diffstat (limited to 'nixos')
108 files changed, 113 insertions, 111 deletions
diff --git a/nixos/modules/config/mysql.nix b/nixos/modules/config/mysql.nix index 4f72d22c4f0ec..30741a9ad406f 100644 --- a/nixos/modules/config/mysql.nix +++ b/nixos/modules/config/mysql.nix @@ -10,7 +10,7 @@ in options = { users.mysql = { - enable = mkEnableOption (lib.mdDoc "Authentication against a MySQL/MariaDB database"); + enable = mkEnableOption (lib.mdDoc "authentication against a MySQL/MariaDB database"); host = mkOption { type = types.str; example = "localhost"; diff --git a/nixos/modules/config/xdg/portals/wlr.nix b/nixos/modules/config/xdg/portals/wlr.nix index d84ae794e3bc2..2274be9cc40a9 100644 --- a/nixos/modules/config/xdg/portals/wlr.nix +++ b/nixos/modules/config/xdg/portals/wlr.nix @@ -15,7 +15,7 @@ in options.xdg.portal.wlr = { enable = mkEnableOption (lib.mdDoc '' - desktop portal for wlroots-based desktops + desktop portal for wlroots-based desktops. This will add the `xdg-desktop-portal-wlr` package into the {option}`xdg.portal.extraPortals` option, and provide the diff --git a/nixos/modules/hardware/ksm.nix b/nixos/modules/hardware/ksm.nix index 82d94e6ab57c5..d3b2ae37f41bf 100644 --- a/nixos/modules/hardware/ksm.nix +++ b/nixos/modules/hardware/ksm.nix @@ -11,7 +11,7 @@ in { ]; options.hardware.ksm = { - enable = mkEnableOption (lib.mdDoc "Kernel Same-Page Merging"); + enable = mkEnableOption (lib.mdDoc "Linux kernel Same-Page Merging"); sleep = mkOption { type = types.nullOr types.int; default = null; diff --git a/nixos/modules/hardware/logitech.nix b/nixos/modules/hardware/logitech.nix index 9b06eb8a8b016..cb1f9b585762d 100644 --- a/nixos/modules/hardware/logitech.nix +++ b/nixos/modules/hardware/logitech.nix @@ -19,7 +19,7 @@ in options.hardware.logitech = { lcd = { - enable = mkEnableOption (lib.mdDoc "Logitech LCD Devices"); + enable = mkEnableOption (lib.mdDoc "support for Logitech LCD Devices"); startWhenNeeded = mkOption { type = types.bool; @@ -41,7 +41,7 @@ in }; wireless = { - enable = mkEnableOption (lib.mdDoc "Logitech Wireless Devices"); + enable = mkEnableOption (lib.mdDoc "support for Logitech Wireless Devices"); enableGraphical = mkOption { type = types.bool; diff --git a/nixos/modules/hardware/video/capture/mwprocapture.nix b/nixos/modules/hardware/video/capture/mwprocapture.nix index ddd3f3ec7f32f..187f97c25d1b2 100644 --- a/nixos/modules/hardware/video/capture/mwprocapture.nix +++ b/nixos/modules/hardware/video/capture/mwprocapture.nix @@ -12,7 +12,7 @@ in { - options.hardware.mwProCapture.enable = mkEnableOption (lib.mdDoc "Magewell Pro Capture family kernel module"); + options.hardware.mwProCapture.enable = mkEnableOption (lib.mdDoc "the Magewell Pro Capture family kernel module"); config = mkIf cfg.enable { diff --git a/nixos/modules/programs/appgate-sdp.nix b/nixos/modules/programs/appgate-sdp.nix index bdd538dc2f1f3..5b958b686552e 100644 --- a/nixos/modules/programs/appgate-sdp.nix +++ b/nixos/modules/programs/appgate-sdp.nix @@ -5,7 +5,7 @@ with lib; { options = { programs.appgate-sdp = { - enable = mkEnableOption (lib.mdDoc "AppGate SDP VPN client"); + enable = mkEnableOption (lib.mdDoc "the AppGate SDP VPN client"); }; }; diff --git a/nixos/modules/programs/atop.nix b/nixos/modules/programs/atop.nix index 003cfdbfc8fad..26bfc519934b3 100644 --- a/nixos/modules/programs/atop.nix +++ b/nixos/modules/programs/atop.nix @@ -14,7 +14,7 @@ in programs.atop = rec { - enable = mkEnableOption (lib.mdDoc "Atop"); + enable = mkEnableOption (lib.mdDoc "Atop, a tool for monitoring system resources"); package = mkPackageOption pkgs "atop" { }; diff --git a/nixos/modules/programs/bash/blesh.nix b/nixos/modules/programs/bash/blesh.nix index 8fa51bef77443..f23dff1405e25 100644 --- a/nixos/modules/programs/bash/blesh.nix +++ b/nixos/modules/programs/bash/blesh.nix @@ -4,7 +4,7 @@ let cfg = config.programs.bash.blesh; in { options = { - programs.bash.blesh.enable = mkEnableOption (mdDoc "blesh"); + programs.bash.blesh.enable = mkEnableOption (mdDoc "blesh, a full-featured line editor written in pure Bash"); }; config = mkIf cfg.enable { diff --git a/nixos/modules/programs/bcc.nix b/nixos/modules/programs/bcc.nix index ff29d56bedb9c..f425fd45232dc 100644 --- a/nixos/modules/programs/bcc.nix +++ b/nixos/modules/programs/bcc.nix @@ -1,6 +1,6 @@ { config, pkgs, lib, ... }: { - options.programs.bcc.enable = lib.mkEnableOption (lib.mdDoc "bcc"); + options.programs.bcc.enable = lib.mkEnableOption (lib.mdDoc "bcc, tools for BPF-based Linux IO analysis, networking, monitoring, and more"); config = lib.mkIf config.programs.bcc.enable { environment.systemPackages = [ pkgs.bcc ]; diff --git a/nixos/modules/programs/captive-browser.nix b/nixos/modules/programs/captive-browser.nix index 1c3ee7638ee02..ae00403284105 100644 --- a/nixos/modules/programs/captive-browser.nix +++ b/nixos/modules/programs/captive-browser.nix @@ -49,7 +49,7 @@ in options = { programs.captive-browser = { - enable = mkEnableOption (lib.mdDoc "captive browser"); + enable = mkEnableOption (lib.mdDoc "captive browser, a dedicated Chrome instance to log into captive portals without messing with DNS settings"); package = mkPackageOption pkgs "captive-browser" { }; diff --git a/nixos/modules/programs/ccache.nix b/nixos/modules/programs/ccache.nix index 7972b2ac4a569..fbe8eb6c179e0 100644 --- a/nixos/modules/programs/ccache.nix +++ b/nixos/modules/programs/ccache.nix @@ -5,7 +5,7 @@ let in { options.programs.ccache = { # host configuration - enable = lib.mkEnableOption (lib.mdDoc "CCache"); + enable = lib.mkEnableOption (lib.mdDoc "CCache, a compiler cache for fast recompilation of C/C++ code"); cacheDir = lib.mkOption { type = lib.types.path; description = lib.mdDoc "CCache directory"; diff --git a/nixos/modules/programs/firejail.nix b/nixos/modules/programs/firejail.nix index 046c31ce64f6b..792ed9fe56807 100644 --- a/nixos/modules/programs/firejail.nix +++ b/nixos/modules/programs/firejail.nix @@ -40,7 +40,7 @@ let in { options.programs.firejail = { - enable = mkEnableOption (lib.mdDoc "firejail"); + enable = mkEnableOption (lib.mdDoc "firejail, a sandboxing tool for Linux"); wrappedBinaries = mkOption { type = types.attrsOf (types.either types.path (types.submodule { diff --git a/nixos/modules/programs/gamescope.nix b/nixos/modules/programs/gamescope.nix index 594e5be5fd583..33ab16cc87078 100644 --- a/nixos/modules/programs/gamescope.nix +++ b/nixos/modules/programs/gamescope.nix @@ -21,7 +21,7 @@ with lib; let in { options.programs.gamescope = { - enable = mkEnableOption (mdDoc "gamescope"); + enable = mkEnableOption (mdDoc "gamescope, the SteamOS session compositing window manager"); package = mkPackageOption pkgs "gamescope" { }; diff --git a/nixos/modules/programs/geary.nix b/nixos/modules/programs/geary.nix index d9454a2247fd6..5aa71434090ed 100644 --- a/nixos/modules/programs/geary.nix +++ b/nixos/modules/programs/geary.nix @@ -11,7 +11,7 @@ in { }; options = { - programs.geary.enable = mkEnableOption (lib.mdDoc "Geary, a Mail client for GNOME 3"); + programs.geary.enable = mkEnableOption (lib.mdDoc "Geary, a Mail client for GNOME"); }; config = mkIf cfg.enable { diff --git a/nixos/modules/programs/git.nix b/nixos/modules/programs/git.nix index 8fb69cbae28fe..3029dd9e1bfd7 100644 --- a/nixos/modules/programs/git.nix +++ b/nixos/modules/programs/git.nix @@ -9,7 +9,7 @@ in { options = { programs.git = { - enable = mkEnableOption (lib.mdDoc "git"); + enable = mkEnableOption (lib.mdDoc "git, a distributed version control system"); package = mkPackageOption pkgs "git" { example = "gitFull"; @@ -59,7 +59,7 @@ in }; lfs = { - enable = mkEnableOption (lib.mdDoc "git-lfs"); + enable = mkEnableOption (lib.mdDoc "git-lfs (Large File Storage)"); package = mkPackageOption pkgs "git-lfs" { }; }; diff --git a/nixos/modules/programs/iay.nix b/nixos/modules/programs/iay.nix index 1fa00e43795ad..a27f2520fd6ac 100644 --- a/nixos/modules/programs/iay.nix +++ b/nixos/modules/programs/iay.nix @@ -5,7 +5,7 @@ let inherit (lib) mkEnableOption mkIf mkOption mkPackageOption optionalString types; in { options.programs.iay = { - enable = mkEnableOption (lib.mdDoc "iay"); + enable = mkEnableOption (lib.mdDoc "iay, a minimalistic shell prompt"); package = mkPackageOption pkgs "iay" {}; minimalPrompt = mkOption { diff --git a/nixos/modules/programs/less.nix b/nixos/modules/programs/less.nix index 81c68307aee14..6aa08d136a113 100644 --- a/nixos/modules/programs/less.nix +++ b/nixos/modules/programs/less.nix @@ -35,7 +35,7 @@ in # note that environment.nix sets PAGER=less, and # therefore also enables this module - enable = mkEnableOption (lib.mdDoc "less"); + enable = mkEnableOption (lib.mdDoc "less, a file pager"); configFile = mkOption { type = types.nullOr types.path; diff --git a/nixos/modules/programs/mepo.nix b/nixos/modules/programs/mepo.nix index 4b1706a2a0e53..92ce6e5fa578a 100644 --- a/nixos/modules/programs/mepo.nix +++ b/nixos/modules/programs/mepo.nix @@ -5,7 +5,7 @@ let in { options.programs.mepo = { - enable = mkEnableOption (mdDoc "Mepo"); + enable = mkEnableOption (mdDoc "Mepo, a fast, simple and hackable OSM map viewer"); locationBackends = { gpsd = mkOption { diff --git a/nixos/modules/programs/mininet.nix b/nixos/modules/programs/mininet.nix index 3568736854d8e..128a9cd45320c 100644 --- a/nixos/modules/programs/mininet.nix +++ b/nixos/modules/programs/mininet.nix @@ -8,7 +8,7 @@ let cfg = config.programs.mininet; in { - options.programs.mininet.enable = mkEnableOption (lib.mdDoc "Mininet"); + options.programs.mininet.enable = mkEnableOption (lib.mdDoc "Mininet, an emulator for rapid prototyping of Software Defined Networks"); config = mkIf cfg.enable { diff --git a/nixos/modules/programs/minipro.nix b/nixos/modules/programs/minipro.nix index 8cb64866a84cc..56920656f23df 100644 --- a/nixos/modules/programs/minipro.nix +++ b/nixos/modules/programs/minipro.nix @@ -8,7 +8,7 @@ in programs.minipro = { enable = lib.mkEnableOption (lib.mdDoc "minipro") // { description = lib.mdDoc '' - Installs minipro and its udev rules. + Whether to enable minipro and its udev rules. Users of the `plugdev` group can interact with connected MiniPRO chip programmers. ''; }; diff --git a/nixos/modules/programs/nano.nix b/nixos/modules/programs/nano.nix index 461681b598631..225fa4f2568de 100644 --- a/nixos/modules/programs/nano.nix +++ b/nixos/modules/programs/nano.nix @@ -7,7 +7,7 @@ in { options = { programs.nano = { - enable = lib.mkEnableOption (lib.mdDoc "nano") // { + enable = lib.mkEnableOption (lib.mdDoc "nano, a small user-friendly console text editor") // { default = true; }; diff --git a/nixos/modules/programs/nm-applet.nix b/nixos/modules/programs/nm-applet.nix index 4b09b1884d7e6..3ff27cd742771 100644 --- a/nixos/modules/programs/nm-applet.nix +++ b/nixos/modules/programs/nm-applet.nix @@ -6,7 +6,7 @@ }; options.programs.nm-applet = { - enable = lib.mkEnableOption (lib.mdDoc "nm-applet"); + enable = lib.mkEnableOption (lib.mdDoc "nm-applet, a NetworkManager control applet for GNOME"); indicator = lib.mkOption { type = lib.types.bool; diff --git a/nixos/modules/programs/noisetorch.nix b/nixos/modules/programs/noisetorch.nix index d8135877d02f2..84bc78ce3839d 100644 --- a/nixos/modules/programs/noisetorch.nix +++ b/nixos/modules/programs/noisetorch.nix @@ -6,7 +6,7 @@ let cfg = config.programs.noisetorch; in { options.programs.noisetorch = { - enable = mkEnableOption (lib.mdDoc "noisetorch + setcap wrapper"); + enable = mkEnableOption (lib.mdDoc "noisetorch (+ setcap wrapper), a virtual microphone device with noise suppression"); package = mkPackageOption pkgs "noisetorch" { }; }; diff --git a/nixos/modules/programs/oddjobd.nix b/nixos/modules/programs/oddjobd.nix index 9b19c160b2c02..019ca58a6048e 100644 --- a/nixos/modules/programs/oddjobd.nix +++ b/nixos/modules/programs/oddjobd.nix @@ -6,7 +6,7 @@ in { options = { programs.oddjobd = { - enable = lib.mkEnableOption "oddjob"; + enable = lib.mkEnableOption "oddjob, a D-Bus service which runs odd jobs on behalf of client applications"; package = lib.mkPackageOption pkgs "oddjob" {}; }; }; diff --git a/nixos/modules/programs/projecteur.nix b/nixos/modules/programs/projecteur.nix index 140de0209e680..8f7985a3750d2 100644 --- a/nixos/modules/programs/projecteur.nix +++ b/nixos/modules/programs/projecteur.nix @@ -5,7 +5,7 @@ let in { options.programs.projecteur = { - enable = lib.mkEnableOption (lib.mdDoc "projecteur"); + enable = lib.mkEnableOption (lib.mdDoc "projecteur, an application for the Logitech Spotlight device (and similar)"); package = lib.mkPackageOption pkgs "projecteur" { }; }; diff --git a/nixos/modules/programs/proxychains.nix b/nixos/modules/programs/proxychains.nix index acd41f3552448..db693cd83b8f2 100644 --- a/nixos/modules/programs/proxychains.nix +++ b/nixos/modules/programs/proxychains.nix @@ -49,7 +49,7 @@ in { programs.proxychains = { - enable = mkEnableOption (lib.mdDoc "installing proxychains configuration"); + enable = mkEnableOption (lib.mdDoc "proxychains configuration"); package = mkPackageOption pkgs "proxychains" { example = "proxychains-ng"; diff --git a/nixos/modules/programs/rust-motd.nix b/nixos/modules/programs/rust-motd.nix index 4c9b1018596b7..49f834596b67e 100644 --- a/nixos/modules/programs/rust-motd.nix +++ b/nixos/modules/programs/rust-motd.nix @@ -24,7 +24,7 @@ let ''; in { options.programs.rust-motd = { - enable = mkEnableOption (lib.mdDoc "rust-motd"); + enable = mkEnableOption (lib.mdDoc "rust-motd, a Message Of The Day (MOTD) generator"); enableMotdInSSHD = mkOption { default = true; type = types.bool; diff --git a/nixos/modules/programs/sedutil.nix b/nixos/modules/programs/sedutil.nix index d5e20a8815d44..0ef2472667cbd 100644 --- a/nixos/modules/programs/sedutil.nix +++ b/nixos/modules/programs/sedutil.nix @@ -6,7 +6,7 @@ let cfg = config.programs.sedutil; in { - options.programs.sedutil.enable = mkEnableOption (lib.mdDoc "sedutil"); + options.programs.sedutil.enable = mkEnableOption (lib.mdDoc "sedutil, to manage self encrypting drives that conform to the Trusted Computing Group OPAL 2.0 SSC specification"); config = mkIf cfg.enable { boot.kernelParams = [ diff --git a/nixos/modules/programs/sniffnet.nix b/nixos/modules/programs/sniffnet.nix index 98e9f628a9bce..5f6f2042d3fe5 100644 --- a/nixos/modules/programs/sniffnet.nix +++ b/nixos/modules/programs/sniffnet.nix @@ -7,7 +7,7 @@ in { options = { programs.sniffnet = { - enable = lib.mkEnableOption (lib.mdDoc "sniffnet"); + enable = lib.mkEnableOption (lib.mdDoc "sniffnet, a network traffic monitor application"); }; }; diff --git a/nixos/modules/programs/sysdig.nix b/nixos/modules/programs/sysdig.nix index ccb1e1d4c5f18..19cd6f26bae45 100644 --- a/nixos/modules/programs/sysdig.nix +++ b/nixos/modules/programs/sysdig.nix @@ -5,7 +5,7 @@ with lib; let cfg = config.programs.sysdig; in { - options.programs.sysdig.enable = mkEnableOption (lib.mdDoc "sysdig"); + options.programs.sysdig.enable = mkEnableOption (lib.mdDoc "sysdig, a tracing tool"); config = mkIf cfg.enable { environment.systemPackages = [ pkgs.sysdig ]; diff --git a/nixos/modules/programs/thefuck.nix b/nixos/modules/programs/thefuck.nix index e057d1ca657de..60b341638a0f8 100644 --- a/nixos/modules/programs/thefuck.nix +++ b/nixos/modules/programs/thefuck.nix @@ -16,7 +16,7 @@ in { options = { programs.thefuck = { - enable = mkEnableOption (lib.mdDoc "thefuck"); + enable = mkEnableOption (lib.mdDoc "thefuck, an app which corrects your previous console command"); alias = mkOption { default = "fuck"; diff --git a/nixos/modules/programs/trippy.nix b/nixos/modules/programs/trippy.nix index 6e31aea43e750..8c82358acff43 100644 --- a/nixos/modules/programs/trippy.nix +++ b/nixos/modules/programs/trippy.nix @@ -7,7 +7,7 @@ in { options = { programs.trippy = { - enable = lib.mkEnableOption (lib.mdDoc "trippy"); + enable = lib.mkEnableOption (lib.mdDoc "trippy, a network diagnostic tool"); }; }; diff --git a/nixos/modules/programs/udevil.nix b/nixos/modules/programs/udevil.nix index b0f00b4b541b0..5ec84d41de841 100644 --- a/nixos/modules/programs/udevil.nix +++ b/nixos/modules/programs/udevil.nix @@ -6,7 +6,7 @@ let cfg = config.programs.udevil; in { - options.programs.udevil.enable = mkEnableOption (lib.mdDoc "udevil"); + options.programs.udevil.enable = mkEnableOption (lib.mdDoc "udevil, to mount filesystems without password"); config = mkIf cfg.enable { security.wrappers.udevil = diff --git a/nixos/modules/programs/usbtop.nix b/nixos/modules/programs/usbtop.nix index e262ae3745bea..0b59d141bcd60 100644 --- a/nixos/modules/programs/usbtop.nix +++ b/nixos/modules/programs/usbtop.nix @@ -6,7 +6,7 @@ let cfg = config.programs.usbtop; in { options = { - programs.usbtop.enable = mkEnableOption (lib.mdDoc "usbtop and required kernel module"); + programs.usbtop.enable = mkEnableOption (lib.mdDoc "usbtop and required kernel module, to show estimated USB bandwidth"); }; config = mkIf cfg.enable { diff --git a/nixos/modules/programs/wayland/hyprland.nix b/nixos/modules/programs/wayland/hyprland.nix index bb2641762cad9..45d9c56756a7a 100644 --- a/nixos/modules/programs/wayland/hyprland.nix +++ b/nixos/modules/programs/wayland/hyprland.nix @@ -14,7 +14,7 @@ in options.programs.hyprland = { enable = mkEnableOption null // { description = '' - Hyprland, the dynamic tiling Wayland compositor that doesn't sacrifice on its looks. + Whether to enable Hyprland, the dynamic tiling Wayland compositor that doesn't sacrifice on its looks. You can manually launch Hyprland by executing {command}`Hyprland` on a TTY. diff --git a/nixos/modules/programs/wayland/waybar.nix b/nixos/modules/programs/wayland/waybar.nix index ec60b84f69976..f4bd865b221aa 100644 --- a/nixos/modules/programs/wayland/waybar.nix +++ b/nixos/modules/programs/wayland/waybar.nix @@ -7,7 +7,7 @@ let in { options.programs.waybar = { - enable = mkEnableOption (lib.mdDoc "waybar"); + enable = mkEnableOption (lib.mdDoc "waybar, a highly customizable Wayland bar for Sway and Wlroots based compositors"); package = mkPackageOption pkgs "waybar" { }; }; diff --git a/nixos/modules/programs/weylus.nix b/nixos/modules/programs/weylus.nix index f40dfd5c96135..5c69a6658fae6 100644 --- a/nixos/modules/programs/weylus.nix +++ b/nixos/modules/programs/weylus.nix @@ -7,7 +7,7 @@ let in { options.programs.weylus = with types; { - enable = mkEnableOption (lib.mdDoc "weylus"); + enable = mkEnableOption (lib.mdDoc "weylus, which turns your smart phone into a graphic tablet/touch screen for your computer"); openFirewall = mkOption { type = bool; diff --git a/nixos/modules/programs/yabar.nix b/nixos/modules/programs/yabar.nix index 58ffe555715d1..c6223a1c4d92a 100644 --- a/nixos/modules/programs/yabar.nix +++ b/nixos/modules/programs/yabar.nix @@ -41,7 +41,7 @@ let in { options.programs.yabar = { - enable = mkEnableOption (lib.mdDoc "yabar"); + enable = mkEnableOption (lib.mdDoc "yabar, a status bar for X window managers"); package = mkOption { default = pkgs.yabar-unstable; diff --git a/nixos/modules/programs/zmap.nix b/nixos/modules/programs/zmap.nix index 056f788830611..2eb05b97da3d4 100644 --- a/nixos/modules/programs/zmap.nix +++ b/nixos/modules/programs/zmap.nix @@ -6,7 +6,7 @@ let cfg = config.programs.zmap; in { options.programs.zmap = { - enable = mkEnableOption (lib.mdDoc "ZMap"); + enable = mkEnableOption (lib.mdDoc "ZMap, a network scanner designed for Internet-wide network surveys"); }; config = mkIf cfg.enable { diff --git a/nixos/modules/security/ca.nix b/nixos/modules/security/ca.nix index ae188ea709dd5..fda9e35891c7a 100644 --- a/nixos/modules/security/ca.nix +++ b/nixos/modules/security/ca.nix @@ -19,7 +19,7 @@ in { options = { - security.pki.installCACerts = mkEnableOption "Add CA certificates to system" // { + security.pki.installCACerts = mkEnableOption "installing CA certificates to the system" // { default = true; internal = true; }; diff --git a/nixos/modules/security/pam.nix b/nixos/modules/security/pam.nix index 26dc724ae1596..382ebf2c53b2d 100644 --- a/nixos/modules/security/pam.nix +++ b/nixos/modules/security/pam.nix @@ -1430,12 +1430,12 @@ in security.pam.enableEcryptfs = mkEnableOption (lib.mdDoc "eCryptfs PAM module (mounting ecryptfs home directory on login)"); security.pam.enableFscrypt = mkEnableOption (lib.mdDoc '' - fscrypt to automatically unlock directories with the user's login password. + fscrypt, to automatically unlock directories with the user's login password. This also enables a service at security.pam.services.fscrypt which is used by fscrypt to verify the user's password when setting up a new protector. If you use something other than pam_unix to verify user passwords, please remember to - adjust this PAM service. + adjust this PAM service ''); users.motd = mkOption { diff --git a/nixos/modules/services/admin/salt/master.nix b/nixos/modules/services/admin/salt/master.nix index 4346022970e12..e10a10efae652 100644 --- a/nixos/modules/services/admin/salt/master.nix +++ b/nixos/modules/services/admin/salt/master.nix @@ -20,7 +20,7 @@ in { options = { services.salt.master = { - enable = mkEnableOption (lib.mdDoc "Salt master service"); + enable = mkEnableOption (lib.mdDoc "Salt configuration management system master service"); configuration = mkOption { type = types.attrs; default = {}; diff --git a/nixos/modules/services/admin/salt/minion.nix b/nixos/modules/services/admin/salt/minion.nix index 3ae02a4cc5d5d..28b52e07c40bd 100644 --- a/nixos/modules/services/admin/salt/minion.nix +++ b/nixos/modules/services/admin/salt/minion.nix @@ -21,7 +21,7 @@ in { options = { services.salt.minion = { - enable = mkEnableOption (lib.mdDoc "Salt minion service"); + enable = mkEnableOption (lib.mdDoc "Salt configuration management system minion service"); configuration = mkOption { type = types.attrs; default = {}; diff --git a/nixos/modules/services/audio/mpdscribble.nix b/nixos/modules/services/audio/mpdscribble.nix index 132d9ad325886..e58fcdd25f63c 100644 --- a/nixos/modules/services/audio/mpdscribble.nix +++ b/nixos/modules/services/audio/mpdscribble.nix @@ -77,7 +77,7 @@ in { options.services.mpdscribble = { - enable = mkEnableOption (lib.mdDoc "mpdscribble"); + enable = mkEnableOption (lib.mdDoc "mpdscribble, an MPD client which submits info about tracks being played to Last.fm (formerly AudioScrobbler)"); proxy = mkOption { default = null; diff --git a/nixos/modules/services/databases/hbase-standalone.nix b/nixos/modules/services/databases/hbase-standalone.nix index 08ae7625d50ab..de295a57193f7 100644 --- a/nixos/modules/services/databases/hbase-standalone.nix +++ b/nixos/modules/services/databases/hbase-standalone.nix @@ -43,7 +43,7 @@ in { enable = mkEnableOption (lib.mdDoc '' HBase master in standalone mode with embedded regionserver and zookeper. - Do not use this configuration for production nor for evaluating HBase performance. + Do not use this configuration for production nor for evaluating HBase performance ''); package = mkPackageOption pkgs "hbase" { }; diff --git a/nixos/modules/services/databases/lldap.nix b/nixos/modules/services/databases/lldap.nix index 033de7af886f2..75ce1ca54f87b 100644 --- a/nixos/modules/services/databases/lldap.nix +++ b/nixos/modules/services/databases/lldap.nix @@ -6,7 +6,7 @@ let in { options.services.lldap = with lib; { - enable = mkEnableOption (mdDoc "lldap"); + enable = mkEnableOption (mdDoc "lldap, a lightweight authentication server that provides an opinionated, simplified LDAP interface for authentication"); package = mkPackageOption pkgs "lldap" { }; diff --git a/nixos/modules/services/databases/victoriametrics.nix b/nixos/modules/services/databases/victoriametrics.nix index 0ad2028c95b08..3d8ada394d20c 100644 --- a/nixos/modules/services/databases/victoriametrics.nix +++ b/nixos/modules/services/databases/victoriametrics.nix @@ -2,7 +2,7 @@ let cfg = config.services.victoriametrics; in { options.services.victoriametrics = with lib; { - enable = mkEnableOption (lib.mdDoc "victoriametrics"); + enable = mkEnableOption (lib.mdDoc "VictoriaMetrics, a time series database, long-term remote storage for Prometheus"); package = mkPackageOption pkgs "victoriametrics" { }; listenAddress = mkOption { default = ":8428"; diff --git a/nixos/modules/services/desktops/blueman.nix b/nixos/modules/services/desktops/blueman.nix index fad2f21bce5bd..f09dd91c9af51 100644 --- a/nixos/modules/services/desktops/blueman.nix +++ b/nixos/modules/services/desktops/blueman.nix @@ -9,7 +9,7 @@ in { ###### interface options = { services.blueman = { - enable = mkEnableOption (lib.mdDoc "blueman"); + enable = mkEnableOption (lib.mdDoc "blueman, a bluetooth manager"); }; }; diff --git a/nixos/modules/services/desktops/deepin/dde-api.nix b/nixos/modules/services/desktops/deepin/dde-api.nix index 459876febf21f..ece1599f5cc85 100644 --- a/nixos/modules/services/desktops/deepin/dde-api.nix +++ b/nixos/modules/services/desktops/deepin/dde-api.nix @@ -15,7 +15,7 @@ with lib; services.deepin.dde-api = { enable = mkEnableOption (lib.mdDoc '' - some dbus interfaces that is used for screen zone detecting, + the DDE API, which provides some dbus interfaces that is used for screen zone detecting, thumbnail generating, and sound playing in Deepin Desktop Environment ''); diff --git a/nixos/modules/services/desktops/neard.nix b/nixos/modules/services/desktops/neard.nix index 9130b8d3d216d..846297dfc1ad2 100644 --- a/nixos/modules/services/desktops/neard.nix +++ b/nixos/modules/services/desktops/neard.nix @@ -7,7 +7,7 @@ with lib; ###### interface options = { services.neard = { - enable = mkEnableOption (lib.mdDoc "neard, NFC daemon"); + enable = mkEnableOption (lib.mdDoc "neard, an NFC daemon"); }; }; diff --git a/nixos/modules/services/desktops/zeitgeist.nix b/nixos/modules/services/desktops/zeitgeist.nix index 0eb2a4c9c371b..caa2835316b03 100644 --- a/nixos/modules/services/desktops/zeitgeist.nix +++ b/nixos/modules/services/desktops/zeitgeist.nix @@ -14,7 +14,7 @@ with lib; options = { services.zeitgeist = { - enable = mkEnableOption (lib.mdDoc "zeitgeist"); + enable = mkEnableOption (lib.mdDoc "zeitgeist, a service which logs the users' activities and events"); }; }; diff --git a/nixos/modules/services/development/distccd.nix b/nixos/modules/services/development/distccd.nix index c33bf436bffb5..af59e1febd86b 100644 --- a/nixos/modules/services/development/distccd.nix +++ b/nixos/modules/services/development/distccd.nix @@ -8,7 +8,7 @@ in { options = { services.distccd = { - enable = mkEnableOption (lib.mdDoc "distccd"); + enable = mkEnableOption (lib.mdDoc "distccd, a distributed C/C++ compiler"); allowedClients = mkOption { type = types.listOf types.str; diff --git a/nixos/modules/services/development/gemstash.nix b/nixos/modules/services/development/gemstash.nix index eb7ccb98bde89..650c6680ee693 100644 --- a/nixos/modules/services/development/gemstash.nix +++ b/nixos/modules/services/development/gemstash.nix @@ -24,7 +24,7 @@ let in { options.services.gemstash = { - enable = mkEnableOption (lib.mdDoc "gemstash service"); + enable = mkEnableOption (lib.mdDoc "gemstash, a cache for rubygems.org and a private gem server"); openFirewall = mkOption { type = types.bool; diff --git a/nixos/modules/services/display-managers/greetd.nix b/nixos/modules/services/display-managers/greetd.nix index 5ce67c3fb3fd2..0f0205f9e0e48 100644 --- a/nixos/modules/services/display-managers/greetd.nix +++ b/nixos/modules/services/display-managers/greetd.nix @@ -8,7 +8,7 @@ let in { options.services.greetd = { - enable = mkEnableOption (lib.mdDoc "greetd"); + enable = mkEnableOption (lib.mdDoc "greetd, a minimal and flexible login manager daemon"); package = mkPackageOption pkgs [ "greetd" "greetd" ] { }; diff --git a/nixos/modules/services/finance/odoo.nix b/nixos/modules/services/finance/odoo.nix index aa9bd0014d985..3a3b3c2fa6eec 100644 --- a/nixos/modules/services/finance/odoo.nix +++ b/nixos/modules/services/finance/odoo.nix @@ -9,7 +9,7 @@ in { options = { services.odoo = { - enable = mkEnableOption (lib.mdDoc "odoo"); + enable = mkEnableOption (lib.mdDoc "odoo, an open source ERP and CRM system"); package = mkPackageOption pkgs "odoo" { }; diff --git a/nixos/modules/services/games/mchprs.nix b/nixos/modules/services/games/mchprs.nix index 71e546049c58b..36f7ea71d6351 100644 --- a/nixos/modules/services/games/mchprs.nix +++ b/nixos/modules/services/games/mchprs.nix @@ -22,7 +22,7 @@ in { options = { services.mchprs = { - enable = mkEnableOption "MCHPRS"; + enable = mkEnableOption "MCHPRS, a Minecraft server"; declarativeSettings = mkOption { type = types.bool; diff --git a/nixos/modules/services/games/openarena.nix b/nixos/modules/services/games/openarena.nix index 14e485b06a0df..592cec9a552f2 100644 --- a/nixos/modules/services/games/openarena.nix +++ b/nixos/modules/services/games/openarena.nix @@ -7,7 +7,7 @@ in { options = { services.openarena = { - enable = mkEnableOption (lib.mdDoc "OpenArena"); + enable = mkEnableOption (lib.mdDoc "OpenArena game server"); package = lib.mkPackageOption pkgs "openarena" { }; openPorts = mkOption { diff --git a/nixos/modules/services/hardware/kanata.nix b/nixos/modules/services/hardware/kanata.nix index 05e76d8432154..fa589f685a028 100644 --- a/nixos/modules/services/hardware/kanata.nix +++ b/nixos/modules/services/hardware/kanata.nix @@ -151,7 +151,7 @@ let in { options.services.kanata = { - enable = mkEnableOption (mdDoc "kanata"); + enable = mkEnableOption (mdDoc "kanata, a tool to improve keyboard comfort and usability with advanced customization"); package = mkPackageOption pkgs "kanata" { example = "kanata-with-cmd"; extraDescription = '' diff --git a/nixos/modules/services/hardware/lirc.nix b/nixos/modules/services/hardware/lirc.nix index 5b1a8d10c7299..c182c3895fb87 100644 --- a/nixos/modules/services/hardware/lirc.nix +++ b/nixos/modules/services/hardware/lirc.nix @@ -11,7 +11,7 @@ in { options = { services.lirc = { - enable = mkEnableOption (lib.mdDoc "LIRC daemon"); + enable = mkEnableOption (lib.mdDoc "the LIRC daemon, to receive and send infrared signals"); options = mkOption { type = types.lines; diff --git a/nixos/modules/services/hardware/openrgb.nix b/nixos/modules/services/hardware/openrgb.nix index 81b199e50778e..b400f77049f75 100644 --- a/nixos/modules/services/hardware/openrgb.nix +++ b/nixos/modules/services/hardware/openrgb.nix @@ -6,7 +6,7 @@ let cfg = config.services.hardware.openrgb; in { options.services.hardware.openrgb = { - enable = mkEnableOption (lib.mdDoc "OpenRGB server"); + enable = mkEnableOption (lib.mdDoc "OpenRGB server, for RGB lighting control"); package = mkPackageOption pkgs "openrgb" { }; diff --git a/nixos/modules/services/hardware/pcscd.nix b/nixos/modules/services/hardware/pcscd.nix index 77c2d9b53f03d..34df1f3e91ba3 100644 --- a/nixos/modules/services/hardware/pcscd.nix +++ b/nixos/modules/services/hardware/pcscd.nix @@ -18,7 +18,7 @@ let in { options.services.pcscd = { - enable = mkEnableOption (lib.mdDoc "PCSC-Lite daemon"); + enable = mkEnableOption (lib.mdDoc "PCSC-Lite daemon, to access smart cards using SCard API (PC/SC)"); plugins = mkOption { type = types.listOf types.package; diff --git a/nixos/modules/services/hardware/udev.nix b/nixos/modules/services/hardware/udev.nix index 670b9087f1107..2bf86a535fc10 100644 --- a/nixos/modules/services/hardware/udev.nix +++ b/nixos/modules/services/hardware/udev.nix @@ -200,7 +200,7 @@ in }; services.udev = { - enable = mkEnableOption (lib.mdDoc "udev") // { + enable = mkEnableOption (lib.mdDoc "udev, a device manager for the Linux kernel") // { default = true; }; diff --git a/nixos/modules/services/hardware/undervolt.nix b/nixos/modules/services/hardware/undervolt.nix index c4d4c6791a21b..ea4d60eac7c2c 100644 --- a/nixos/modules/services/hardware/undervolt.nix +++ b/nixos/modules/services/hardware/undervolt.nix @@ -37,7 +37,7 @@ in enable = mkEnableOption (lib.mdDoc '' Undervolting service for Intel CPUs. - Warning: This service is not endorsed by Intel and may permanently damage your hardware. Use at your own risk! + Warning: This service is not endorsed by Intel and may permanently damage your hardware. Use at your own risk ''); verbose = mkOption { diff --git a/nixos/modules/services/hardware/vdr.nix b/nixos/modules/services/hardware/vdr.nix index 689d83f7eedcd..0c9cc0abf798d 100644 --- a/nixos/modules/services/hardware/vdr.nix +++ b/nixos/modules/services/hardware/vdr.nix @@ -9,7 +9,7 @@ in options = { services.vdr = { - enable = mkEnableOption (mdDoc "Start VDR"); + enable = mkEnableOption (mdDoc "VDR, a video disk recorder"); package = mkPackageOption pkgs "vdr" { example = "wrapVdr.override { plugins = with pkgs.vdrPlugins; [ hello ]; }"; diff --git a/nixos/modules/services/home-automation/ebusd.nix b/nixos/modules/services/home-automation/ebusd.nix index f68a8bdb6bfa2..e1dcfb338421f 100644 --- a/nixos/modules/services/home-automation/ebusd.nix +++ b/nixos/modules/services/home-automation/ebusd.nix @@ -44,7 +44,7 @@ in meta.maintainers = with maintainers; [ nathan-gs ]; options.services.ebusd = { - enable = mkEnableOption (lib.mdDoc "ebusd service"); + enable = mkEnableOption (lib.mdDoc "ebusd, a daemon for communication with eBUS heating systems"); device = mkOption { type = types.str; diff --git a/nixos/modules/services/home-automation/esphome.nix b/nixos/modules/services/home-automation/esphome.nix index 3c0fd8aed08a4..ac623cf36b3a9 100644 --- a/nixos/modules/services/home-automation/esphome.nix +++ b/nixos/modules/services/home-automation/esphome.nix @@ -24,7 +24,7 @@ in meta.maintainers = with maintainers; [ oddlama ]; options.services.esphome = { - enable = mkEnableOption (mdDoc "esphome"); + enable = mkEnableOption (mdDoc "esphome, for making custom firmwares for ESP32/ESP8266"); package = lib.mkPackageOption pkgs "esphome" { }; diff --git a/nixos/modules/services/logging/awstats.nix b/nixos/modules/services/logging/awstats.nix index 708775bfcf03a..642118650c65e 100644 --- a/nixos/modules/services/logging/awstats.nix +++ b/nixos/modules/services/logging/awstats.nix @@ -95,7 +95,7 @@ in ]; options.services.awstats = { - enable = mkEnableOption (lib.mdDoc "awstats"); + enable = mkEnableOption (lib.mdDoc "awstats, a real-time logfile analyzer"); dataDir = mkOption { type = types.path; diff --git a/nixos/modules/services/logging/fluentd.nix b/nixos/modules/services/logging/fluentd.nix index c8718f26db383..cfc584309835c 100644 --- a/nixos/modules/services/logging/fluentd.nix +++ b/nixos/modules/services/logging/fluentd.nix @@ -12,7 +12,7 @@ in { options = { services.fluentd = { - enable = mkEnableOption (lib.mdDoc "fluentd"); + enable = mkEnableOption (lib.mdDoc "fluentd, a data/log collector"); config = mkOption { type = types.lines; diff --git a/nixos/modules/services/logging/graylog.nix b/nixos/modules/services/logging/graylog.nix index 673930c4cb5c6..853539d4d63bf 100644 --- a/nixos/modules/services/logging/graylog.nix +++ b/nixos/modules/services/logging/graylog.nix @@ -33,7 +33,7 @@ in services.graylog = { - enable = mkEnableOption (lib.mdDoc "Graylog"); + enable = mkEnableOption (lib.mdDoc "Graylog, a log management solution"); package = mkOption { type = types.package; diff --git a/nixos/modules/services/logging/heartbeat.nix b/nixos/modules/services/logging/heartbeat.nix index 768ffe5315fe0..84c15b1caeb28 100644 --- a/nixos/modules/services/logging/heartbeat.nix +++ b/nixos/modules/services/logging/heartbeat.nix @@ -18,7 +18,7 @@ in services.heartbeat = { - enable = mkEnableOption (lib.mdDoc "heartbeat"); + enable = mkEnableOption (lib.mdDoc "heartbeat, uptime monitoring"); package = mkPackageOption pkgs "heartbeat" { example = "heartbeat7"; diff --git a/nixos/modules/services/logging/logcheck.nix b/nixos/modules/services/logging/logcheck.nix index 5d87fc87d4161..44763afa9d238 100644 --- a/nixos/modules/services/logging/logcheck.nix +++ b/nixos/modules/services/logging/logcheck.nix @@ -109,7 +109,7 @@ in { options = { services.logcheck = { - enable = mkEnableOption (lib.mdDoc "logcheck cron job"); + enable = mkEnableOption (lib.mdDoc "logcheck cron job, to mail anomalies in the system logfiles to the administrator"); user = mkOption { default = "logcheck"; diff --git a/nixos/modules/services/logging/ulogd.nix b/nixos/modules/services/logging/ulogd.nix index 05c9797bb28bc..9beb0859cef52 100644 --- a/nixos/modules/services/logging/ulogd.nix +++ b/nixos/modules/services/logging/ulogd.nix @@ -8,7 +8,7 @@ let in { options = { services.ulogd = { - enable = mkEnableOption (lib.mdDoc "ulogd"); + enable = mkEnableOption (lib.mdDoc "ulogd, a userspace logging daemon for netfilter/iptables related logging"); settings = mkOption { example = { diff --git a/nixos/modules/services/logging/vector.nix b/nixos/modules/services/logging/vector.nix index 9ccf8a4fa0610..92605c4030873 100644 --- a/nixos/modules/services/logging/vector.nix +++ b/nixos/modules/services/logging/vector.nix @@ -6,7 +6,7 @@ let cfg = config.services.vector; in { options.services.vector = { - enable = mkEnableOption (lib.mdDoc "Vector"); + enable = mkEnableOption (lib.mdDoc "Vector, a high-performance observability data pipeline"); package = mkPackageOption pkgs "vector" { }; diff --git a/nixos/modules/services/mail/goeland.nix b/nixos/modules/services/mail/goeland.nix index 13092a65ed90e..a39d0d27d537b 100644 --- a/nixos/modules/services/mail/goeland.nix +++ b/nixos/modules/services/mail/goeland.nix @@ -8,7 +8,7 @@ let in { options.services.goeland = { - enable = mkEnableOption (mdDoc "goeland"); + enable = mkEnableOption (mdDoc "goeland, an alternative to rss2email"); settings = mkOption { description = mdDoc '' diff --git a/nixos/modules/services/mail/mailcatcher.nix b/nixos/modules/services/mail/mailcatcher.nix index d0f4550c19264..60abf3f2c5a02 100644 --- a/nixos/modules/services/mail/mailcatcher.nix +++ b/nixos/modules/services/mail/mailcatcher.nix @@ -11,7 +11,7 @@ in options = { services.mailcatcher = { - enable = mkEnableOption (lib.mdDoc "MailCatcher"); + enable = mkEnableOption (lib.mdDoc "MailCatcher, an SMTP server and web interface to locally test outbound emails"); http.ip = mkOption { type = types.str; diff --git a/nixos/modules/services/mail/mailhog.nix b/nixos/modules/services/mail/mailhog.nix index 7ae62de291bab..14df891fbb1a4 100644 --- a/nixos/modules/services/mail/mailhog.nix +++ b/nixos/modules/services/mail/mailhog.nix @@ -27,7 +27,7 @@ in options = { services.mailhog = { - enable = mkEnableOption (lib.mdDoc "MailHog"); + enable = mkEnableOption (lib.mdDoc "MailHog, web and API based SMTP testing"); storage = mkOption { type = types.enum [ "maildir" "memory" ]; diff --git a/nixos/modules/services/matrix/synapse.nix b/nixos/modules/services/matrix/synapse.nix index 7291c0fcbcdda..e6b8462642dda 100644 --- a/nixos/modules/services/matrix/synapse.nix +++ b/nixos/modules/services/matrix/synapse.nix @@ -367,7 +367,7 @@ in { }); in { services.matrix-synapse = { - enable = mkEnableOption (lib.mdDoc "matrix.org synapse"); + enable = mkEnableOption (lib.mdDoc "matrix.org synapse, the reference homeserver"); enableRegistrationScript = mkOption { type = types.bool; diff --git a/nixos/modules/services/misc/ankisyncd.nix b/nixos/modules/services/misc/ankisyncd.nix index f5acfbb0ee969..cb8671ebc5e67 100644 --- a/nixos/modules/services/misc/ankisyncd.nix +++ b/nixos/modules/services/misc/ankisyncd.nix @@ -22,7 +22,7 @@ let in { options.services.ankisyncd = { - enable = mkEnableOption (lib.mdDoc "ankisyncd"); + enable = mkEnableOption (lib.mdDoc "ankisyncd, a standalone unofficial anky sync server"); package = mkPackageOption pkgs "ankisyncd" { }; diff --git a/nixos/modules/services/misc/bepasty.nix b/nixos/modules/services/misc/bepasty.nix index 70d07629493b6..1061a78983784 100644 --- a/nixos/modules/services/misc/bepasty.nix +++ b/nixos/modules/services/misc/bepasty.nix @@ -13,7 +13,7 @@ let in { options.services.bepasty = { - enable = mkEnableOption (lib.mdDoc "Bepasty servers"); + enable = mkEnableOption (lib.mdDoc "bepasty, a binary pastebin server"); servers = mkOption { default = {}; diff --git a/nixos/modules/services/misc/calibre-server.nix b/nixos/modules/services/misc/calibre-server.nix index 66ae5fa91bb68..efc4b17c88747 100644 --- a/nixos/modules/services/misc/calibre-server.nix +++ b/nixos/modules/services/misc/calibre-server.nix @@ -32,7 +32,7 @@ in options = { services.calibre-server = { - enable = mkEnableOption (lib.mdDoc "calibre-server"); + enable = mkEnableOption (lib.mdDoc "calibre-server (e-book software)"); package = lib.mkPackageOption pkgs "calibre" { }; libraries = mkOption { diff --git a/nixos/modules/services/misc/confd.nix b/nixos/modules/services/misc/confd.nix index 93731547ede8b..98776f6e839f7 100644 --- a/nixos/modules/services/misc/confd.nix +++ b/nixos/modules/services/misc/confd.nix @@ -17,7 +17,7 @@ let in { options.services.confd = { - enable = mkEnableOption (lib.mdDoc "confd service"); + enable = mkEnableOption (lib.mdDoc "confd, a service to manage local application configuration files using templates and data from etcd/consul/redis/zookeeper"); backend = mkOption { description = lib.mdDoc "Confd config storage backend to use."; diff --git a/nixos/modules/services/misc/etesync-dav.nix b/nixos/modules/services/misc/etesync-dav.nix index ae2b5ad043433..ef2ba9086af46 100644 --- a/nixos/modules/services/misc/etesync-dav.nix +++ b/nixos/modules/services/misc/etesync-dav.nix @@ -7,7 +7,7 @@ let in { options.services.etesync-dav = { - enable = mkEnableOption (lib.mdDoc "etesync-dav"); + enable = mkEnableOption (lib.mdDoc "etesync-dav, end-to-end encrypted sync for contacts, calendars and tasks"); host = mkOption { type = types.str; diff --git a/nixos/modules/services/misc/evdevremapkeys.nix b/nixos/modules/services/misc/evdevremapkeys.nix index 11ea6a5f03f23..d623c038b174f 100644 --- a/nixos/modules/services/misc/evdevremapkeys.nix +++ b/nixos/modules/services/misc/evdevremapkeys.nix @@ -8,7 +8,7 @@ let in { options.services.evdevremapkeys = { - enable = mkEnableOption (lib.mdDoc ''evdevremapkeys''); + enable = mkEnableOption (lib.mdDoc ''evdevremapkeys, a daemon to remap events on linux input devices''); settings = mkOption { type = format.type; diff --git a/nixos/modules/services/misc/forgejo.nix b/nixos/modules/services/misc/forgejo.nix index 2b1700626870f..d9fd33ddedb1a 100644 --- a/nixos/modules/services/misc/forgejo.nix +++ b/nixos/modules/services/misc/forgejo.nix @@ -55,7 +55,7 @@ in options = { services.forgejo = { - enable = mkEnableOption (mdDoc "Forgejo"); + enable = mkEnableOption (mdDoc "Forgejo, a software forge"); package = mkPackageOption pkgs "forgejo" { }; diff --git a/nixos/modules/services/misc/geoipupdate.nix b/nixos/modules/services/misc/geoipupdate.nix index 27c1157e9a8c7..f18645ffb5895 100644 --- a/nixos/modules/services/misc/geoipupdate.nix +++ b/nixos/modules/services/misc/geoipupdate.nix @@ -12,7 +12,7 @@ in options = { services.geoipupdate = { enable = lib.mkEnableOption (lib.mdDoc '' - periodic downloading of GeoIP databases using geoipupdate. + periodic downloading of GeoIP databases using geoipupdate ''); interval = lib.mkOption { diff --git a/nixos/modules/services/misc/gollum.nix b/nixos/modules/services/misc/gollum.nix index e31eeaf8a30a8..04ac89970e3f6 100644 --- a/nixos/modules/services/misc/gollum.nix +++ b/nixos/modules/services/misc/gollum.nix @@ -8,7 +8,7 @@ in { options.services.gollum = { - enable = mkEnableOption (lib.mdDoc "Gollum service"); + enable = mkEnableOption (lib.mdDoc "Gollum, a git-powered wiki service"); address = mkOption { type = types.str; diff --git a/nixos/modules/services/misc/greenclip.nix b/nixos/modules/services/misc/greenclip.nix index ecfb864ab2b78..554769b63331f 100644 --- a/nixos/modules/services/misc/greenclip.nix +++ b/nixos/modules/services/misc/greenclip.nix @@ -7,7 +7,7 @@ let in { options.services.greenclip = { - enable = mkEnableOption (lib.mdDoc "Greenclip daemon"); + enable = mkEnableOption (lib.mdDoc "Greenclip, a clipboard manager"); package = mkPackageOption pkgs [ "haskellPackages" "greenclip" ] { }; }; diff --git a/nixos/modules/services/misc/homepage-dashboard.nix b/nixos/modules/services/misc/homepage-dashboard.nix index 02f1378cb0d59..e1b0264230ba5 100644 --- a/nixos/modules/services/misc/homepage-dashboard.nix +++ b/nixos/modules/services/misc/homepage-dashboard.nix @@ -12,7 +12,7 @@ in { options = { services.homepage-dashboard = { - enable = lib.mkEnableOption (lib.mdDoc "Homepage Dashboard"); + enable = lib.mkEnableOption (lib.mdDoc "Homepage Dashboard, a highly customizable application dashboard"); package = lib.mkPackageOption pkgs "homepage-dashboard" { }; diff --git a/nixos/modules/services/misc/jackett.nix b/nixos/modules/services/misc/jackett.nix index c0bb0a575f01d..ad9288e45dd29 100644 --- a/nixos/modules/services/misc/jackett.nix +++ b/nixos/modules/services/misc/jackett.nix @@ -9,7 +9,7 @@ in { options = { services.jackett = { - enable = mkEnableOption (lib.mdDoc "Jackett"); + enable = mkEnableOption (lib.mdDoc "Jackett, API support for your favorite torrent trackers"); dataDir = mkOption { type = types.str; diff --git a/nixos/modules/services/misc/languagetool.nix b/nixos/modules/services/misc/languagetool.nix index 9adf792373b5a..902e55320b46d 100644 --- a/nixos/modules/services/misc/languagetool.nix +++ b/nixos/modules/services/misc/languagetool.nix @@ -7,7 +7,7 @@ let settingsFormat = pkgs.formats.javaProperties {}; in { options.services.languagetool = { - enable = mkEnableOption (mdDoc "the LanguageTool server"); + enable = mkEnableOption (mdDoc "the LanguageTool server, a multilingual spelling, style, and grammar checker that helps correct or paraphrase texts"); port = mkOption { type = types.port; diff --git a/nixos/modules/services/misc/leaps.nix b/nixos/modules/services/misc/leaps.nix index 5522223ecc97c..b021937f8715c 100644 --- a/nixos/modules/services/misc/leaps.nix +++ b/nixos/modules/services/misc/leaps.nix @@ -9,7 +9,7 @@ in { options = { services.leaps = { - enable = mkEnableOption (lib.mdDoc "leaps"); + enable = mkEnableOption (lib.mdDoc "leaps, a pair programming service"); port = mkOption { type = types.port; default = 8080; diff --git a/nixos/modules/services/misc/lidarr.nix b/nixos/modules/services/misc/lidarr.nix index 8ceb567e88010..42627344dcd95 100644 --- a/nixos/modules/services/misc/lidarr.nix +++ b/nixos/modules/services/misc/lidarr.nix @@ -8,7 +8,7 @@ in { options = { services.lidarr = { - enable = mkEnableOption (lib.mdDoc "Lidarr"); + enable = mkEnableOption (lib.mdDoc "Lidarr, a Usenet/BitTorrent music downloader"); dataDir = mkOption { type = types.str; diff --git a/nixos/modules/services/misc/lifecycled.nix b/nixos/modules/services/misc/lifecycled.nix index fb5cabb4f038b..fa36ec693a844 100644 --- a/nixos/modules/services/misc/lifecycled.nix +++ b/nixos/modules/services/misc/lifecycled.nix @@ -25,7 +25,7 @@ in options = { services.lifecycled = { - enable = mkEnableOption (lib.mdDoc "lifecycled"); + enable = mkEnableOption (lib.mdDoc "lifecycled, a daemon for responding to AWS AutoScaling Lifecycle Hooks"); queueCleaner = { enable = mkEnableOption (lib.mdDoc "lifecycled-queue-cleaner"); diff --git a/nixos/modules/services/misc/logkeys.nix b/nixos/modules/services/misc/logkeys.nix index 75d073a0c94bf..85f453b0d9da1 100644 --- a/nixos/modules/services/misc/logkeys.nix +++ b/nixos/modules/services/misc/logkeys.nix @@ -6,7 +6,7 @@ let cfg = config.services.logkeys; in { options.services.logkeys = { - enable = mkEnableOption (lib.mdDoc "logkeys service"); + enable = mkEnableOption (lib.mdDoc "logkeys, a keylogger service"); device = mkOption { description = lib.mdDoc "Use the given device as keyboard input event device instead of /dev/input/eventX default."; diff --git a/nixos/modules/services/misc/nitter.nix b/nixos/modules/services/misc/nitter.nix index d2cf7c0de2b77..0f2f62153b00e 100644 --- a/nixos/modules/services/misc/nitter.nix +++ b/nixos/modules/services/misc/nitter.nix @@ -52,7 +52,7 @@ in options = { services.nitter = { - enable = mkEnableOption (lib.mdDoc "Nitter"); + enable = mkEnableOption (lib.mdDoc "Nitter, an alternative Twitter front-end"); package = mkPackageOption pkgs "nitter" { }; diff --git a/nixos/modules/services/misc/nzbget.nix b/nixos/modules/services/misc/nzbget.nix index d02fda62fa4fa..122b3dd249af4 100644 --- a/nixos/modules/services/misc/nzbget.nix +++ b/nixos/modules/services/misc/nzbget.nix @@ -25,7 +25,7 @@ in options = { services.nzbget = { - enable = mkEnableOption (lib.mdDoc "NZBGet"); + enable = mkEnableOption (lib.mdDoc "NZBGet, for downloading files from news servers"); user = mkOption { type = types.str; diff --git a/nixos/modules/services/misc/nzbhydra2.nix b/nixos/modules/services/misc/nzbhydra2.nix index 536a4e4b00758..2c1a5eae076d2 100644 --- a/nixos/modules/services/misc/nzbhydra2.nix +++ b/nixos/modules/services/misc/nzbhydra2.nix @@ -7,7 +7,7 @@ let cfg = config.services.nzbhydra2; in { options = { services.nzbhydra2 = { - enable = mkEnableOption (lib.mdDoc "NZBHydra2"); + enable = mkEnableOption (lib.mdDoc "NZBHydra2, Usenet meta search"); dataDir = mkOption { type = types.str; diff --git a/nixos/modules/services/misc/ombi.nix b/nixos/modules/services/misc/ombi.nix index 8bf6a9b116ec2..2e452f7d88eac 100644 --- a/nixos/modules/services/misc/ombi.nix +++ b/nixos/modules/services/misc/ombi.nix @@ -8,7 +8,9 @@ in { options = { services.ombi = { enable = mkEnableOption (lib.mdDoc '' - Ombi. + Ombi, a web application that automatically gives your shared Plex or + Emby users the ability to request content by themselves! + Optionally see <https://docs.ombi.app/info/reverse-proxy> on how to set up a reverse proxy ''); diff --git a/nixos/modules/services/misc/owncast.nix b/nixos/modules/services/misc/owncast.nix index 01fe34cf50fec..cbb6ba29e3227 100644 --- a/nixos/modules/services/misc/owncast.nix +++ b/nixos/modules/services/misc/owncast.nix @@ -5,7 +5,7 @@ in { options.services.owncast = { - enable = mkEnableOption (lib.mdDoc "owncast"); + enable = mkEnableOption (lib.mdDoc "owncast, a video live streaming solution"); dataDir = mkOption { type = types.str; diff --git a/nixos/modules/services/misc/pinnwand.nix b/nixos/modules/services/misc/pinnwand.nix index 5fca9f4125a83..466d045a7b16b 100644 --- a/nixos/modules/services/misc/pinnwand.nix +++ b/nixos/modules/services/misc/pinnwand.nix @@ -10,7 +10,7 @@ let in { options.services.pinnwand = { - enable = mkEnableOption (lib.mdDoc "Pinnwand"); + enable = mkEnableOption (lib.mdDoc "Pinnwand, a pastebin"); port = mkOption { type = types.port; diff --git a/nixos/modules/services/misc/plikd.nix b/nixos/modules/services/misc/plikd.nix index 9b0825bf40c98..bb5d3c1a36ca5 100644 --- a/nixos/modules/services/misc/plikd.nix +++ b/nixos/modules/services/misc/plikd.nix @@ -11,7 +11,7 @@ in { options = { services.plikd = { - enable = mkEnableOption (lib.mdDoc "the plikd server"); + enable = mkEnableOption (lib.mdDoc "plikd, a temporary file upload system"); openFirewall = mkOption { type = types.bool; diff --git a/nixos/modules/services/misc/prowlarr.nix b/nixos/modules/services/misc/prowlarr.nix index 84d365003992c..952f95485bd08 100644 --- a/nixos/modules/services/misc/prowlarr.nix +++ b/nixos/modules/services/misc/prowlarr.nix @@ -9,7 +9,7 @@ in { options = { services.prowlarr = { - enable = mkEnableOption (lib.mdDoc "Prowlarr"); + enable = mkEnableOption (lib.mdDoc "Prowlarr, an indexer manager/proxy for Torrent trackers and Usenet indexers"); package = mkPackageOption pkgs "prowlarr" { }; diff --git a/nixos/modules/services/misc/radarr.nix b/nixos/modules/services/misc/radarr.nix index a5f264331ed36..eaf49673d3c7e 100644 --- a/nixos/modules/services/misc/radarr.nix +++ b/nixos/modules/services/misc/radarr.nix @@ -9,7 +9,7 @@ in { options = { services.radarr = { - enable = mkEnableOption (lib.mdDoc "Radarr"); + enable = mkEnableOption (lib.mdDoc "Radarr, a UsetNet/BitTorrent movie downloader"); package = mkPackageOption pkgs "radarr" { }; diff --git a/nixos/modules/services/misc/readarr.nix b/nixos/modules/services/misc/readarr.nix index 73868b4baa953..486e2b4155b56 100644 --- a/nixos/modules/services/misc/readarr.nix +++ b/nixos/modules/services/misc/readarr.nix @@ -8,7 +8,7 @@ in { options = { services.readarr = { - enable = mkEnableOption (lib.mdDoc "Readarr"); + enable = mkEnableOption (lib.mdDoc "Readarr, a Usenet/BitTorrent ebook downloader"); dataDir = mkOption { type = types.str; diff --git a/nixos/modules/services/misc/redmine.nix b/nixos/modules/services/misc/redmine.nix index 8ebc46b42dcc8..f99fe7a845be4 100644 --- a/nixos/modules/services/misc/redmine.nix +++ b/nixos/modules/services/misc/redmine.nix @@ -56,7 +56,7 @@ in # interface options = { services.redmine = { - enable = mkEnableOption (lib.mdDoc "Redmine"); + enable = mkEnableOption (lib.mdDoc "Redmine, a project management web application"); package = mkPackageOption pkgs "redmine" { example = "redmine.override { ruby = pkgs.ruby_3_2; }"; diff --git a/nixos/modules/services/misc/rippled.nix b/nixos/modules/services/misc/rippled.nix index 68a8318942506..08833e4135419 100644 --- a/nixos/modules/services/misc/rippled.nix +++ b/nixos/modules/services/misc/rippled.nix @@ -207,7 +207,7 @@ in options = { services.rippled = { - enable = mkEnableOption (lib.mdDoc "rippled"); + enable = mkEnableOption (lib.mdDoc "rippled, a decentralized cryptocurrency blockchain daemon implementing the XRP Ledger protocol in C++"); package = mkPackageOption pkgs "rippled" { }; diff --git a/nixos/modules/services/misc/signald.nix b/nixos/modules/services/misc/signald.nix index 32ba154506ce3..44b82a931cd84 100644 --- a/nixos/modules/services/misc/signald.nix +++ b/nixos/modules/services/misc/signald.nix @@ -8,7 +8,7 @@ let in { options.services.signald = { - enable = mkEnableOption (lib.mdDoc "the signald service"); + enable = mkEnableOption (lib.mdDoc "signald, the unofficial daemon for interacting with Signal"); user = mkOption { type = types.str; diff --git a/nixos/modules/services/web-apps/castopod.nix b/nixos/modules/services/web-apps/castopod.nix index 0ccba217be4dd..0b905bb50761e 100644 --- a/nixos/modules/services/web-apps/castopod.nix +++ b/nixos/modules/services/web-apps/castopod.nix @@ -21,7 +21,7 @@ in options.services = { castopod = { - enable = lib.mkEnableOption (lib.mdDoc "Castopod"); + enable = lib.mkEnableOption (lib.mdDoc "Castopod, a hosting platform for podcasters"); package = lib.mkOption { type = lib.types.package; default = pkgs.castopod; |