diff options
Diffstat (limited to 'nixos/modules/services/networking/vsftpd.nix')
-rw-r--r-- | nixos/modules/services/networking/vsftpd.nix | 26 |
1 files changed, 13 insertions, 13 deletions
diff --git a/nixos/modules/services/networking/vsftpd.nix b/nixos/modules/services/networking/vsftpd.nix index d205302051e..b26adbf8719 100644 --- a/nixos/modules/services/networking/vsftpd.nix +++ b/nixos/modules/services/networking/vsftpd.nix @@ -154,18 +154,18 @@ in userlist = mkOption { default = []; type = types.listOf types.str; - description = "See <option>userlistFile</option>."; + description = lib.mdDoc "See {option}`userlistFile`."; }; userlistFile = mkOption { type = types.path; default = pkgs.writeText "userlist" (concatMapStrings (x: "${x}\n") cfg.userlist); defaultText = literalExpression ''pkgs.writeText "userlist" (concatMapStrings (x: "''${x}\n") cfg.userlist)''; - description = '' - Newline separated list of names to be allowed/denied if <option>userlistEnable</option> - is <literal>true</literal>. Meaning see <option>userlistDeny</option>. + description = lib.mdDoc '' + Newline separated list of names to be allowed/denied if {option}`userlistEnable` + is `true`. Meaning see {option}`userlistDeny`. - The default is a file containing the users from <option>userlist</option>. + The default is a file containing the users from {option}`userlist`. If explicitely set to null userlist_file will not be set in vsftpd's config file. ''; @@ -174,8 +174,8 @@ in enableVirtualUsers = mkOption { type = types.bool; default = false; - description = '' - Whether to enable the <literal>pam_userdb</literal>-based + description = lib.mdDoc '' + Whether to enable the `pam_userdb`-based virtual user system ''; }; @@ -218,7 +218,7 @@ in type = types.nullOr types.str; default = null; example = "/var/www/$USER"; - description = '' + description = lib.mdDoc '' This option represents a directory which vsftpd will try to change into after a local (i.e. non- anonymous) login. @@ -229,7 +229,7 @@ in anonymousUserHome = mkOption { type = types.path; default = "/home/ftp/"; - description = '' + description = lib.mdDoc '' Directory to consider the HOME of the anonymous user. ''; }; @@ -237,27 +237,27 @@ in rsaCertFile = mkOption { type = types.nullOr types.path; default = null; - description = "RSA certificate file."; + description = lib.mdDoc "RSA certificate file."; }; rsaKeyFile = mkOption { type = types.nullOr types.path; default = null; - description = "RSA private key file."; + description = lib.mdDoc "RSA private key file."; }; anonymousUmask = mkOption { type = types.str; default = "077"; example = "002"; - description = "Anonymous write umask."; + description = lib.mdDoc "Anonymous write umask."; }; extraConfig = mkOption { type = types.lines; default = ""; example = "ftpd_banner=Hello"; - description = "Extra configuration to add at the bottom of the generated configuration file."; + description = lib.mdDoc "Extra configuration to add at the bottom of the generated configuration file."; }; } // (listToAttrs (catAttrs "nixosOption" optionDescription)); |