Merge pull request #1141 from anderbubble/docs-override-paths

Document overriding paths in warewulf.conf

CHANGELOG.md

@@ -15,6 +15,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Add multiple output formats (yaml & json) support. #447
 - More aliases for many wwctl commands
 - Add support to render template using `host` or `$(uname -n)` as the value of `overlay show --render`. #623
+- Document warewulf.conf:paths. #635
 
 ### Changed
 

userdocs/contents/configuration.rst

@@ -10,7 +10,7 @@ warewulf.conf
 =============
 
 The Warewulf configuration exists as follows in the current version of
-Warewulf (4.4.0):
+Warewulf (4.5.0):
 
 .. code-block:: yaml
 
@@ -118,6 +118,39 @@ explained as follows:
   during ``container exec`` or ``container shell``, typically to allow
   them to operate in the host environment prior to deployment.
 
+Paths
+-----
+
+*New in Warewulf v4.5.0*
+
+Default paths to containers, overlays, and other Warewulf components
+may be overridden using ``warewulf.conf:paths``.
+
+.. code-block:: yaml
+
+   paths:
+     sysconfdir: /etc
+     localstatedir: /var/lib
+     ipxesource: /usr/share/ipxe
+     wwoverlaydir: /var/lib/warewulf/overlays
+     wwchrootdir: /var/lib/warewulf/chroots
+     wwprovisiondir: /var/lib/warewulf/provision
+     wwclientdir: /warewulf
+
+* ``sysconfdir``: The parent directory for the ``warewulf`` configuration directory,
+  which stores ``warewulf.conf`` and ``nodes.conf``.
+
+* ``ipxesource``: Where to get iPXE binaries.
+  These files are copied to ``warewulf.conf:tftp:tftproot`` by ``wwctl configure``.
+
+* ``wwoverlaydir``: The source for Warewulf overlays.
+
+* ``wwchrootdir``: The source for Warewulf containers.
+
+* ``wwprovisiondir``: Where to store built overlays, built containers, and imported kernels.
+
+* ``wwclientdir``: Where the Warewulf client looks for its configuration on a provisioned node.
+
 nodes.conf
 ==========