liminix

commit a019e59a80eb898a7288ba517b785ab33dc5d6ac
parent 625146d821a0acee7318d558e05ca7a4d09ee22b
Author: Daniel Barlow <dan@telent.net>
Date:   Wed, 16 Aug 2023 19:44:28 +0100

improve doc

Diffstat:
M
modules/dnsmasq/default.nix
 | 
2
++
M
modules/users.nix
 | 
2
++

2 files changed, 4 insertions(+), 0 deletions(-)
diff --git a/modules/dnsmasq/default.nix b/modules/dnsmasq/default.nix
@@ -20,10 +20,12 @@ in {
       user = mkOption {
         type = types.str;
         default = "dnsmasq";
+        description = "Specifies the unix user which dnsmasq will run as" ;
       };
       group = mkOption {
         type = types.str;
         default = "dnsmasq";
+        description = "Specifies the unix group which dnsmasq will run as" ;
       };
       resolvconf = mkOption {
         type = types.nullOr liminix.lib.types.service;
diff --git a/modules/users.nix b/modules/users.nix
@@ -34,6 +34,8 @@ in {
         options = {
           passwd = mkOption {
             type = types.str;
+            description = "encrypted password, as generated by mkpasswd -m sha512crypt";
+            example = "$6$RIYL.EgWOrtoJ0/7$Z53a8sc0o6AU/kuFOGiLJKhwVavTG/deoM7JTs6luNczYSUsh4UYmhvT8sVzm.l8F/LZXhhhkC7IHQs5UGAIM/";
             default = "!!";
           };
           uid = mkOption {