SingularityCE User Guide
Welcome to the SingularityCE User Guide!
This guide aims to give an introduction to SingularityCE, 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 SingularityCE at https://sylabs.io/guides/3.8/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
--sandboxdirectories - Converting containers from one format to another
- Building containers from SingularityCE definition files
- Building encrypted containers
- Build options
- More Build topics
- The Definition File
- Build Environment
- SingularityCE 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 SingularityCE from Docker Registries
- OCI Image Support
- Container Caching
- Best Practices
- Troubleshooting
- SingularityCE Definition file vs. Dockerfile
- Fakeroot feature
Signing & Encryption
Advanced Usage
Get Involved
Reference
- Appendix
- Command Line Reference
- singularity
- singularity build
- singularity cache
- singularity cache clean
- singularity cache list
- singularity capability
- singularity capability add
- singularity capability avail
- singularity capability drop
- singularity capability list
- singularity config
- singularity config fakeroot
- singularity config global
- singularity delete
- singularity exec
- singularity inspect
- singularity instance
- singularity instance list
- singularity instance start
- singularity instance stop
- singularity key
- singularity key export
- singularity key import
- singularity key list
- singularity key newpair
- singularity key pull
- singularity key push
- singularity key remove
- singularity key search
- singularity oci
- singularity oci attach
- singularity oci create
- singularity oci delete
- singularity oci exec
- singularity oci kill
- singularity oci mount
- singularity oci pause
- singularity oci resume
- singularity oci run
- singularity oci start
- singularity oci state
- singularity oci umount
- singularity oci update
- singularity overlay
- singularity overlay create
- singularity plugin
- singularity plugin compile
- singularity plugin create
- singularity plugin disable
- singularity plugin enable
- singularity plugin inspect
- singularity plugin install
- singularity plugin list
- singularity plugin uninstall
- singularity pull
- singularity push
- singularity remote
- singularity remote add
- singularity remote add-keyserver
- singularity remote list
- singularity remote login
- singularity remote logout
- singularity remote remove
- singularity remote remove-keyserver
- singularity remote status
- singularity remote use
- singularity run
- singularity run-help
- singularity search
- singularity shell
- singularity sif
- singularity sif add
- singularity sif del
- singularity sif dump
- singularity sif header
- singularity sif info
- singularity sif list
- singularity sif new
- singularity sif setprim
- singularity sign
- singularity test
- singularity verify
- singularity version
- License