summaryrefslogtreecommitdiffstats
path: root/nixos/modules/services/admin
diff options
context:
space:
mode:
authorstuebinm <stuebinm@disroot.org>2024-04-13 14:54:15 +0200
committerJonathan Ringer <jonringer@users.noreply.github.com>2024-04-13 10:07:35 -0700
commit6afb255d976f85f3359e4929abd6f5149c323a02 (patch)
treeced23a118ee0852174d31005acd16f04cad3a781 /nixos/modules/services/admin
parent1dd996e59a5e67694b7a252aacba71a88d51b41e (diff)
nixos: remove all uses of lib.mdDoc
these changes were generated with nixq 0.0.2, by running nixq ">> lib.mdDoc[remove] Argument[keep]" --batchmode nixos/**.nix nixq ">> mdDoc[remove] Argument[keep]" --batchmode nixos/**.nix nixq ">> Inherit >> mdDoc[remove]" --batchmode nixos/**.nix two mentions of the mdDoc function remain in nixos/, both of which are inside of comments. Since lib.mdDoc is already defined as just id, this commit is a no-op as far as Nix (and the built manual) is concerned.
Diffstat (limited to 'nixos/modules/services/admin')
-rw-r--r--nixos/modules/services/admin/meshcentral.nix4
-rw-r--r--nixos/modules/services/admin/oxidized.nix12
-rw-r--r--nixos/modules/services/admin/pgadmin.nix30
-rw-r--r--nixos/modules/services/admin/salt/master.nix4
-rw-r--r--nixos/modules/services/admin/salt/minion.nix4
5 files changed, 27 insertions, 27 deletions
diff --git a/nixos/modules/services/admin/meshcentral.nix b/nixos/modules/services/admin/meshcentral.nix
index d056356568da..25779e01123e 100644
--- a/nixos/modules/services/admin/meshcentral.nix
+++ b/nixos/modules/services/admin/meshcentral.nix
@@ -5,10 +5,10 @@ let
configFile = configFormat.generate "meshcentral-config.json" cfg.settings;
in with lib; {
options.services.meshcentral = with types; {
- enable = mkEnableOption (lib.mdDoc "MeshCentral computer management server");
+ enable = mkEnableOption "MeshCentral computer management server";
package = mkPackageOption pkgs "meshcentral" { };
settings = mkOption {
- description = lib.mdDoc ''
+ description = ''
Settings for MeshCentral. Refer to upstream documentation for details:
- [JSON Schema definition](https://github.com/Ylianst/MeshCentral/blob/master/meshcentral-config-schema.json)
diff --git a/nixos/modules/services/admin/oxidized.nix b/nixos/modules/services/admin/oxidized.nix
index 56f33031498a..49ea3ced76a4 100644
--- a/nixos/modules/services/admin/oxidized.nix
+++ b/nixos/modules/services/admin/oxidized.nix
@@ -7,12 +7,12 @@ let
in
{
options.services.oxidized = {
- enable = mkEnableOption (lib.mdDoc "the oxidized configuration backup service");
+ enable = mkEnableOption "the oxidized configuration backup service";
user = mkOption {
type = types.str;
default = "oxidized";
- description = lib.mdDoc ''
+ description = ''
User under which the oxidized service runs.
'';
};
@@ -20,7 +20,7 @@ in
group = mkOption {
type = types.str;
default = "oxidized";
- description = lib.mdDoc ''
+ description = ''
Group under which the oxidized service runs.
'';
};
@@ -28,7 +28,7 @@ in
dataDir = mkOption {
type = types.path;
default = "/var/lib/oxidized";
- description = lib.mdDoc "State directory for the oxidized service.";
+ description = "State directory for the oxidized service.";
};
configFile = mkOption {
@@ -62,7 +62,7 @@ in
# ... additional config
''';
'';
- description = lib.mdDoc ''
+ description = ''
Path to the oxidized configuration file.
'';
};
@@ -76,7 +76,7 @@ in
# ... additional hosts
'''
'';
- description = lib.mdDoc ''
+ description = ''
Path to the file/database which contains the targets for oxidized.
'';
};
diff --git a/nixos/modules/services/admin/pgadmin.nix b/nixos/modules/services/admin/pgadmin.nix
index 20b6b6670d9c..ead0c3c6c9a3 100644
--- a/nixos/modules/services/admin/pgadmin.nix
+++ b/nixos/modules/services/admin/pgadmin.nix
@@ -27,10 +27,10 @@ let
in
{
options.services.pgadmin = {
- enable = mkEnableOption (lib.mdDoc "PostgreSQL Admin 4");
+ enable = mkEnableOption "PostgreSQL Admin 4";
port = mkOption {
- description = lib.mdDoc "Port for pgadmin4 to run on";
+ description = "Port for pgadmin4 to run on";
type = types.port;
default = 5050;
};
@@ -38,12 +38,12 @@ in
package = mkPackageOptionMD pkgs "pgadmin4" { };
initialEmail = mkOption {
- description = lib.mdDoc "Initial email for the pgAdmin account";
+ description = "Initial email for the pgAdmin account";
type = types.str;
};
initialPasswordFile = mkOption {
- description = lib.mdDoc ''
+ description = ''
Initial password file for the pgAdmin account. Minimum length by default is 6.
Please see `services.pgadmin.minimumPasswordLength`.
NOTE: Should be string not a store path, to prevent the password from being world readable
@@ -52,53 +52,53 @@ in
};
minimumPasswordLength = mkOption {
- description = lib.mdDoc "Minimum length of the password";
+ description = "Minimum length of the password";
type = types.int;
default = 6;
};
emailServer = {
enable = mkOption {
- description = lib.mdDoc ''
+ description = ''
Enable SMTP email server. This is necessary, if you want to use password recovery or change your own password
'';
type = types.bool;
default = false;
};
address = mkOption {
- description = lib.mdDoc "SMTP server for email delivery";
+ description = "SMTP server for email delivery";
type = types.str;
default = "localhost";
};
port = mkOption {
- description = lib.mdDoc "SMTP server port for email delivery";
+ description = "SMTP server port for email delivery";
type = types.port;
default = 25;
};
useSSL = mkOption {
- description = lib.mdDoc "SMTP server should use SSL";
+ description = "SMTP server should use SSL";
type = types.bool;
default = false;
};
useTLS = mkOption {
- description = lib.mdDoc "SMTP server should use TLS";
+ description = "SMTP server should use TLS";
type = types.bool;
default = false;
};
username = mkOption {
- description = lib.mdDoc "SMTP server username for email delivery";
+ description = "SMTP server username for email delivery";
type = types.nullOr types.str;
default = null;
};
sender = mkOption {
- description = lib.mdDoc ''
+ description = ''
SMTP server sender email for email delivery. Some servers require this to be a valid email address from that server
'';
type = types.str;
example = "noreply@example.com";
};
passwordFile = mkOption {
- description = lib.mdDoc ''
+ description = ''
Password for SMTP email account.
NOTE: Should be string not a store path, to prevent the password from being world readable
'';
@@ -106,10 +106,10 @@ in
};
};
- openFirewall = mkEnableOption (lib.mdDoc "firewall passthrough for pgadmin4");
+ openFirewall = mkEnableOption "firewall passthrough for pgadmin4";
settings = mkOption {
- description = lib.mdDoc ''
+ description = ''
Settings for pgadmin4.
[Documentation](https://www.pgadmin.org/docs/pgadmin4/development/config_py.html)
'';
diff --git a/nixos/modules/services/admin/salt/master.nix b/nixos/modules/services/admin/salt/master.nix
index e10a10efae65..c447540da1f8 100644
--- a/nixos/modules/services/admin/salt/master.nix
+++ b/nixos/modules/services/admin/salt/master.nix
@@ -20,11 +20,11 @@ in
{
options = {
services.salt.master = {
- enable = mkEnableOption (lib.mdDoc "Salt configuration management system master service");
+ enable = mkEnableOption "Salt configuration management system master service";
configuration = mkOption {
type = types.attrs;
default = {};
- description = lib.mdDoc "Salt master configuration as Nix attribute set.";
+ description = "Salt master configuration as Nix attribute set.";
};
};
};
diff --git a/nixos/modules/services/admin/salt/minion.nix b/nixos/modules/services/admin/salt/minion.nix
index 28b52e07c40b..5d4efc6541c7 100644
--- a/nixos/modules/services/admin/salt/minion.nix
+++ b/nixos/modules/services/admin/salt/minion.nix
@@ -21,11 +21,11 @@ in
{
options = {
services.salt.minion = {
- enable = mkEnableOption (lib.mdDoc "Salt configuration management system minion service");
+ enable = mkEnableOption "Salt configuration management system minion service";
configuration = mkOption {
type = types.attrs;
default = {};
- description = lib.mdDoc ''
+ description = ''
Salt minion configuration as Nix attribute set.
See <https://docs.saltstack.com/en/latest/ref/configuration/minion.html>
for details.