table of contents
other versions
- testing 3.0.3+ds-1+b10
- stretch-backports 2.6.1-1~bpo9+2
- unstable 3.1.1+ds-1
RUN-SINGULARITY(1) | User Commands | RUN-SINGULARITY(1) |
NAME¶
run-singularity - launch a Singularity containers with a runscriptDESCRIPTION¶
USAGE: singularity [...] run [run options...] <container path> [...]This command will launch a Singularity container and execute a runscript if one is defined for that container. The runscript is a file at '/singularity'. If this file is present (and executable) then this command will execute that file within the container automatically. All arguments following the container name will be passed directly to the runscript.
RUN OPTIONS:¶
- -B/--bind <spec>
- A user-bind path specification. spec can either be a path or a src:dest pair, specifying the bind mount to perform (can be called multiple times)
- -c/--contain
- This option disables the automatic sharing of writable filesystems on your host (e.g. $HOME and /tmp).
- -C/--containall
- Contain not only fle systems, but also PID and IPC
- -H/--home <path>
- Path to a different home directory to virtualize within the container
- -i/--ipc
- Run container in a new IPC namespace
- -p/--pid
- Run container in a new PID namespace
- --pwd
- Initial working directory for payload process inside the container
- -S/--scratch <path> Include a scratch directory within the container that
- is linked to a temporary dir (use -W to force location)
- -u/--user
- Try to run completely unprivileged (only works on very new kernels/distros)
- -W/--workdir
- Working directory to be used for /tmp, /var/tmp and $HOME (if -c/--contain was also used)
- -w/--writable
- By default all Singularity containers are available as read only. This option makes the file system accessible as read/write.
NOTE:¶
- If there is a daemon process running inside the container, then subsequent container commands will all run within the same namespaces. This means that the --writable and --contain options will not be honored as the namespaces have already been configured by the 'singularity start' command.
EXAMPLES:
- $ singularity exec /tmp/Debian.img cat /singularity
- #!/bin/sh echo "Hello world: $@" $ singularity run /tmp/Debian.img one two three Hello world: one two three
For additional help, please visit our public documentation pages which are found at:
February 2017 | run-singularity ?[31m?(B?[m |