now there's docs

1 files changed, 9 insertions, 1 deletions

diff --git a/modules/secrets/options.nix b/modules/secrets/options.nix
index de15f50..fa53d6f 100644
--- a/modules/secrets/options.nix
+++ b/modules/secrets/options.nix
@@ -3,25 +3,33 @@
 in {
   options = {
     collinux.secrets = lib.mkOption {
+      description = "Atribute set of secrets";
       type = lib.types.attrsOf (
         lib.types.submodule ({config, ...}: {
           options = {
             name = mkOption {
               type = lib.types.str;
               default = config._module.args.name;
+              internal = true;
+            };
+            file = mkOption {
+              description = "Name of the file in the /run/secrets.d";
+              type = lib.types.path;
             };
-            file = mkOption {type = lib.types.path;};
             mode = mkOption {
+              description = "Permissions mode of the decrypted secret in a format understood by chmod";
               type = lib.types.str;
               default = "0400";
             };
             owner = mkOption {
+              description = "Owner of the decrypted secret file";
               type = lib.types.str;
               default = "0";
             };
             path = mkOption {
               type = lib.types.str;
               default = "/run/secrets.d/${config.name}";
+              description = "Path where the decrypted secret is installed";
             };
           };
         })