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

Welcome to the Warewulf User Guide!

.. toctree::
   :maxdepth: 2
   :caption: Contents

   Introduction <contents/introduction>
   Background <contents/background>
   Stateless Provisioning <contents/stateless>
   Control Server Setup <contents/setup>
   Warewulf Installation <contents/installation>
   Warewulf Configuration <contents/configuration>
   Controlling Warewulf (wwctl) <contents/wwctl>
   Warewulf Initialization <contents/initialization>
   Image Management <contents/images>
   Kernel Management <contents/kernel>
   Boot Management <contents/boot-management>
   Node Configuration <contents/nodeconfig>
   Node Profiles <contents/profiles>
   Warewulf Overlays <contents/overlays>
   Node Provisioning <contents/provisioning>
   IPMI <contents/ipmi>
   Disk Management <contents/disks>
   Security <contents/security>
   Templating <contents/templating>
   dnsmasq <contents/dnsmasq>
   Troubleshooting <contents/troubleshooting>
   Known issues <contents/known-issues>

.. toctree::
   :maxdepth: 2
   :caption: Quickstart

   Enterprise Linux (Rocky Linux, CentOS, and RHEL) <quickstart/el>
   openSUSE Leap and SLES 15 <quickstart/suse15>
   Debian 12 <quickstart/debian12>


.. toctree::
   :maxdepth: 2
   :caption: Contributing

   Contributing <contributing/contributing>
   Debugging <contributing/debugging>
   Documentation <contributing/documentation>
   Development Environment (Dev Container/VSC) <contributing/development-environment-devcontainer>
   Development Environment (Vagrant) <contributing/development-environment-vagrant>
   Development Environment (KVM) <contributing/development-environment-kvm>
   Development Environment (VirtualBox) <contributing/development-environment-vbox>
   Glossary <contents/glossary>

.. toctree::
   :maxdepth: 2
   :caption: Reference
   :glob:

   reference/*