From c83a907882e07f1dc6119461071c593dda6dfc53 Mon Sep 17 00:00:00 2001 From: ibizaman Date: Sun, 3 Dec 2023 21:19:47 -0800 Subject: [PATCH] add missing definitions --- modules/blocks/authelia.nix | 8 ++++++++ modules/blocks/davfs.nix | 1 + modules/blocks/monitoring.nix | 1 + modules/blocks/postgresql.nix | 1 + modules/services/arr.nix | 6 ++++++ modules/services/vaultwarden.nix | 2 ++ 6 files changed, 19 insertions(+) diff --git a/modules/blocks/authelia.nix b/modules/blocks/authelia.nix index a3c3e3d..aa5a558 100644 --- a/modules/blocks/authelia.nix +++ b/modules/blocks/authelia.nix @@ -42,28 +42,36 @@ in }; secrets = lib.mkOption { + description = "Secrets needed by Authelia"; type = lib.types.submodule { options = { jwtSecretFile = lib.mkOption { type = lib.types.str; + description = "File containing the JWT secret."; }; ldapAdminPasswordFile = lib.mkOption { type = lib.types.str; + description = "File containing the LDAP admin user password."; }; sessionSecretFile = lib.mkOption { type = lib.types.str; + description = "File containing the session secret."; }; notifierSMTPPasswordFile = lib.mkOption { type = lib.types.str; + description = "File containing the STMP password for the notifier."; }; storageEncryptionKeyFile = lib.mkOption { type = lib.types.str; + description = "File containing the storage encryption key."; }; identityProvidersOIDCHMACSecretFile = lib.mkOption { type = lib.types.str; + description = "File containing the identity provider OIDC HMAC secret."; }; identityProvidersOIDCIssuerPrivateKeyFile = lib.mkOption { type = lib.types.str; + description = "File containing the identity provider OIDC issuer private key."; }; }; }; diff --git a/modules/blocks/davfs.nix b/modules/blocks/davfs.nix index 8261932..9292ef9 100644 --- a/modules/blocks/davfs.nix +++ b/modules/blocks/davfs.nix @@ -18,6 +18,7 @@ in { options.shb.davfs = { mounts = lib.mkOption { + description = "List of mounts."; default = []; type = lib.types.listOf (lib.types.submodule { options = { diff --git a/modules/blocks/monitoring.nix b/modules/blocks/monitoring.nix index abba7e4..06765ff 100644 --- a/modules/blocks/monitoring.nix +++ b/modules/blocks/monitoring.nix @@ -75,6 +75,7 @@ in }; smtp = lib.mkOption { + description = "SMTP options."; default = null; type = lib.types.nullOr (lib.types.submodule { options = { diff --git a/modules/blocks/postgresql.nix b/modules/blocks/postgresql.nix index 5ddd813..136822d 100644 --- a/modules/blocks/postgresql.nix +++ b/modules/blocks/postgresql.nix @@ -21,6 +21,7 @@ in }; ensures = lib.mkOption { + description = "List of username, database and/or passwords that should be created."; type = lib.types.listOf (lib.types.submodule { options = { username = lib.mkOption { diff --git a/modules/services/arr.nix b/modules/services/arr.nix index a650d59..f995252 100644 --- a/modules/services/arr.nix +++ b/modules/services/arr.nix @@ -9,15 +9,18 @@ let settingsFormat = formatXML {}; moreOptions = { settings = lib.mkOption { + description = "Specific options for radarr."; default = {}; type = lib.types.submodule { freeformType = apps.radarr.settingsFormat.type; options = { APIKeyFile = lib.mkOption { type = lib.types.path; + description = "Path to api key secret file."; }; LogLevel = lib.mkOption { type = lib.types.enum ["debug" "info"]; + description = "Log level."; default = "info"; }; }; @@ -58,6 +61,7 @@ let }; OmdbApiKeyFile = lib.mkOption { type = lib.types.nullOr lib.types.path; + description = "File containing the Open Movie Database API key."; default = null; }; ProxyType = lib.mkOption { @@ -72,10 +76,12 @@ let }; ProxyUrl = lib.mkOption { type = lib.types.nullOr lib.types.str; + description = "URL of the proxy. Ignored if ProxyType is set to -1"; default = null; }; ProxyPort = lib.mkOption { type = lib.types.nullOr lib.types.port; + description = "Port of the proxy. Ignored if ProxyType is set to -1"; default = null; }; }; diff --git a/modules/services/vaultwarden.nix b/modules/services/vaultwarden.nix index e286393..2e57bff 100644 --- a/modules/services/vaultwarden.nix +++ b/modules/services/vaultwarden.nix @@ -57,6 +57,7 @@ in }; smtp = lib.mkOption { + description = "SMTP options."; type = lib.types.submodule { options = { from_address = lib.mkOption { @@ -102,6 +103,7 @@ in backupConfig = lib.mkOption { type = lib.types.nullOr lib.types.anything; + description = "Backup configuration of Vaultwarden."; default = null; };