From dfd49bfd52886d1f8f137516f49ac8c30072f0fd Mon Sep 17 00:00:00 2001 From: ibizaman Date: Mon, 8 Apr 2024 22:18:29 -0700 Subject: [PATCH] add description --- modules/services/nextcloud-server.nix | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/modules/services/nextcloud-server.nix b/modules/services/nextcloud-server.nix index f881616..c08b38d 100644 --- a/modules/services/nextcloud-server.nix +++ b/modules/services/nextcloud-server.nix @@ -302,17 +302,25 @@ in enable = lib.mkEnableOption "Nextcloud External Storage App"; userLocalMount = lib.mkOption { default = null; + description = "If set, adds a local mount as external storage."; type = lib.types.nullOr (lib.types.submodule { options = { directory = lib.mkOption { type = lib.types.str; - example = "/srv/nextcloud"; + description = '' + Local directory on the filesystem to mount. Use `$user` and/or `$home` + which will be replaced by the user's name and home directory. + ''; + example = "/srv/nextcloud/$user"; }; mountName = lib.mkOption { type = lib.types.str; + description = '' + Path of the mount in Nextcloud. Use `/` to mount as the root. + ''; default = ""; - example = "local"; + example = [ "home" "/" ]; }; }; });