User Guide

• Quick Start
  • Quick Installation Steps
    • Install system dependencies
    • Install Go
    • Clone the Singularity repository
    • Install Go dependencies
    • Compile the Singularity binary
  • Overview of the Singularity Interface
  • Download pre-built images
  • Interact with images
    • Shell
    • Executing Commands
    • Running a container
    • Working with Files
  • Build images from scratch
    • Sandbox Directories
    • Converting images from one format to another
    • Singularity Definition Files
• Contributing
  • Join the community
    • Singularity Google Group
    • Singularity on Slack
  • Raise an Issue
  • Write Documentation
  • Contribute to the code
    • Step 1. Fork the repo
    • Step 2. Checkout a new branch
    • Step 3. Make your changes
    • Step 4. Push your branch to your fork
    • Step 5. Submit a Pull Request
    • Step 6. Keep your branch in sync
• Installation
  • Overview
  • Install on Linux
    • Before you begin
      • Install Dependencies
      • Install Go
    • Install from source
      • Download Singularity repo (and optionally check out a tag or branch)
      • Download and install Singularity from a release
      • Compile Singularity
      • Source bash completion file
    • Build and install an RPM
    • Remove an old version
    • Distribution packages of Singularity
      • Install the Debian/Ubuntu package using apt
      • Install the CentOS/RHEL package using yum
  • Install on Windows or Mac
    • Setup
      • Windows
      • Mac
    • Singularity Vagrant Box
  • Singularity on a shared resource
• 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
  • Build options
    • --builder
    • --detached
    • --force
    • --json
    • --library
    • --notest
    • --remote
    • --sandbox
    • --section
    • --update
  • More Build topics
• The Definition File
  • Overview
  • Header
  • Sections
    • %setup
    • %files
    • %environment
    • %post
    • %runscript
    • %startscript
    • %test
    • %labels
    • %help
  • Apps
  • Best Practices for Build Recipes
• Build Environment
  • Overview
  • Cache Folders
  • Temporary Folders
  • Pull Folder
  • Environment Variables
    • Defaults
      • Docker
      • Library
• 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
      • Remotely Hosted Images
      • Building Containers Remotely
      • Locally Available Images: Cached by Docker
      • Locally Available Images: Stored Archives
      • Pushing Locally Available Images to a Library
    • Working with Definition Files
      • Mandatory Header Keywords: Remotely Boostrapped
      • Remotely Bootstrapped and Built Containers
      • Mandatory Header Keywords: Locally Boostrapped
      • Optional Header Keywords
      • Private Images and Registries
      • Directing Execution
      • Container Metadata
  • OCI Image Support
    • Overview
      • Image Pulls Revisited
      • Image Caching in Singularity
      • Compliance with the OCI Image Layout Specification
      • OCI Compliance and the Singularity Cache
    • Building Containers for Singularity from OCI Images
      • Working Locally from the Singularity Command Line: oci Boostrap Agent
      • Working Locally from the Singularity Command Line: oci-archive Boostrap Agent
      • Working from the Singularity Command Line with Remotely Hosted Images
      • Working with Definition Files: Mandatory Header Keywords
      • Working with Definition Files: Additonal Considerations
  • Best Practices
  • Troubleshooting
• Bind Paths and Mounts
  • Overview
  • System-defined bind paths
  • User-defined bind paths
    • Specifying bind paths
    • A note on using --bind with the --writable flag
• Persistent Overlays
  • Overview
  • Usage
• Running Services
  • Overview
  • Container Instances in Singularity
  • Nginx “Hello-world” in Singularity
  • Putting all together
    • Building the image
    • Running the Service
    • Making it Fancy
• Environment and Metadata
  • Overview
  • Environment
  • Labels
  • The inspect command
    • --labels
    • --deffile
    • --runscript
    • --test
    • --environment
    • --helpfile
    • --json
  • Container Metadata
• Sign and Verify
  • Verifying containers from the Container Library
  • Signing your own containers
    • Generating and managing PGP keys
    • Signing and validating your own containers
• Security Options
  • Linux Capabilities
  • Security related action options
    • --add-caps
    • --allow-setuid
    • --keep-privs
    • --drop-caps
    • --security
• Network Options
  • --dns
  • --hostname
  • --net
  • --network
  • --network-args
• Cgroups Support
  • Overview
  • Examples
    • Limiting memory
    • Limiting CPU
      • shares
      • quota/period
      • cpus/mems
    • Limiting IO
      • Limiting device access
• 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
    • library bootstrap agent
      • Overview
      • Keywords
    • docker bootstrap agent
      • Overview
      • Keywords
      • Notes
    • shub bootstrap agent
      • Overview
      • Keywords
      • Notes
    • localimage bootstrap agent
      • Overview
      • Keywords
      • Notes
    • yum bootstrap agent
      • Overview
      • Keywords
      • Notes
    • debootstrap build agent
      • Overview
      • Keywords
      • Notes
    • arch bootstrap agent
      • Overview
      • Keywords
      • Notes
    • busybox bootstrap agent
      • Overview
      • Keywords
      • Notes
    • zypper bootstrap agent
      • Overview
      • Keywords