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
• 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)
      • 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
• 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
• 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
• 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