==========
User Guide
==========

Welcome to the Warewulf User Guide!

.. toctree::
   :maxdepth: 1
   :caption: Getting Started

   Introduction <getting-started/introduction>
   The Provisioning Process <getting-started/provisioning>
   Network Planning <getting-started/network>
   Enterprise Linux Quickstart (Rocky Linux, CentOS, and RHEL) <getting-started/el-quickstart>
   SUSE Quickstart (openSUSE Leap and SLES) <getting-started/suse-quickstart>
   Debian Quickstart <getting-started/debian-quickstart>
   Glossary <getting-started/glossary>
   Quick Reference <getting-started/quick-reference>
   Feature Status <getting-started/feature-status>

.. toctree::
   :maxdepth: 1
   :caption: Server

   Server Installation <server/installation>
   Controlling Warewulf (wwctl) <server/wwctl>
   Server Configuration <server/configuration>
   Server Routes <server/routes>
   Using dnsmasq <server/dnsmasq>
   Security <server/security>
   Bootloaders <server/bootloaders>
   Upgrading Warewulf <server/upgrade>
   REST API <server/api>

.. toctree::
   :maxdepth: 1
   :caption: Nodes and Profiles

   Cluster Nodes <nodes/nodes>
   Node Profiles <nodes/profiles>
   Network <nodes/network>
   IPMI <nodes/ipmi>
   Disks <nodes/disks>

.. toctree::
   :maxdepth: 1
   :caption: Images

   OS Images <images/images>
   Image Kernels <images/kernel>
   Syncuser <images/syncuser>
   SELinux <images/selinux>

.. toctree::
   :maxdepth: 1
   :caption: Overlays

   Overlays <overlays/overlays>
   Templating <overlays/templates>

.. toctree::
   :maxdepth: 1
   :caption: Troubleshooting

   Troubleshooting <troubleshooting/troubleshooting>
   Known issues <troubleshooting/known-issues>

.. toctree::
   :maxdepth: 1
   :caption: Contributing

   Contributing <contributing/contributing>
   Development Environment <contributing/development-environment>
   Documentation <contributing/documentation>
   Debugging <contributing/debugging>

.. toctree::
   :maxdepth: 1
   :caption: Command Reference
   :glob:

   reference/*

.. toctree::
   :maxdepth: 1
   :caption: Configuration Reference
   :glob:

   reference/man5/*

.. toctree::
   :maxdepth: 1
   :caption: Release Notes

   v4.6.0 <release/v4.6.0>
   v4.6.1 <release/v4.6.1>
   v4.6.2 <release/v4.6.2>
   v4.6.3 <release/v4.6.3>
   v4.6.4 <release/v4.6.4>
   v4.6.5 <release/v4.6.5>