User Guide¶

Quick Start
- Quick Installation Steps
- Overview of the Singularity Interface
- Download pre-built images
- Interact with images
- Working with Files
- Build images from scratch
Contributing
- Join the community
  - Singularity Google Group
  - Singularity on Slack
- Raise an Issue
- Write Documentation
- Contribute to the code
Installation
- Overview
- Install on Linux
- Install on Windows or Mac
  - Setup
    - Windows
    - Mac
  - Singularity Vagrant Box
- Singularity on a shared resource
Container Security
- Singularity Runtime
- Singularity Image Format (SIF)
- Admin Configurable Files
  - cgroups support
  - --security options
- Security in SCS
Command Line Reference
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
- Overview
- Header
  - Preferred bootstrap agents
  - Other bootstrap agents
- Sections
  - %setup
  - %files
  - %app*
  - %post
  - %test
  - %environment
  - %startscript
  - %runscript
  - %labels
  - %help
- Multi-Stage Builds
- Apps
- Best Practices for Build Recipes
Build Environment
- Overview
- Cache Folders
- Cache commands
  - Listing Cache
  - Cleaning the Cache
- Temporary Folders
- Pull Folder
- Encrypted Containers
- Environment Variables
  - Defaults
Encrypted Containers
- Overview
- Encrypting a container
  - Passphrase Encryption
    - Encrypting with a passphrase interactively
    - Using an environment variable
  - PEM File Encryption
    - Encrypting with a command line option
    - Encrypting with an environment variable
- Running an encrypted container
  - Running a container encrypted with a passphrase
    - Running with a passphrase interactively
    - Running with a passphrase in an environment variable
  - Running a container encrypted with a PEM file
    - Running using a command line option
    - Running using an environment variable
Cloud Library
- Overview
- Make an Account
- Creating a Access token
- Pushing a Container
- Pulling a container
  - Pulling your own container
- Verify/Sign your Container
- Searching the Library for Containers
  - Using the CLI Search
- Remote Builder
  - Building from a definition file:
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
  - Authentication via Interactive Login
  - Authentication via Environment Variables
- Making use of private images from Private Registries
- Building images for Singularity from Docker Registries
  - Working from the Singularity Command Line
  - Working with Definition Files
- OCI Image Support
  - Overview
  - Building Containers for Singularity from OCI Images
- Best Practices
- Troubleshooting
- Singularity Definition file vs. Dockerfile
Bind Paths and Mounts
- Overview
- System-defined bind paths
- User-defined bind paths
Persistent Overlays
- Overview
- Usage
- A note on resizing ext3 images
Running Services
- Overview
- Container Instances in Singularity
- Nginx “Hello-world” in Singularity
- Putting all together
Environment and Metadata
- Overview
- Environment
- Labels
- The inspect command
- Container Metadata
OCI Runtime Support
- Overview
- Mounted OCI Filesystem Bundles
  - Mounting an OCI Filesystem Bundle
  - Content of an OCI Compliant Filesystem Bundle
- Creating OCI Compliant Container Instances
- Unmounting OCI Filesystem Bundles
- Kubernetes Integration
Container Security
- Singularity Runtime
- Singularity Image Format (SIF)
- Admin Configurable Files
  - cgroups support
  - --security options
- Security in SCS
Key commands
- Key import command
- Key export command
- Key remove command
Sign and Verify
- Verifying containers from the Container Library
- Signing your own containers
Plugins
- Overview
- Using Plugins
- Writing a Plugin
Security Options
- Linux Capabilities
- Building encrypted containers
- Security related action options
Network Options
- --dns
- --hostname
- --net
- --network
- --network-args
Fakeroot feature
- Overview
- Restrictions/security
  - Filesystem
  - Network
- Usage
  - Build
  - Examples
Remote Endpoints
- Overview
- Usage
Cgroups Support
- Overview
- Examples
Singularity and MPI applications
Appendix
- Singularity’s environment variables
  - A
  - B
  - C
  - D
  - E
  - F
  - G
  - H
  - I
  - J
  - K
  - L
  - N
  - O
  - P
  - R
  - S
  - T
  - U
  - W
- Build Modules