index.rst

User Guide

Welcome to the Singularity User Guide!

This guide aims to give an introduction to Singularity, brief installation instructions, and cover topics relevant to users building and running containers.

For a detailed guide to installation and configuration, please see the separate Admin Guide for this version of Singularity at https://singularity.hpcng.org/admin-docs/{adminversion}/.

Getting Started & Background Information

.. toctree::
   :maxdepth: 2

   Introduction to Singularity <introduction>
   Quick Start <quick_start>
   Security in Singularity <security>

Building Containers

.. toctree::
   :maxdepth: 3

   Build a container <build_a_container>
   The Definition File <definition_files>
   Build Environment <build_env>
   Singularity and Docker <singularity_and_docker>
   Fakeroot feature <fakeroot>

Signing & Encryption

.. toctree::
   :maxdepth: 2

   Sign and Verify <signNverify>
   Key management commands <key_commands>
   Encrypted Containers <encryption>

Sharing & Online Services

.. toctree::
   :maxdepth: 2

   Remote Endpoints <endpoint>
   Cloud Library <cloud_library>

Advanced Usage

.. toctree::
   :maxdepth: 2

   Bind Paths and Mounts <bind_paths_and_mounts>
   Persistent Overlays <persistent_overlays>
   Running Services <running_services>
   Environment and Metadata <environment_and_metadata>
   OCI Runtime Support <oci_runtime>
   Plugins <plugins>
   Security Options <security_options>
   Network Options <networking>
   Cgroups Support <cgroups>
   Singularity and MPI applications <mpi>
   GPU Support <gpu>

Get Involved

.. toctree::
   :maxdepth: 2

   Contributing <contributing>

Reference

.. toctree::
   :maxdepth: 2

   Appendix <appendix>
   Command Line Reference <cli>
   License <license>