docs: improve files option description

Infinidoge · Dec 26, 2024 · 1fa6c09 · 1fa6c09
1 parent 20ce627
commit 1fa6c09
Showing 1 changed file with 9 additions and 3 deletions.
diff --git a/modules/minecraft-servers.nix b/modules/minecraft-servers.nix
@@ -482,9 +482,15 @@ in
             arbitrary files in the server's data directory.
           '';
           files = with types; mkOpt' (attrsOf (either path configType)) { } ''
-            Things to copy into this server's data directory. Similar to
-            symlinks, but these are actual files. Useful for configuration
-            files that don't behave well when read-only.
+            Things to copy into this server's data directory. Similar to symlinks,
+            but these are actual, writable, files. Useful for configuration files
+            that don't behave well when read-only. Directories are copied recursively and
+            dereferenced. They will be deleted after the server stops, so any modification
+            is discarded.
+
+            These files may include placeholders to substitute with values from
+            <option>services.minecraft-servers.environmentFile</option>
+            (i.e. @variable_name@).
           '';
 
           managementSystem = mkOption {