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://sylabs.io/guides/3.5/admin-guide/.
Getting Started & Background Information¶
Building Containers¶
- Build a container
- Overview
- Downloading an existing container from the Container Library
- Downloading an existing container from Docker Hub
- Creating writable
--sandbox
directories - Converting containers from one format to another
- Building containers from Singularity definition files
- Building encrypted containers
- Build options
- More Build topics
- The Definition File
- Build Environment
- Singularity and Docker
- Overview
- Running action commands on public images from Docker Hub
- Making use of public images from Docker Hub
- Making use of private images from Docker Hub
- Making use of private images from Private Registries
- Building images for Singularity from Docker Registries
- OCI Image Support
- Container Caching
- Best Practices
- Troubleshooting
- Singularity Definition file vs. Dockerfile
- Fakeroot feature