hosting/selfhostblocks
1
0
Fork 0
Code Issues Activity

add more descriptions to arr options

Browse source
This commit is contained in:
ibizaman 2023-11-30 12:01:35 -08:00
parent 886ceab801
commit 572125c5f6
1 changed files with 8 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
modules/services/arr.nix
View file

@ -42,15 +42,18 @@ let
settingsFormat = pkgs.formats.json {}; settingsFormat = pkgs.formats.json {};
moreOptions = { moreOptions = {
settings = lib.mkOption { settings = lib.mkOption {
description = "Specific options for jackett.";
default = {}; default = {};
type = lib.types.submodule { type = lib.types.submodule {
freeformType = apps.jackett.settingsFormat.type; freeformType = apps.jackett.settingsFormat.type;
options = { options = {
APIKeyFile = lib.mkOption { APIKeyFile = lib.mkOption {
type = lib.types.path; type = lib.types.path;
description = "Path to api key secret file.";
}; };
FlareSolverrUrl = lib.mkOption { FlareSolverrUrl = lib.mkOption {
type = lib.types.nullOr lib.types.str; type = lib.types.nullOr lib.types.str;
description = "FlareSolverr endpoint.";
default = null; default = null;
}; };
OmdbApiKeyFile = lib.mkOption { OmdbApiKeyFile = lib.mkOption {
@ -59,7 +62,7 @@ let
}; };
ProxyType = lib.mkOption { ProxyType = lib.mkOption {
type = lib.types.enum [ "-1" "0" "1" "2" ]; type = lib.types.enum [ "-1" "0" "1" "2" ];
default = "0"; default = "-1";
description = '' description = ''
-1 = disabled -1 = disabled
0 = HTTP 0 = HTTP
@ -123,7 +126,7 @@ let
default = {}; default = {};
type = lib.types.submodule { type = lib.types.submodule {
options = { options = {
enable = lib.mkEnableOption "selfhostblocks.${name}"; enable = lib.mkEnableOption name;
subdomain = lib.mkOption { subdomain = lib.mkOption {
type = lib.types.str; type = lib.types.str;
@ -134,7 +137,7 @@ let
domain = lib.mkOption { domain = lib.mkOption {
type = lib.types.str; type = lib.types.str;
description = "Domain under which ${name} will be served."; description = "Domain under which ${name} will be served.";
example = "mydomain.com"; example = "example.com";
}; };
port = lib.mkOption { port = lib.mkOption {
@ -145,14 +148,14 @@ let
dataDir = lib.mkOption { dataDir = lib.mkOption {
type = lib.types.str; type = lib.types.str;
description = "Directory where state of ${name} is stored."; description = "Directory where ${name} stores data.";
default = "/var/lib/${name}"; default = "/var/lib/${name}";
}; };
oidcEndpoint = lib.mkOption { oidcEndpoint = lib.mkOption {
type = lib.types.nullOr lib.types.str; type = lib.types.nullOr lib.types.str;
default = null; default = null;
description = "OIDC endpoint for SSO"; description = "Endpoint to the SSO provider. Leave null to not have SSO configured.";
example = "https://authelia.example.com"; example = "https://authelia.example.com";
}; };