about summary refs log tree commit diff
path: root/nixos
diff options
context:
space:
mode:
authorAaron Andersen <aaron@fosslib.net>2022-06-18 10:08:08 -0400
committerAaron Andersen <aaron@fosslib.net>2022-06-18 10:08:08 -0400
commit078a53824e87e8616c447576f976bf05113d68a8 (patch)
tree2f680c4e6f6c25f5515c847d0ced90e980104f69 /nixos
parent79bfd3c0d09c4c70618a787013d2f2afad1f4356 (diff)
nixos/prosody: provide additional details in the user and group options description
Diffstat (limited to 'nixos')
-rw-r--r--nixos/modules/services/networking/prosody.nix20
1 files changed, 18 insertions, 2 deletions
diff --git a/nixos/modules/services/networking/prosody.nix b/nixos/modules/services/networking/prosody.nix
index 5c128389732e9..9e8db04e62241 100644
--- a/nixos/modules/services/networking/prosody.nix
+++ b/nixos/modules/services/networking/prosody.nix
@@ -529,13 +529,29 @@ in
       user = mkOption {
         type = types.str;
         default = "prosody";
-        description = "User account under which prosody runs.";
+        description = ''
+          User account under which prosody runs.
+
+          <note><para>
+          If left as the default value this user will automatically be created
+          on system activation, otherwise you are responsible for
+          ensuring the user exists before the prosody service starts.
+          </para></note>
+        '';
       };
 
       group = mkOption {
         type = types.str;
         default = "prosody";
-        description = "Group account under which prosody runs.";
+        description = ''
+          Group account under which prosody runs.
+
+          <note><para>
+          If left as the default value this group will automatically be created
+          on system activation, otherwise you are responsible for
+          ensuring the group exists before the prosody service starts.
+          </para></note>
+        '';
       };
 
       allowRegistration = mkOption {