diff --git a/docs/blocks/monitoring.md b/docs/blocks/monitoring.md deleted file mode 100644 index 7a26ebb..0000000 --- a/docs/blocks/monitoring.md +++ /dev/null @@ -1,118 +0,0 @@ -# Monitoring Block - -This block sets up the monitoring stack for Self Host Blocks. It is composed of: - -- Grafana as the dashboard frontend. -- Prometheus as the database for metrics. -- Loki as the database for logs. - -## Configuration - -```nix -shb.monitoring = { - enable = true; - subdomain = "grafana"; - inherit domain; - contactPoints = [ "me@example.com" ]; - adminPasswordFile = config.sops.secrets."monitoring/admin_password".path; - secretKeyFile = config.sops.secrets."monitoring/secret_key".path; -}; - -sops.secrets."monitoring/admin_password" = { - sopsFile = ./secrets.yaml; - mode = "0400"; - owner = "grafana"; - group = "grafana"; - restartUnits = [ "grafana.service" ]; -}; -sops.secrets."monitoring/secret_key" = { - sopsFile = ./secrets.yaml; - mode = "0400"; - owner = "grafana"; - group = "grafana"; - restartUnits = [ "grafana.service" ]; -}; -``` - -With that, Grafana, Prometheus, Loki and Promtail are setup! You can access `Grafana` at -`grafana.example.com` with user `admin` and password ``. - -I recommend adding a STMP server configuration so you receive alerts by email: - -```nix -shb.monitoring.smtp = { - from_address = "grafana@$example.com"; - from_name = "Grafana"; - host = "smtp.mailgun.org"; - port = 587; - username = "postmaster@mg.example.com"; - passwordFile = config.sops.secrets."monitoring/smtp".path; -}; - -sops.secrets."monitoring/secret_key" = { - sopsFile = ./secrets.yaml; - mode = "0400"; - owner = "grafana"; - group = "grafana"; - restartUnits = [ "grafana.service" ]; -}; -``` - -Since all logs are now stored in Loki, you can probably reduce the systemd journal retention -time with: - -```nix -# See https://www.freedesktop.org/software/systemd/man/journald.conf.html#SystemMaxUse= -services.journald.extraConfig = '' -SystemMaxUse=2G -SystemKeepFree=4G -SystemMaxFileSize=100M -MaxFileSec=day -''; -``` - -## Provisioning - -Self Host Blocks will create automatically the following resources: - -- For Grafana: - - datasources - - dashboards - - contact points - - notification policies - - alerts -- For Prometheus, the following exporters and related scrapers: - - node - - smartctl - - nginx -- For Loki, the following exporters and related scrapers: - - systemd - -Those resources are namespaced as appropriate under the Self Host Blocks namespace: - -![](../assets/monitoring_grafana_folder.png) - -## Errors Dashboard - -This dashboard is meant to be the first stop to understand why a service is misbehaving. - -![](../assets/monitoring_grafana_dashboards_Errors_1.png) -![](../assets/monitoring_grafana_dashboards_Errors_2.png) - -The yellow and red dashed vertical bars correspond to the [Requests Error Budget -Alert](#requests-error-budget-alert) firing. - -## Performance Dashboard - -This dashboard is meant to be the first stop to understand why a service is performing poorly. - -![](../assets/monitoring_grafana_dashboards_Performance_1.png) -![](../assets/monitoring_grafana_dashboards_Performance_2.png) - -## Requests Error Budget Alert - -This alert will fire when the ratio between number of requests getting a 5XX response from a service -and the total requests to that service exceeds 1%. - -![](../assets/monitoring_grafana_alert_rules_5xx_1.png) -![](../assets/monitoring_grafana_alert_rules_5xx_2.png) diff --git a/docs/blocks/monitoring/alerts-requests-error-budger.md b/docs/blocks/monitoring/alerts-requests-error-budger.md new file mode 100644 index 0000000..fd199e0 --- /dev/null +++ b/docs/blocks/monitoring/alerts-requests-error-budger.md @@ -0,0 +1,7 @@ +# Requests Error Budget Alert {#blocks-monitoring-budget-alerts} + +This alert will fire when the ratio between number of requests getting a 5XX response from a service +and the total requests to that service exceeds 1%. + +![](./assets/alert_rules_5xx_1.png) +![](./assets/alert_rules_5xx_2.png) diff --git a/docs/assets/monitoring_grafana_alert_rules_5xx_1.png b/docs/blocks/monitoring/assets/alert_rules_5xx_1.png similarity index 100% rename from docs/assets/monitoring_grafana_alert_rules_5xx_1.png rename to docs/blocks/monitoring/assets/alert_rules_5xx_1.png diff --git a/docs/assets/monitoring_grafana_alert_rules_5xx_2.png b/docs/blocks/monitoring/assets/alert_rules_5xx_2.png similarity index 100% rename from docs/assets/monitoring_grafana_alert_rules_5xx_2.png rename to docs/blocks/monitoring/assets/alert_rules_5xx_2.png diff --git a/docs/assets/monitoring_grafana_dashboards_Errors_1.png b/docs/blocks/monitoring/assets/dashboards_Errors_1.png similarity index 100% rename from docs/assets/monitoring_grafana_dashboards_Errors_1.png rename to docs/blocks/monitoring/assets/dashboards_Errors_1.png diff --git a/docs/assets/monitoring_grafana_dashboards_Errors_2.png b/docs/blocks/monitoring/assets/dashboards_Errors_2.png similarity index 100% rename from docs/assets/monitoring_grafana_dashboards_Errors_2.png rename to docs/blocks/monitoring/assets/dashboards_Errors_2.png diff --git a/docs/assets/monitoring_grafana_dashboards_Performance_1.png b/docs/blocks/monitoring/assets/dashboards_Performance_1.png similarity index 100% rename from docs/assets/monitoring_grafana_dashboards_Performance_1.png rename to docs/blocks/monitoring/assets/dashboards_Performance_1.png diff --git a/docs/assets/monitoring_grafana_dashboards_Performance_2.png b/docs/blocks/monitoring/assets/dashboards_Performance_2.png similarity index 100% rename from docs/assets/monitoring_grafana_dashboards_Performance_2.png rename to docs/blocks/monitoring/assets/dashboards_Performance_2.png diff --git a/docs/assets/monitoring_grafana_folder.png b/docs/blocks/monitoring/assets/folder.png similarity index 100% rename from docs/assets/monitoring_grafana_folder.png rename to docs/blocks/monitoring/assets/folder.png diff --git a/docs/blocks/monitoring/configuration.md b/docs/blocks/monitoring/configuration.md new file mode 100644 index 0000000..357eba6 --- /dev/null +++ b/docs/blocks/monitoring/configuration.md @@ -0,0 +1,64 @@ +# Configuration {#blocks-monitoring-configuration} + +```nix +shb.monitoring = { + enable = true; + subdomain = "grafana"; + inherit domain; + contactPoints = [ "me@example.com" ]; + adminPasswordFile = config.sops.secrets."monitoring/admin_password".path; + secretKeyFile = config.sops.secrets."monitoring/secret_key".path; +}; + +sops.secrets."monitoring/admin_password" = { + sopsFile = ./secrets.yaml; + mode = "0400"; + owner = "grafana"; + group = "grafana"; + restartUnits = [ "grafana.service" ]; +}; +sops.secrets."monitoring/secret_key" = { + sopsFile = ./secrets.yaml; + mode = "0400"; + owner = "grafana"; + group = "grafana"; + restartUnits = [ "grafana.service" ]; +}; +``` + +With that, Grafana, Prometheus, Loki and Promtail are setup! You can access `Grafana` at +`grafana.example.com` with user `admin` and password ``. + +I recommend adding a STMP server configuration so you receive alerts by email: + +```nix +shb.monitoring.smtp = { + from_address = "grafana@$example.com"; + from_name = "Grafana"; + host = "smtp.mailgun.org"; + port = 587; + username = "postmaster@mg.example.com"; + passwordFile = config.sops.secrets."monitoring/smtp".path; +}; + +sops.secrets."monitoring/secret_key" = { + sopsFile = ./secrets.yaml; + mode = "0400"; + owner = "grafana"; + group = "grafana"; + restartUnits = [ "grafana.service" ]; +}; +``` + +Since all logs are now stored in Loki, you can probably reduce the systemd journal retention +time with: + +```nix +# See https://www.freedesktop.org/software/systemd/man/journald.conf.html#SystemMaxUse= +services.journald.extraConfig = '' +SystemMaxUse=2G +SystemKeepFree=4G +SystemMaxFileSize=100M +MaxFileSec=day +''; +``` diff --git a/docs/blocks/monitoring/dashboard-errors.md b/docs/blocks/monitoring/dashboard-errors.md new file mode 100644 index 0000000..20438da --- /dev/null +++ b/docs/blocks/monitoring/dashboard-errors.md @@ -0,0 +1,9 @@ +# Errors Dashboard {#blocks-monitoring-error-dashboard} + +This dashboard is meant to be the first stop to understand why a service is misbehaving. + +![](./assets/dashboards_Errors_1.png) +![](./assets/dashboards_Errors_2.png) + +The yellow and red dashed vertical bars correspond to the [Requests Error Budget +Alert](#blocks-monitoring-budget-alerts) firing. diff --git a/docs/blocks/monitoring/dashboard-performance.md b/docs/blocks/monitoring/dashboard-performance.md new file mode 100644 index 0000000..e2e6557 --- /dev/null +++ b/docs/blocks/monitoring/dashboard-performance.md @@ -0,0 +1,6 @@ +# Performance Dashboard {#blocks-monitoring-performance-dashboard} + +This dashboard is meant to be the first stop to understand why a service is performing poorly. + +![Performance Dashboard Top Part](./assets/dashboards_Performance_1.png) +![Performance Dashboard Bottom Part](./assets/dashboards_Performance_2.png) diff --git a/docs/blocks/monitoring/default.md b/docs/blocks/monitoring/default.md new file mode 100644 index 0000000..80b9e6f --- /dev/null +++ b/docs/blocks/monitoring/default.md @@ -0,0 +1,17 @@ +# Monitoring Block {#blocks-monitoring} + +Defined in [`/modules/blocks/monitoring.nix`](@REPO@/modules/blocks/monitoring.nix). + +This block sets up the monitoring stack for Self Host Blocks. It is composed of: + +- Grafana as the dashboard frontend. +- Prometheus as the database for metrics. +- Loki as the database for logs. + +```{=include=} parts +configuration.md +provisioning.md +dashboard-errors.md +dashboard-performance.md +alerts-requests-error-budger.md +``` diff --git a/docs/blocks/monitoring/provisioning.md b/docs/blocks/monitoring/provisioning.md new file mode 100644 index 0000000..6a0a4e2 --- /dev/null +++ b/docs/blocks/monitoring/provisioning.md @@ -0,0 +1,20 @@ +# Provisioning {#blocks-monitoring-provisioning} + +Self Host Blocks will create automatically the following resources: + +- For Grafana: + - datasources + - dashboards + - contact points + - notification policies + - alerts +- For Prometheus, the following exporters and related scrapers: + - node + - smartctl + - nginx +- For Loki, the following exporters and related scrapers: + - systemd + +Those resources are namespaced as appropriate under the Self Host Blocks namespace: + +[](./assets/folder.png) diff --git a/docs/default.nix b/docs/default.nix new file mode 100644 index 0000000..78e8583 --- /dev/null +++ b/docs/default.nix @@ -0,0 +1,120 @@ +# Taken nearly verbatim from https://github.com/nix-community/home-manager/pull/4673 +{ pkgs +, buildPackages +, lib +, nmdsrc +, stdenv +, documentation-highlighter +, nixos-render-docs + +, release +, allModules +}: + +let + shbPath = toString ./..; + + gitHubDeclaration = user: repo: subpath: + let urlRef = "main"; + end = if subpath == "" then "" else "/" + subpath; + in { + url = "https://github.com/${user}/${repo}/blob/${urlRef}${end}"; + name = "<${repo}${end}>"; + }; + + ghRoot = (gitHubDeclaration "ibizaman" "selfhostblocks" "").url; + + buildOptionsDocs = args@{ modules, includeModuleSystemOptions ? true, ... }: + let options = (lib.evalModules { inherit modules; }).options; + in buildPackages.nixosOptionsDoc ({ + options = if includeModuleSystemOptions then + options + else + builtins.removeAttrs options [ "_module" ]; + transformOptions = opt: + opt // { + # Clean up declaration sites to not refer to the Home Manager + # source tree. + declarations = map (decl: + gitHubDeclaration "ibizaman" "selfhostblocks" + (lib.removePrefix "/" (lib.removePrefix shbPath (toString decl)))) opt.declarations; + }; + } // builtins.removeAttrs args [ "modules" "includeModuleSystemOptions" ]); + + scrubbedModule = { + _module.args.pkgs = lib.mkForce (nmd.scrubDerivations "pkgs" pkgs); + _module.check = false; + }; + + optionsDocs = buildOptionsDocs { + modules = allModules ++ [ scrubbedModule ]; + variablelistId = "selfhostblocks-options"; + includeModuleSystemOptions = false; + }; + + nmd = import nmdsrc { + inherit lib; + # The DocBook output of `nixos-render-docs` doesn't have the change + # `nmd` uses to work around the broken stylesheets in + # `docbook-xsl-ns`, so we restore the patched version here. + pkgs = pkgs // { + docbook-xsl-ns = + pkgs.docbook-xsl-ns.override { withManOptDedupPatch = true; }; + }; + }; + + outputPath = "share/doc/selfhostblocks"; + + manpage-urls = pkgs.writeText "manpage-urls.json" ''{}''; +in stdenv.mkDerivation { + name = "self-host-blocks-manual"; + + nativeBuildInputs = [ nixos-render-docs ]; + + src = ./.; + + buildPhase = '' + mkdir -p out/media + mkdir -p out/highlightjs + + cp -t out/highlightjs \ + ${documentation-highlighter}/highlight.pack.js \ + ${documentation-highlighter}/LICENSE \ + ${documentation-highlighter}/mono-blue.css \ + ${documentation-highlighter}/loader.js + + substituteInPlace ./options.md \ + --replace \ + '@OPTIONS_JSON@' \ + ${optionsDocs.optionsJSON}/share/doc/nixos/options.json + + find . -name "*.md" -print0 | \ + while IFS= read -r -d ''' f; do + substituteInPlace "''${f}" \ + --replace \ + '@REPO@' \ + "${lib.debug.traceVal ghRoot}" + done + + nixos-render-docs manual html \ + --manpage-urls ${manpage-urls} \ + --media-dir media \ + --revision ${lib.trivial.revisionWithDefault release} \ + --stylesheet ${nmdsrc}/static/style.css \ + --stylesheet ${nmdsrc}/static/highlightjs/tomorrow-night.min.css \ + --script ${nmdsrc}/static/highlightjs/highlight.min.js \ + --script ${nmdsrc}/static/highlightjs/highlight.load.js \ + --toc-depth 1 \ + --section-toc-depth 1 \ + manual.md \ + out/index.html + ''; + + installPhase = '' + dest="$out/${outputPath}" + mkdir -p "$(dirname "$dest")" + mv out "$dest" + mkdir -p $out/nix-support/ + echo "doc manual $dest index.html" >> $out/nix-support/hydra-build-products + ''; +} diff --git a/docs/man-pages.xml b/docs/man-pages.xml deleted file mode 100644 index cea8cb4..0000000 --- a/docs/man-pages.xml +++ /dev/null @@ -1,37 +0,0 @@ - - - Self Host Blocks Reference Pages - - Self Host Blocks contributors - - 2022Self Host Blocks contributors - - - - - selfhostblocks-options - 5 - Self Host Blocks - - - selfhostblocks-options - Self Host Blocks configuration specification - - - Description - - This contains the module options available for Self Host Blocks. - - - - Options - - You can use the following options after importing Self Host Blocks as a flake input, then - importing the default module for your system. - - - - - diff --git a/docs/manual.md b/docs/manual.md new file mode 100644 index 0000000..506c909 --- /dev/null +++ b/docs/manual.md @@ -0,0 +1,24 @@ +# Self Host Blocks Manual {#self-host-blocks-manual} + +## Version 0.0.1 + + +```{=include=} preface +preface.md +``` + +```{=include=} parts html:into-file=//blocks-monitoring.html +blocks/monitoring/default.md +``` + +```{=include=} appendix html:into-file=//options.html +options.md +``` + + + + + + + + diff --git a/docs/manual.xml b/docs/manual.xml deleted file mode 100644 index 4bc81e1..0000000 --- a/docs/manual.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - Self Host Blocks manual - - - Preface - - Complete manual for Self Host Blocks, the building blocks for self-hosting with battery included. - - - If you encounter problems or bugs then please report them on the - issue tracker. - - - - - Self Host Blocks configuration options -
- Usage - - - - - To use these options, import Self Host Blocks as a flake input, then import the default module for your system. - -{ - inputs = { - nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable"; - sops-nix.url = "github:Mic92/sops-nix"; - - shb.url = "github:ibizaman/selfhostblocks"; - shb.inputs.nixpkgs.follows = "nixpkgs"; - shb.inputs.sops-nix.follows = "sops-nix"; - }; - - outputs = { self, nixpkgs, shb }: { - - nixosConfigurations.machine = nixpkgs.lib.nixosSystem { - system = "x86_64-linux"; - modules = [ - shb.nixosModules.x86_64-linux.default - ./machine.nix - ]; - }; - - }; -} - - -
-
- Options - - -
- - diff --git a/docs/options.md b/docs/options.md new file mode 100644 index 0000000..32526eb --- /dev/null +++ b/docs/options.md @@ -0,0 +1,7 @@ +# Self Host Blocks Options {#ch-options} + +```{=include=} options +id-prefix: opt- +list-id: selfhostblock-options +source: @OPTIONS_JSON@ +``` diff --git a/docs/preface.md b/docs/preface.md new file mode 100644 index 0000000..5665f85 --- /dev/null +++ b/docs/preface.md @@ -0,0 +1,10 @@ +# Preface {#preface} + +This document is the complete manual for Self Host Blocks, the building blocks for self-hosting with battery included. + +Self Host Blocks is hosted on [GitHub](https://github.com/ibizaman/selfhostblocks). If you encounter +problems or bugs then please report them on the [issue +tracker](https://github.com/ibizaman/selfhostblocks/issues). + +Feel free to join the dedicated Matrix room +[matrix.org#selfhostblocks](https://matrix.to/#/#selfhostblocks:matrix.org). diff --git a/flake.nix b/flake.nix index 4219f42..2417e8b 100644 --- a/flake.nix +++ b/flake.nix @@ -14,11 +14,44 @@ outputs = { nixpkgs, nix-flake-tests, flake-utils, nmdsrc, ... }: flake-utils.lib.eachDefaultSystem (system: let - pkgs = import nixpkgs { - inherit system; + patches = [ + '' + From a4d67df38628eaa3e1823af7b7613af3d7ff7555 Mon Sep 17 00:00:00 2001 + From: ibizaman + Date: Sun, 3 Dec 2023 21:09:30 -0800 + Subject: [PATCH] fix for nixos-render-docs media path + + --- + .../tools/nix/nixos-render-docs/src/nixos_render_docs/manual.py | 2 +- + 1 file changed, 1 insertion(+), 1 deletion(-) + + diff --git a/pkgs/tools/nix/nixos-render-docs/src/nixos_render_docs/manual.py b/pkgs/tools/nix/nixos-render-docs/src/nixos_render_docs/manual.py + index d605dd88b37d..3482cc02c4d1 100644 + --- a/pkgs/tools/nix/nixos-render-docs/src/nixos_render_docs/manual.py + +++ b/pkgs/tools/nix/nixos-render-docs/src/nixos_render_docs/manual.py + @@ -506,7 +506,7 @@ class ManualHTMLRenderer(RendererMixin, HTMLRenderer): + in_dir = self._in_dir + for included, path in fragments: + try: + - self._in_dir = (in_dir / path).parent + + self._in_dir = path.parent + inner.append(self.render(included)) + except Exception as e: + raise RuntimeError(f"rendering {path}") from e + -- + 2.42.0 + '' + ]; + originPkgs = nixpkgs.legacyPackages.${system}; + patchedNixpkgs = originPkgs.applyPatches { + name = "nixpkgs-patched"; + src = nixpkgs; + patches = map (p: originPkgs.writeText "patch" p) patches; }; - nmd = import nmdsrc { inherit pkgs; }; + pkgs = import patchedNixpkgs { + inherit system; + }; allModules = [ modules/blocks/authelia.nix @@ -46,36 +79,10 @@ imports = allModules; }; - # Inspiration from https://github.com/nix-community/nix-on-droid/blob/039379abeee67144d4094d80bbdaf183fb2eabe5/docs/default.nix#L22 - packages.manualHtml = let - setupModule = { - _module.args.pkgs = pkgs.lib.mkForce (nmd.scrubDerivations "pkgs" pkgs); - _module.check = false; - }; - - modulesDocs = nmd.buildModulesDocs { - modules = allModules ++ [ setupModule ]; - moduleRootPaths = [ ./. ]; - mkModuleUrl = path: "https://github.com/ibizaman/selfhostblocks/blob/main/${path}"; - channelName = "selfhostblocks"; - docBook = { id = "selfhostblocks-options"; optionIdPrefix = "shb-opt"; }; - }; - - manual = nmd.buildDocBookDocs { - pathName = "selfhostblocks"; - modulesDocs = [ modulesDocs ]; - documentsDirectory = ./docs; - chunkToc = '' - - - - - - - ''; - }; - in - manual.html; + packages.manualHtml = pkgs.callPackage ./docs { + inherit allModules nmdsrc; + release = "0.0.1"; + }; checks = let 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 0139404..391e8a2 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; };