summaryrefslogtreecommitdiffstats
path: root/nixos/modules/services/misc
diff options
context:
space:
mode:
authorBjørn Forsman <bjorn.forsman@gmail.com>2023-10-18 14:08:30 +0200
committerBjørn Forsman <bjorn.forsman@gmail.com>2024-04-09 07:10:17 +0200
commita29010fe79b07b603982d9e44c2a5face9dc9977 (patch)
tree41da467b5fd802349ea6ed927b7373b6606900f1 /nixos/modules/services/misc
parent34852ddf5e9203075805af70c3e556292c03ddb3 (diff)
nixos: improve many 'enable' descriptions
Diffstat (limited to 'nixos/modules/services/misc')
-rw-r--r--nixos/modules/services/misc/ankisyncd.nix2
-rw-r--r--nixos/modules/services/misc/bepasty.nix2
-rw-r--r--nixos/modules/services/misc/calibre-server.nix2
-rw-r--r--nixos/modules/services/misc/confd.nix2
-rw-r--r--nixos/modules/services/misc/etesync-dav.nix2
-rw-r--r--nixos/modules/services/misc/evdevremapkeys.nix2
-rw-r--r--nixos/modules/services/misc/forgejo.nix2
-rw-r--r--nixos/modules/services/misc/geoipupdate.nix2
-rw-r--r--nixos/modules/services/misc/gollum.nix2
-rw-r--r--nixos/modules/services/misc/greenclip.nix2
-rw-r--r--nixos/modules/services/misc/homepage-dashboard.nix2
-rw-r--r--nixos/modules/services/misc/jackett.nix2
-rw-r--r--nixos/modules/services/misc/languagetool.nix2
-rw-r--r--nixos/modules/services/misc/leaps.nix2
-rw-r--r--nixos/modules/services/misc/lidarr.nix2
-rw-r--r--nixos/modules/services/misc/lifecycled.nix2
-rw-r--r--nixos/modules/services/misc/logkeys.nix2
-rw-r--r--nixos/modules/services/misc/nitter.nix2
-rw-r--r--nixos/modules/services/misc/nzbget.nix2
-rw-r--r--nixos/modules/services/misc/nzbhydra2.nix2
-rw-r--r--nixos/modules/services/misc/ombi.nix4
-rw-r--r--nixos/modules/services/misc/owncast.nix2
-rw-r--r--nixos/modules/services/misc/pinnwand.nix2
-rw-r--r--nixos/modules/services/misc/plikd.nix2
-rw-r--r--nixos/modules/services/misc/prowlarr.nix2
-rw-r--r--nixos/modules/services/misc/radarr.nix2
-rw-r--r--nixos/modules/services/misc/readarr.nix2
-rw-r--r--nixos/modules/services/misc/redmine.nix2
-rw-r--r--nixos/modules/services/misc/rippled.nix2
-rw-r--r--nixos/modules/services/misc/signald.nix2
30 files changed, 32 insertions, 30 deletions
diff --git a/nixos/modules/services/misc/ankisyncd.nix b/nixos/modules/services/misc/ankisyncd.nix
index f5acfbb0ee96..cb8671ebc5e6 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 70d07629493b..1061a7898378 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 66ae5fa91bb6..efc4b17c8874 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 93731547ede8..98776f6e839f 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 ae2b5ad04343..ef2ba9086af4 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 11ea6a5f03f2..d623c038b174 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 2b1700626870..d9fd33ddedb1 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 27c1157e9a8c..f18645ffb589 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 e31eeaf8a30a..04ac89970e3f 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 ecfb864ab2b7..554769b63331 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 02f1378cb0d5..e1b0264230ba 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 c0bb0a575f01..ad9288e45dd2 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 9adf792373b5..902e55320b46 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 5522223ecc97..b021937f8715 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 8ceb567e8801..42627344dcd9 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 fb5cabb4f038..fa36ec693a84 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 75d073a0c94b..85f453b0d9da 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 d2cf7c0de2b7..0f2f62153b00 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 d02fda62fa4f..122b3dd249af 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 536a4e4b0075..2c1a5eae076d 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 8bf6a9b116ec..2e452f7d88ea 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 01fe34cf50fe..cbb6ba29e322 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 5fca9f4125a8..466d045a7b16 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 9b0825bf40c9..bb5d3c1a36ca 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 84d365003992..952f95485bd0 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 a5f264331ed3..eaf49673d3c7 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 73868b4baa95..486e2b4155b5 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 8ebc46b42dcc..f99fe7a845be 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 68a831894250..08833e413541 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 32ba154506ce..44b82a931cd8 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;