2015-06-21 16:41:38 -04:00
# run
2023-01-06 13:04:05 -05:00
<!-- - MARKER_GEN_START -->
2022-03-29 17:58:36 -04:00
Create and run a new container from an image
2015-06-21 16:41:38 -04:00
2023-01-06 13:04:05 -05:00
### Aliases
cli: use custom annotation for aliases
Cobra allows for aliases to be defined for a command, but only allows these
to be defined at the same level (for example, `docker image ls` as alias for
`docker image list`). Our CLI has some commands that are available both as a
top-level shorthand as well as `docker <object> <verb>` subcommands. For example,
`docker ps` is a shorthand for `docker container ps` / `docker container ls`.
This patch introduces a custom "aliases" annotation that can be used to print
all available aliases for a command. While this requires these aliases to be
defined manually, in practice the list of aliases rarely changes, so maintenance
should be minimal.
As a convention, we could consider the first command in this list to be the
canonical command, so that we can use this information to add redirects in
our documentation in future.
Before this patch:
docker images --help
Usage: docker images [OPTIONS] [REPOSITORY[:TAG]]
List images
Options:
-a, --all Show all images (default hides intermediate images)
...
With this patch:
docker images --help
Usage: docker images [OPTIONS] [REPOSITORY[:TAG]]
List images
Aliases:
docker image ls, docker image list, docker images
Options:
-a, --all Show all images (default hides intermediate images)
...
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2022-06-28 04:52:25 -04:00
2023-01-06 13:04:05 -05:00
`docker container run` , `docker run`
### Options
2023-10-20 10:38:17 -04:00
| Name | Type | Default | Description |
|:------------------------------------------------------|:--------------|:----------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [`--add-host` ](#add-host ) | `list` | | Add a custom host-to-IP mapping (host:ip) |
| `--annotation` | `map` | `map[]` | Add an annotation to the container (passed through to the OCI runtime) |
| [`-a` ](#attach ), [`--attach` ](#attach ) | `list` | | Attach to STDIN, STDOUT or STDERR |
| `--blkio-weight` | `uint16` | `0` | Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0) |
| `--blkio-weight-device` | `list` | | Block IO weight (relative device weight) |
| `--cap-add` | `list` | | Add Linux capabilities |
| `--cap-drop` | `list` | | Drop Linux capabilities |
2023-11-23 08:17:19 -05:00
| [`--cgroup-parent` ](#cgroup-parent ) | `string` | | Optional parent cgroup for the container |
2023-10-20 10:38:17 -04:00
| `--cgroupns` | `string` | | Cgroup namespace to use (host\|private)< br > 'host': Run the container in the Docker host's cgroup namespace< br > 'private': Run the container in its own private cgroup namespace< br > '': Use the cgroup namespace as configured by the< br > default-cgroupns-mode option on the daemon (default) |
| [`--cidfile` ](#cidfile ) | `string` | | Write the container ID to the file |
| `--cpu-count` | `int64` | `0` | CPU count (Windows only) |
| `--cpu-percent` | `int64` | `0` | CPU percent (Windows only) |
| `--cpu-period` | `int64` | `0` | Limit CPU CFS (Completely Fair Scheduler) period |
| `--cpu-quota` | `int64` | `0` | Limit CPU CFS (Completely Fair Scheduler) quota |
| `--cpu-rt-period` | `int64` | `0` | Limit CPU real-time period in microseconds |
| `--cpu-rt-runtime` | `int64` | `0` | Limit CPU real-time runtime in microseconds |
| `-c` , `--cpu-shares` | `int64` | `0` | CPU shares (relative weight) |
| `--cpus` | `decimal` | | Number of CPUs |
| `--cpuset-cpus` | `string` | | CPUs in which to allow execution (0-3, 0,1) |
| `--cpuset-mems` | `string` | | MEMs in which to allow execution (0-3, 0,1) |
2024-07-03 02:29:57 -04:00
| [`-d` ](#detach ), [`--detach` ](#detach ) | `bool` | | Run container in background and print container ID |
2023-10-20 10:38:17 -04:00
| [`--detach-keys` ](#detach-keys ) | `string` | | Override the key sequence for detaching a container |
| [`--device` ](#device ) | `list` | | Add a host device to the container |
| [`--device-cgroup-rule` ](#device-cgroup-rule ) | `list` | | Add a rule to the cgroup allowed devices list |
| `--device-read-bps` | `list` | | Limit read rate (bytes per second) from a device |
| `--device-read-iops` | `list` | | Limit read rate (IO per second) from a device |
| `--device-write-bps` | `list` | | Limit write rate (bytes per second) to a device |
| `--device-write-iops` | `list` | | Limit write rate (IO per second) to a device |
2024-02-21 03:51:39 -05:00
| `--disable-content-trust` | `bool` | `true` | Skip image verification |
2023-10-20 10:38:17 -04:00
| `--dns` | `list` | | Set custom DNS servers |
| `--dns-option` | `list` | | Set DNS options |
| `--dns-search` | `list` | | Set custom DNS search domains |
| `--domainname` | `string` | | Container NIS domain name |
| `--entrypoint` | `string` | | Overwrite the default ENTRYPOINT of the image |
| [`-e` ](#env ), [`--env` ](#env ) | `list` | | Set environment variables |
| `--env-file` | `list` | | Read in a file of environment variables |
| `--expose` | `list` | | Expose a port or a range of ports |
| [`--gpus` ](#gpus ) | `gpu-request` | | GPU devices to add to the container ('all' to pass all GPUs) |
| `--group-add` | `list` | | Add additional groups to join |
| `--health-cmd` | `string` | | Command to run to check health |
| `--health-interval` | `duration` | `0s` | Time between running the check (ms\|s\|m\|h) (default 0s) |
| `--health-retries` | `int` | `0` | Consecutive failures needed to report unhealthy |
| `--health-start-interval` | `duration` | `0s` | Time between running the check during the start period (ms\|s\|m\|h) (default 0s) |
| `--health-start-period` | `duration` | `0s` | Start period for the container to initialize before starting health-retries countdown (ms\|s\|m\|h) (default 0s) |
| `--health-timeout` | `duration` | `0s` | Maximum time to allow one check to run (ms\|s\|m\|h) (default 0s) |
2024-07-03 02:29:57 -04:00
| `--help` | `bool` | | Print usage |
2023-10-20 10:38:17 -04:00
| `-h` , `--hostname` | `string` | | Container host name |
2024-07-03 02:29:57 -04:00
| [`--init` ](#init ) | `bool` | | Run an init inside the container that forwards signals and reaps processes |
| [`-i` ](#interactive ), [`--interactive` ](#interactive ) | `bool` | | Keep STDIN open even if not attached |
2023-10-20 10:38:17 -04:00
| `--io-maxbandwidth` | `bytes` | `0` | Maximum IO bandwidth limit for the system drive (Windows only) |
| `--io-maxiops` | `uint64` | `0` | Maximum IOps limit for the system drive (Windows only) |
| `--ip` | `string` | | IPv4 address (e.g., 172.30.100.104) |
| `--ip6` | `string` | | IPv6 address (e.g., 2001:db8::33) |
2023-11-22 03:31:30 -05:00
| [`--ipc` ](#ipc ) | `string` | | IPC mode to use |
2023-10-20 10:38:17 -04:00
| [`--isolation` ](#isolation ) | `string` | | Container isolation technology |
| `--kernel-memory` | `bytes` | `0` | Kernel memory limit |
| [`-l` ](#label ), [`--label` ](#label ) | `list` | | Set meta data on a container |
| `--label-file` | `list` | | Read in a line delimited file of labels |
| `--link` | `list` | | Add link to another container |
| `--link-local-ip` | `list` | | Container IPv4/IPv6 link-local addresses |
2023-11-23 08:25:06 -05:00
| [`--log-driver` ](#log-driver ) | `string` | | Logging driver for the container |
2023-10-20 10:38:17 -04:00
| `--log-opt` | `list` | | Log driver options |
| `--mac-address` | `string` | | Container MAC address (e.g., 92:d0:c6:0a:29:33) |
| [`-m` ](#memory ), [`--memory` ](#memory ) | `bytes` | `0` | Memory limit |
| `--memory-reservation` | `bytes` | `0` | Memory soft limit |
| `--memory-swap` | `bytes` | `0` | Swap limit equal to memory plus swap: '-1' to enable unlimited swap |
| `--memory-swappiness` | `int64` | `-1` | Tune container memory swappiness (0 to 100) |
| [`--mount` ](#mount ) | `mount` | | Attach a filesystem mount to the container |
| [`--name` ](#name ) | `string` | | Assign a name to the container |
| [`--network` ](#network ) | `network` | | Connect a container to a network |
| `--network-alias` | `list` | | Add network-scoped alias for the container |
2024-07-03 02:29:57 -04:00
| `--no-healthcheck` | `bool` | | Disable any container-specified HEALTHCHECK |
| `--oom-kill-disable` | `bool` | | Disable OOM Killer |
2023-10-20 10:38:17 -04:00
| `--oom-score-adj` | `int` | `0` | Tune host's OOM preferences (-1000 to 1000) |
2023-11-22 03:26:17 -05:00
| [`--pid` ](#pid ) | `string` | | PID namespace to use |
2023-10-20 10:38:17 -04:00
| `--pids-limit` | `int64` | `0` | Tune container pids limit (set -1 for unlimited) |
| `--platform` | `string` | | Set platform if server is multi-platform capable |
2024-07-03 02:29:57 -04:00
| [`--privileged` ](#privileged ) | `bool` | | Give extended privileges to this container |
2023-10-20 10:38:17 -04:00
| [`-p` ](#publish ), [`--publish` ](#publish ) | `list` | | Publish a container's port(s) to the host |
2024-07-03 02:29:57 -04:00
| [`-P` ](#publish-all ), [`--publish-all` ](#publish-all ) | `bool` | | Publish all exposed ports to random ports |
2023-10-20 10:38:17 -04:00
| [`--pull` ](#pull ) | `string` | `missing` | Pull image before running (`always`, `missing` , `never` ) |
2024-07-03 02:29:57 -04:00
| `-q` , `--quiet` | `bool` | | Suppress the pull output |
| [`--read-only` ](#read-only ) | `bool` | | Mount the container's root filesystem as read only |
2023-10-20 10:38:17 -04:00
| [`--restart` ](#restart ) | `string` | `no` | Restart policy to apply when a container exits |
2024-07-03 02:29:57 -04:00
| [`--rm` ](#rm ) | `bool` | | Automatically remove the container and its associated anonymous volumes when it exits |
2023-10-20 10:38:17 -04:00
| `--runtime` | `string` | | Runtime to use for this container |
| [`--security-opt` ](#security-opt ) | `list` | | Security Options |
| `--shm-size` | `bytes` | `0` | Size of /dev/shm |
2024-02-21 03:51:39 -05:00
| `--sig-proxy` | `bool` | `true` | Proxy received signals to the process |
2023-10-20 10:38:17 -04:00
| [`--stop-signal` ](#stop-signal ) | `string` | | Signal to stop the container |
| [`--stop-timeout` ](#stop-timeout ) | `int` | `0` | Timeout (in seconds) to stop a container |
| [`--storage-opt` ](#storage-opt ) | `list` | | Storage driver options for the container |
| [`--sysctl` ](#sysctl ) | `map` | `map[]` | Sysctl options |
| [`--tmpfs` ](#tmpfs ) | `list` | | Mount a tmpfs directory |
2024-07-03 02:29:57 -04:00
| [`-t` ](#tty ), [`--tty` ](#tty ) | `bool` | | Allocate a pseudo-TTY |
2023-10-20 10:38:17 -04:00
| [`--ulimit` ](#ulimit ) | `ulimit` | | Ulimit options |
| `-u` , `--user` | `string` | | Username or UID (format: < name \|uid > [:< group \|gid > ]) |
2024-03-05 09:29:56 -05:00
| [`--userns` ](#userns ) | `string` | | User namespace to use |
2023-11-22 03:29:53 -05:00
| [`--uts` ](#uts ) | `string` | | UTS namespace to use |
2023-10-20 10:38:17 -04:00
| [`-v` ](#volume ), [`--volume` ](#volume ) | `list` | | Bind mount a volume |
| `--volume-driver` | `string` | | Optional volume driver for the container |
| [`--volumes-from` ](#volumes-from ) | `list` | | Mount volumes from the specified container(s) |
| [`-w` ](#workdir ), [`--workdir` ](#workdir ) | `string` | | Working directory inside the container |
2023-01-06 13:04:05 -05:00
<!-- - MARKER_GEN_END -->
2015-06-21 16:41:38 -04:00
2017-03-09 13:04:51 -05:00
## Description
2017-02-07 18:42:48 -05:00
2023-03-31 05:56:40 -04:00
The `docker run` command runs a command in a new container, pulling the image if needed and starting the container.
You can restart a stopped container with all its previous changes intact using `docker start` .
Use `docker ps -a` to view a list of all containers, including those that are stopped.
2015-06-21 16:41:38 -04:00
## Examples
2023-11-08 11:13:44 -05:00
### <a name="name"></a> Assign name (--name)
The `--name` flag lets you specify a custom identifier for a container. The
following example runs a container named `test` using the `nginx:alpine` image
in [detached mode ](#detach ).
2015-09-27 21:45:10 -04:00
2021-08-21 08:54:14 -04:00
```console
2023-11-08 11:13:44 -05:00
$ docker run --name test -d nginx:alpine
4bed76d3ad428b889c56c1ecc2bf2ed95cb08256db22dc5ef5863e1d03252a19
$ docker ps
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
4bed76d3ad42 nginx:alpine "/docker-entrypoint.…" 1 second ago Up Less than a second 80/tcp test
```
You can reference the container by name with other commands. For example, the
following commands stop and remove a container named `test` :
2017-02-07 18:42:48 -05:00
2023-11-08 11:13:44 -05:00
```console
$ docker stop test
test
$ docker rm test
test
2017-02-07 18:42:48 -05:00
```
2015-06-21 16:41:38 -04:00
2023-11-08 11:13:44 -05:00
If you don't specify a custom name using the `--name` flag, the daemon assigns
a randomly generated name, such as `vibrant_cannon` , to the container. Using a
custom-defined name provides the benefit of having an easy-to-remember ID for a
container.
Moreover, if you connect the container to a user-defined bridge network, other
containers on the same network can refer to the container by name via DNS.
```console
$ docker network create mynet
cb79f45948d87e389e12013fa4d969689ed2c3316985dd832a43aaec9a0fe394
$ docker run --name test --net mynet -d nginx:alpine
58df6ecfbc2ad7c42d088ed028d367f9e22a5f834d7c74c66c0ab0485626c32a
$ docker run --net mynet busybox:latest ping test
PING test (172.18.0.2): 56 data bytes
64 bytes from 172.18.0.2: seq=0 ttl=64 time=0.073 ms
64 bytes from 172.18.0.2: seq=1 ttl=64 time=0.411 ms
64 bytes from 172.18.0.2: seq=2 ttl=64 time=0.319 ms
64 bytes from 172.18.0.2: seq=3 ttl=64 time=0.383 ms
...
```
2015-06-21 16:41:38 -04:00
2023-01-06 13:28:29 -05:00
### <a name="cidfile"></a> Capture container ID (--cidfile)
2015-09-27 21:45:10 -04:00
2023-11-08 11:13:44 -05:00
To help with automation, you can have Docker write the container ID out to a
file of your choosing. This is similar to how some programs might write out
their process ID to a file (you might've seen them as PID files):
2021-08-21 08:54:14 -04:00
```console
2017-02-07 18:42:48 -05:00
$ docker run --cidfile /tmp/docker_test.cid ubuntu echo "test"
```
2015-06-21 16:41:38 -04:00
2023-03-31 05:56:40 -04:00
This creates a container and prints `test` to the console. The `cidfile`
2015-06-21 16:41:38 -04:00
flag makes Docker attempt to create a new file and write the container ID to it.
2023-03-31 05:56:40 -04:00
If the file exists already, Docker returns an error. Docker closes this
2015-06-21 16:41:38 -04:00
file when `docker run` exits.
2023-11-22 03:26:17 -05:00
### <a name="pid"></a> PID settings (--pid)
```text
--pid="" : Set the PID (Process) Namespace mode for the container,
'container:< name | id > ': joins another container's PID namespace
'host': use the host's PID namespace inside the container
```
By default, all containers have the PID namespace enabled.
PID namespace provides separation of processes. The PID Namespace removes the
view of the system processes, and allows process ids to be reused including
PID 1.
In certain cases you want your container to share the host's process namespace,
allowing processes within the container to see all of the processes on the
system. For example, you could build a container with debugging tools like
`strace` or `gdb` , but want to use these tools when debugging processes within
the container.
#### Example: run htop inside a container
To run `htop` in a container that shares the process namespac of the host:
1. Run an alpine container with the `--pid=host` option:
```console
$ docker run --rm -it --pid=host alpine
```
2. Install `htop` in the container:
```console
2024-05-26 05:43:08 -04:00
/ # apk add --quiet htop
2023-11-22 03:26:17 -05:00
```
3. Invoke the `htop` command.
```console
/ # htop
```
#### Example, join another container's PID namespace
Joining another container's PID namespace can be useful for debugging that
container.
1. Start a container running a Redis server:
```console
$ docker run --rm --name my-nginx -d nginx:alpine
```
2. Run an Alpine container that attaches the `--pid` namespace to the
`my-nginx` container:
```console
$ docker run --rm -it --pid=container:my-nginx \
--cap-add SYS_PTRACE \
--security-opt seccomp=unconfined \
alpine
```
3. Install `strace` in the Alpine container:
```console
/ # apk add strace
```
4. Attach to process 1, the process ID of the `my-nginx` container:
```console
/ # strace -p 1
strace: Process 1 attached
```
2024-03-05 09:29:56 -05:00
### <a name="userns"></a> Disable namespace remapping for a container (--userns)
If you enable user namespaces on the daemon,
all containers are started with user namespaces enabled by default.
To disable user namespace remapping for a specific container,
you can set the `--userns` flag to `host` .
```console
docker run --userns=host hello-world
```
`host` is the only valid value for the `--userns` flag.
For more information, refer to [Isolate containers with a user namespace ](https://docs.docker.com/engine/security/userns-remap/ ).
2023-11-22 03:29:53 -05:00
### <a name="uts"></a> UTS settings (--uts)
```text
--uts="" : Set the UTS namespace mode for the container
'host': use the host's UTS namespace inside the container
```
The UTS namespace is for setting the hostname and the domain that's visible to
running processes in that namespace. By default, all containers, including
2023-12-13 09:16:56 -05:00
those with `--network=host` , have their own UTS namespace. Setting `--uts` to
`host` results in the container using the same UTS namespace as the host.
2024-08-16 05:02:10 -04:00
> [!NOTE]
2023-12-13 09:16:56 -05:00
> Docker disallows combining the `--hostname` and `--domainname` flags with
> `--uts=host`. This is to prevent containers running in the host's UTS
> namespace from attempting to change the hosts' configuration.
2023-11-22 03:29:53 -05:00
You may wish to share the UTS namespace with the host if you would like the
hostname of the container to change as the hostname of the host changes. A more
advanced use case would be changing the host's hostname from a container.
2024-01-05 10:41:26 -05:00
### <a name="ipc"></a> IPC settings (--ipc)
2023-11-22 03:31:30 -05:00
```text
--ipc="MODE" : Set the IPC mode for the container
```
The `--ipc` flag accepts the following values:
| Value | Description |
|:---------------------------|:----------------------------------------------------------------------------------|
| "" | Use daemon's default. |
| "none" | Own private IPC namespace, with /dev/shm not mounted. |
| "private" | Own private IPC namespace. |
| "shareable" | Own private IPC namespace, with a possibility to share it with other containers. |
| "container:< _name-or-ID_ > " | Join another ("shareable") container's IPC namespace. |
| "host" | Use the host system's IPC namespace. |
If not specified, daemon default is used, which can either be `"private"`
or `"shareable"` , depending on the daemon version and configuration.
2023-12-13 09:16:56 -05:00
[System V interprocess communication (IPC) ](https://linux.die.net/man/5/ipc )
namespaces provide separation of named shared memory segments, semaphores and
message queues.
2023-11-22 03:31:30 -05:00
Shared memory segments are used to accelerate inter-process communication at
memory speed, rather than through pipes or through the network stack. Shared
memory is commonly used by databases and custom-built (typically C/OpenMPI,
C++/using boost libraries) high performance applications for scientific
computing and financial services industries. If these types of applications
are broken into multiple containers, you might need to share the IPC mechanisms
of the containers, using `"shareable"` mode for the main (i.e. "donor")
container, and `"container:<donor-name-or-ID>"` for other containers.
2024-03-08 10:18:56 -05:00
### <a name="privileged"></a> Escalate container privileges (--privileged)
The `--privileged` flag gives the following capabilities to a container:
- Enables all Linux kernel capabilities
- Disables the default seccomp profile
- Disables the default AppArmor profile
- Disables the SELinux process label
- Grants access to all host devices
- Makes `/sys` read-write
- Makes cgroups mounts read-write
In other words, the container can then do almost everything that the host can
do. This flag exists to allow special use-cases, like running Docker within
Docker.
2024-08-16 05:02:10 -04:00
> [!WARNING]
2024-03-08 10:18:56 -05:00
> Use the `--privileged` flag with caution.
> A container with `--privileged` is not a securely sandboxed process.
> Containers in this mode can get a root shell on the host
> and take control over the system.
>
> For most use cases, this flag should not be the preferred solution.
> If your container requires escalated privileges,
> you should prefer to explicitly grant the necessary permissions,
> for example by adding individual kernel capabilities with `--cap-add`.
>
> For more information, see
2024-08-11 10:43:21 -04:00
> [Runtime privilege and Linux capabilities](https://docs.docker.com/engine/containers/run/#runtime-privilege-and-linux-capabilities)
2024-03-08 10:18:56 -05:00
{ .warning }
2015-09-27 21:45:10 -04:00
2023-12-13 09:16:56 -05:00
The following example doesn't work, because by default, Docker drops most
potentially dangerous kernel capabilities, including `CAP_SYS_ADMIN ` (which is
required to mount filesystems).
2021-08-21 08:54:14 -04:00
```console
2017-02-07 18:42:48 -05:00
$ docker run -t -i --rm ubuntu bash
root@bc338942ef20:/# mount -t tmpfs none /mnt
mount: permission denied
```
2015-06-21 16:41:38 -04:00
2023-12-13 09:16:56 -05:00
It works when you add the `--privileged` flag:
2015-06-21 16:41:38 -04:00
2021-08-21 08:54:14 -04:00
```console
2017-02-07 18:42:48 -05:00
$ docker run -t -i --privileged ubuntu bash
root@50e3f57e16e6:/# mount -t tmpfs none /mnt
root@50e3f57e16e6:/# df -h
Filesystem Size Used Avail Use% Mounted on
none 1.9G 0 1.9G 0% /mnt
```
2015-06-21 16:41:38 -04:00
2023-01-06 13:28:29 -05:00
### <a name="workdir"></a> Set working directory (-w, --workdir)
2015-09-27 21:45:10 -04:00
2021-08-21 08:54:14 -04:00
```console
2023-12-13 09:16:56 -05:00
$ docker run -w /path/to/dir/ -i -t ubuntu pwd
2017-02-07 18:42:48 -05:00
```
2015-06-21 16:41:38 -04:00
2023-03-31 05:56:40 -04:00
The `-w` option runs the command executed inside the directory specified, in this example,
2023-12-13 09:16:56 -05:00
`/path/to/dir/` . If the path doesn't exist, Docker creates it inside the container.
2015-06-21 16:41:38 -04:00
2023-01-06 13:28:29 -05:00
### <a name="storage-opt"></a> Set storage driver options per container (--storage-opt)
2016-03-20 00:42:58 -04:00
2021-08-21 08:54:14 -04:00
```console
2017-02-07 18:42:48 -05:00
$ docker run -it --storage-opt size=120G fedora /bin/bash
```
2016-03-20 00:42:58 -04:00
2023-03-31 05:56:40 -04:00
This (size) constraints the container filesystem size to 120G at creation time.
2023-05-18 19:42:52 -04:00
This option is only available for the `btrfs` , `overlay2` , `windowsfilter` ,
and `zfs` storage drivers.
2023-03-31 05:56:40 -04:00
2016-09-18 15:35:55 -04:00
For the `overlay2` storage driver, the size option is only available if the
2022-10-28 11:12:54 -04:00
backing filesystem is `xfs` and mounted with the `pquota` mount option.
2023-03-31 05:56:40 -04:00
Under these conditions, you can pass any size less than the backing filesystem size.
2023-05-18 19:42:52 -04:00
For the `windowsfilter` , `btrfs` , and `zfs` storage drivers, you cannot pass a
size less than the Default BaseFS Size.
2023-03-31 05:56:40 -04:00
2023-01-06 13:28:29 -05:00
### <a name="tmpfs"></a> Mount tmpfs (--tmpfs)
2015-12-01 13:39:34 -05:00
2023-11-27 08:11:38 -05:00
The `--tmpfs` flag lets you create a `tmpfs` mount.
The options that you can pass to `--tmpfs` are identical to the Linux `mount -t
tmpfs -o` command. The following example mounts an empty `tmpfs` into the
container with the `rw` , `noexec` , `nosuid` , `size=65536k` options.
2021-08-21 08:54:14 -04:00
```console
2017-02-07 18:42:48 -05:00
$ docker run -d --tmpfs /run:rw,noexec,nosuid,size=65536k my_image
```
2015-12-01 13:39:34 -05:00
2024-01-15 08:16:24 -05:00
For more information, see [tmpfs mounts ](https://docs.docker.com/storage/tmpfs/ ).
2023-12-13 09:16:56 -05:00
2023-03-31 05:56:40 -04:00
### <a name="volume"></a> Mount volume (-v)
2015-09-27 21:45:10 -04:00
2021-08-21 08:54:14 -04:00
```console
2023-03-31 05:56:40 -04:00
$ docker run -v $(pwd):$(pwd) -w $(pwd) -i -t ubuntu pwd
2017-02-07 18:42:48 -05:00
```
2015-06-21 16:41:38 -04:00
2023-03-31 05:56:40 -04:00
The example above mounts the current directory into the container at the same path
using the `-v` flag, sets it as the working directory, and then runs the `pwd` command inside the container.
As of Docker Engine version 23, you can use relative paths on the host.
```console
$ docker run -v ./content:/content -w /content -i -t ubuntu pwd
```
The example above mounts the `content` directory in the current directory into the container at the
`/content` path using the `-v` flag, sets it as the working directory, and then
runs the `pwd` command inside the container.
2015-06-21 16:41:38 -04:00
2021-08-21 08:54:14 -04:00
```console
2017-02-07 18:42:48 -05:00
$ docker run -v /doesnt/exist:/foo -w /foo -i -t ubuntu bash
```
2015-06-21 16:41:38 -04:00
When the host directory of a bind-mounted volume doesn't exist, Docker
2023-03-31 05:56:40 -04:00
automatically creates this directory on the host for you. In the
example above, Docker creates the `/doesnt/exist`
2015-06-21 16:41:38 -04:00
folder before starting your container.
2023-03-31 05:56:40 -04:00
### <a name="read-only"></a> Mount volume read-only (--read-only)
2021-08-21 08:54:14 -04:00
```console
2017-02-07 18:42:48 -05:00
$ docker run --read-only -v /icanwrite busybox touch /icanwrite/here
```
2015-06-21 16:41:38 -04:00
2023-03-31 05:56:40 -04:00
You can use volumes in combination with the `--read-only` flag to control where
2015-06-21 16:41:38 -04:00
a container writes files. The `--read-only` flag mounts the container's root
filesystem as read only prohibiting writes to locations other than the
specified volumes for the container.
2021-08-21 08:54:14 -04:00
```console
2017-02-07 18:42:48 -05:00
$ docker run -t -i -v /var/run/docker.sock:/var/run/docker.sock -v /path/to/static-docker-binary:/usr/bin/docker busybox sh
```
2015-06-21 16:41:38 -04:00
2022-10-28 11:12:54 -04:00
By bind-mounting the Docker Unix socket and statically linked Docker
binary (refer to [get the Linux binary ](https://docs.docker.com/engine/install/binaries/#install-static-binaries )),
2016-01-19 00:30:33 -05:00
you give the container the full access to create and manipulate the host's
Docker daemon.
2015-06-21 16:41:38 -04:00
2023-03-31 05:56:40 -04:00
On Windows, you must specify the paths using Windows-style path semantics.
2016-11-23 17:13:50 -05:00
2017-02-07 18:42:48 -05:00
```powershell
PS C:\> docker run -v c:\foo:c:\dest microsoft/nanoserver cmd /s /c type c:\dest\somefile.txt
Contents of file
2016-11-23 17:13:50 -05:00
2017-02-07 18:42:48 -05:00
PS C:\> docker run -v c:\foo:d: microsoft/nanoserver cmd /s /c type d:\somefile.txt
Contents of file
```
2023-03-31 05:56:40 -04:00
The following examples fails when using Windows-based containers, as the
2017-08-19 10:13:29 -04:00
destination of a volume or bind mount inside the container must be one of:
2023-03-31 05:56:40 -04:00
a non-existing or empty directory; or a drive other than `C:` . Further, the source
2016-11-23 17:13:50 -05:00
of a bind mount must be a local directory, not a file.
2017-02-07 18:42:48 -05:00
```powershell
net use z: \\remotemachine\share
docker run -v z:\foo:c:\dest ...
docker run -v \\uncpath\to\directory:c:\dest ...
docker run -v c:\foo\somefile.txt:c:\dest ...
docker run -v c:\foo:c: ...
docker run -v c:\foo:c:\existing-directory-with-contents ...
```
2016-11-23 17:13:50 -05:00
2020-04-19 09:43:08 -04:00
For in-depth information about volumes, refer to [manage data in containers ](https://docs.docker.com/storage/volumes/ )
2016-08-15 17:51:15 -04:00
2023-01-06 13:28:29 -05:00
### <a name="mount"></a> Add bind mounts or volumes using the --mount flag
2017-03-31 02:41:45 -04:00
2023-03-31 05:56:40 -04:00
The `--mount` flag allows you to mount volumes, host-directories, and `tmpfs`
2017-03-31 02:41:45 -04:00
mounts in a container.
2023-03-31 05:56:40 -04:00
The `--mount` flag supports most options supported by the `-v` or the
2017-03-31 02:41:45 -04:00
`--volume` flag, but uses a different syntax. For in-depth information on the
`--mount` flag, and a comparison between `--volume` and `--mount` , refer to
2022-10-28 11:12:54 -04:00
[Bind mounts ](https://docs.docker.com/storage/bind-mounts/ ).
2017-03-31 02:41:45 -04:00
Even though there is no plan to deprecate `--volume` , usage of `--mount` is recommended.
Examples:
2021-08-21 08:54:14 -04:00
```console
2017-03-31 02:41:45 -04:00
$ docker run --read-only --mount type=volume,target=/icanwrite busybox touch /icanwrite/here
```
2021-08-21 08:54:14 -04:00
```console
2017-03-31 02:41:45 -04:00
$ docker run -t -i --mount type=bind,src=/data,dst=/data busybox sh
```
2023-01-06 13:28:29 -05:00
### <a name="publish"></a> Publish or expose port (-p, --expose)
2015-09-27 21:45:10 -04:00
2021-08-21 08:54:14 -04:00
```console
2023-12-12 16:36:26 -05:00
$ docker run -p 127.0.0.1:80:8080/tcp nginx:alpine
2017-02-07 18:42:48 -05:00
```
2015-06-21 16:41:38 -04:00
2023-12-12 16:36:26 -05:00
This binds port `8080` of the container to TCP port `80` on `127.0.0.1` of the
host. You can also specify `udp` and `sctp` ports. The [Networking overview
page](https://docs.docker.com/network/) explains in detail how to publish ports
with Docker.
2015-06-21 16:41:38 -04:00
2024-08-16 05:02:10 -04:00
> [!NOTE]
2023-12-12 16:36:26 -05:00
> If you don't specify an IP address (i.e., `-p 80:80` instead of `-p
> 127.0.0.1:80:80`) when publishing a container's ports, Docker publishes the
> port on all interfaces (address `0.0.0.0`) by default. These ports are
> externally accessible. This also applies if you configured UFW to block this
> specific port, as Docker manages its own iptables rules. [Read
> more](https://docs.docker.com/network/packet-filtering-firewalls/)
2019-09-26 14:12:54 -04:00
2021-08-21 08:54:14 -04:00
```console
2023-12-12 16:36:26 -05:00
$ docker run --expose 80 nginx:alpine
2017-02-07 18:42:48 -05:00
```
2015-06-21 16:41:38 -04:00
2015-09-30 16:11:36 -04:00
This exposes port `80` of the container without publishing the port to the host
system's interfaces.
2015-06-21 16:41:38 -04:00
2023-12-12 16:36:26 -05:00
### <a name="publish-all"></a> Publish all exposed ports (-P, --publish-all)
```console
$ docker run -P nginx:alpine
```
The `-P` , or `--publish-all` , flag publishes all the exposed ports to the host.
Docker binds each exposed port to a random port on the host.
The `-P` flag only publishes port numbers that are explicitly flagged as
exposed, either using the Dockerfile `EXPOSE` instruction or the `--expose`
flag for the `docker run` command.
The range of ports are within an *ephemeral port range* defined by
`/proc/sys/net/ipv4/ip_local_port_range` . Use the `-p` flag to explicitly map a
single port or range of ports.
2021-12-03 16:55:07 -05:00
### <a name="pull"></a> Set the pull policy (--pull)
Use the `--pull` flag to set the image pull policy when creating (and running)
the container.
The `--pull` flag can take one of these values:
| Value | Description |
|:--------------------|:------------------------------------------------------------------------------------------------------------------|
| `missing` (default) | Pull the image if it was not found in the image cache, or use the cached image otherwise. |
| `never` | Do not pull the image, even if it's missing, and produce an error if the image does not exist in the image cache. |
| `always` | Always perform a pull before creating the container. |
When creating (and running) a container from an image, the daemon checks if the
image exists in the local image cache. If the image is missing, an error is
2022-10-28 11:12:54 -04:00
returned to the CLI, allowing it to initiate a pull.
2021-12-03 16:55:07 -05:00
2023-03-31 05:56:40 -04:00
The default (`missing`) is to only pull the image if it's not present in the
2021-12-03 16:55:07 -05:00
daemon's image cache. This default allows you to run images that only exist
locally (for example, images you built from a Dockerfile, but that have not
been pushed to a registry), and reduces networking.
The `always` option always initiates a pull before creating the container. This
option makes sure the image is up-to-date, and prevents you from using outdated
images, but may not be suitable in situations where you want to test a locally
built image before pushing (as pulling the image overwrites the existing image
in the image cache).
The `never` option disables (implicit) pulling images when creating containers,
and only uses images that are available in the image cache. If the specified
image is not found, an error is produced, and the container is not created.
This option is useful in situations where networking is not available, or to
prevent images from being pulled implicitly when creating containers.
The following example shows `docker run` with the `--pull=never` option set,
which produces en error as the image is missing in the image-cache:
```console
$ docker run --pull=never hello-world
docker: Error response from daemon: No such image: hello-world:latest.
```
2023-01-06 13:28:29 -05:00
### <a name="env"></a> Set environment variables (-e, --env, --env-file)
2015-09-27 21:45:10 -04:00
2021-08-21 08:54:14 -04:00
```console
2017-02-07 18:42:48 -05:00
$ docker run -e MYVAR1 --env MYVAR2=foo --env-file ./env.list ubuntu bash
```
2015-06-21 16:41:38 -04:00
2017-03-28 13:19:28 -04:00
Use the `-e` , `--env` , and `--env-file` flags to set simple (non-array)
environment variables in the container you're running, or overwrite variables
2023-03-31 05:56:40 -04:00
defined in the Dockerfile of the image you're running.
2015-06-21 16:41:38 -04:00
2017-03-28 13:19:28 -04:00
You can define the variable and its value when running the container:
2015-06-21 16:41:38 -04:00
2021-08-21 08:54:14 -04:00
```console
2017-03-28 13:19:28 -04:00
$ docker run --env VAR1=value1 --env VAR2=value2 ubuntu env | grep VAR
VAR1=value1
VAR2=value2
2017-02-07 18:42:48 -05:00
```
2015-06-21 16:41:38 -04:00
2023-03-31 05:56:40 -04:00
You can also use variables exported to your local environment:
2015-06-21 16:41:38 -04:00
2021-08-21 08:54:14 -04:00
```console
2017-03-28 13:19:28 -04:00
export VAR1=value1
export VAR2=value2
$ docker run --env VAR1 --env VAR2 ubuntu env | grep VAR
VAR1=value1
VAR2=value2
```
When running the command, the Docker CLI client checks the value the variable
has in your local environment and passes it to the container.
2023-12-13 09:16:56 -05:00
If no `=` is provided and that variable isn't exported in your local
environment, the variable is unset in the container.
2017-03-28 13:19:28 -04:00
You can also load the environment variables from a file. This file should use
2017-04-27 05:12:48 -04:00
the syntax `<variable>=value` (which sets the variable to the given value) or
2023-12-13 09:16:56 -05:00
`<variable>` (which takes the value from the local environment), and `#` for
comments. Lines beginning with `#` are treated as line comments and are
ignored, whereas a `#` appearing anywhere else in a line is treated as part of
the variable value.
2015-06-21 16:41:38 -04:00
2021-08-21 08:54:14 -04:00
```console
2017-03-28 13:19:28 -04:00
$ cat env.list
# This is a comment
VAR1=value1
VAR2=value2
2017-04-27 05:12:48 -04:00
USER
2017-02-07 18:42:48 -05:00
2021-02-22 16:00:43 -05:00
$ docker run --env-file env.list ubuntu env | grep -E 'VAR|USER'
2017-03-28 13:19:28 -04:00
VAR1=value1
VAR2=value2
2021-02-22 16:00:43 -05:00
USER=jonzeolla
2017-02-07 18:42:48 -05:00
```
2015-06-21 16:41:38 -04:00
2023-01-06 13:28:29 -05:00
### <a name="label"></a> Set metadata on container (-l, --label, --label-file)
2015-09-27 21:45:10 -04:00
A label is a `key=value` pair that applies metadata to a container. To label a container with two labels:
2015-06-21 16:41:38 -04:00
2021-08-21 08:54:14 -04:00
```console
2017-02-07 18:42:48 -05:00
$ docker run -l my-label --label com.example.foo=bar ubuntu bash
```
2015-06-21 16:41:38 -04:00
The `my-label` key doesn't specify a value so the label defaults to an empty
2018-09-28 17:40:22 -04:00
string (`""`). To add multiple labels, repeat the label flag (`-l` or `--label` ).
2015-06-21 16:41:38 -04:00
The `key=value` must be unique to avoid overwriting the label value. If you
specify labels with identical keys but different values, each subsequent value
overwrites the previous. Docker uses the last `key=value` you supply.
Use the `--label-file` flag to load multiple labels from a file. Delimit each
label in the file with an EOL mark. The example below loads labels from a
labels file in the current directory:
2021-08-21 08:54:14 -04:00
```console
2017-02-07 18:42:48 -05:00
$ docker run --label-file ./labels ubuntu bash
```
2015-06-21 16:41:38 -04:00
The label-file format is similar to the format for loading environment
variables. (Unlike environment variables, labels are not visible to processes
2023-03-31 05:56:40 -04:00
running inside a container.) The following example shows a label-file
2015-06-21 16:41:38 -04:00
format:
2020-05-11 11:32:52 -04:00
```console
2017-02-07 18:42:48 -05:00
com.example.label1="a label"
2015-06-21 16:41:38 -04:00
2017-02-07 18:42:48 -05:00
# this is a comment
com.example.label2=another\ label
com.example.label3
```
2015-06-21 16:41:38 -04:00
You can load multiple label-files by supplying multiple `--label-file` flags.
2023-12-13 09:16:56 -05:00
For additional information on working with labels, see
[Labels ](https://docs.docker.com/config/labels-custom-metadata/ ).
2015-06-21 16:41:38 -04:00
2023-01-06 13:28:29 -05:00
### <a name="network"></a> Connect a container to a network (--network)
2015-09-30 16:11:36 -04:00
2023-03-31 05:56:40 -04:00
To start a container and connect it to a network, use the `--network` option.
2024-04-08 04:16:17 -04:00
If you want to add a running container to a network use the `docker network connect` subcommand.
You can connect multiple containers to the same network. Once connected, the
containers can communicate using only another container's IP address
or name. For `overlay` networks or custom plugins that support multi-host
connectivity, containers connected to the same multi-host network but launched
from different Engines can also communicate in this way.
2024-08-16 05:02:10 -04:00
> [!NOTE]
2024-04-08 04:16:17 -04:00
> The default bridge network only allows containers to communicate with each other using
> internal IP addresses. User-created bridge networks provide DNS resolution between
> containers using container names.
You can disconnect a container from a network using the `docker network
disconnect` command.
The following commands create a network named `my-net` and add a `busybox` container
2022-10-28 11:12:54 -04:00
to the `my-net` network.
2015-09-27 21:45:10 -04:00
2021-08-21 08:54:14 -04:00
```console
2022-10-28 11:12:54 -04:00
$ docker network create my-net
2016-06-06 19:33:00 -04:00
$ docker run -itd --network=my-net busybox
2015-09-30 16:11:36 -04:00
```
2015-06-21 16:41:38 -04:00
2016-01-11 21:03:40 -05:00
You can also choose the IP addresses for the container with `--ip` and `--ip6`
2023-06-26 09:42:50 -04:00
flags when you start the container on a user-defined network. To assign a
static IP to containers, you must specify subnet block for the network.
2016-01-11 21:03:40 -05:00
2021-08-21 08:54:14 -04:00
```console
2023-06-26 09:42:50 -04:00
$ docker network create --subnet 192.0.2.0/24 my-net
$ docker run -itd --network=my-net --ip=192.0.2.69 busybox
2016-01-11 21:03:40 -05:00
```
2024-04-08 04:16:17 -04:00
To connect the container to more than one network, repeat the `--network` option.
2015-06-21 16:41:38 -04:00
2024-04-08 04:16:17 -04:00
```console
$ docker network create --subnet 192.0.2.0/24 my-net1
$ docker network create --subnet 192.0.3.0/24 my-net2
$ docker run -itd --network=my-net1 --network=my-net2 busybox
```
2015-06-21 16:41:38 -04:00
2024-04-08 04:16:17 -04:00
To specify options when connecting to more than one network, use the extended syntax
for the `--network` flag. Comma-separated options that can be specified in the extended
`--network` syntax are:
2015-09-30 16:11:36 -04:00
2024-04-08 04:16:17 -04:00
| Option | Top-level Equivalent | Description |
|-----------------|---------------------------------------|-------------------------------------------------|
| `name` | | The name of the network (mandatory) |
| `alias` | `--network-alias` | Add network-scoped alias for the container |
| `ip` | `--ip` | IPv4 address (e.g., 172.30.100.104) |
| `ip6` | `--ip6` | IPv6 address (e.g., 2001:db8::33) |
| `mac-address` | `--mac-address` | Container MAC address (e.g., 92:d0:c6:0a:29:33) |
| `link-local-ip` | `--link-local-ip` | Container IPv4/IPv6 link-local addresses |
| `driver-opt` | `docker network connect --driver-opt` | Network driver options |
```console
$ docker network create --subnet 192.0.2.0/24 my-net1
$ docker network create --subnet 192.0.3.0/24 my-net2
$ docker run -itd --network=name=my-net1,ip=192.0.2.42 --network=name=my-net2,ip=192.0.3.42 busybox
```
2015-06-21 16:41:38 -04:00
2024-05-08 10:26:33 -04:00
`sysctl` settings that start with `net.ipv4.` , `net.ipv6.` or `net.mpls.` can be
set per-interface using `driver-opt` label `com.docker.network.endpoint.sysctls` .
The interface name must be the string `IFNAME` .
To set more than one `sysctl` for an interface, quote the whole `driver-opt` field,
remembering to escape the quotes for the shell if necessary. For example, if the
interface to `my-net` is given name `eth0` , the following example sets sysctls
`net.ipv4.conf.eth0.log_martians=1` and `net.ipv4.conf.eth0.forwarding=0` , and
assigns the IPv4 address `192.0.2.42` .
```console
$ docker network create --subnet 192.0.2.0/24 my-net
$ docker run -itd --network=name=my-net,\"driver-opt=com.docker.network.endpoint.sysctls=net.ipv4.conf.IFNAME.log_martians=1,net.ipv4.conf.IFNAME.forwarding=0\",ip=192.0.2.42 busybox
```
2015-06-21 16:41:38 -04:00
2024-08-16 05:02:10 -04:00
> [!NOTE]
2024-05-08 10:26:33 -04:00
> Network drivers may restrict the sysctl settings that can be modified and, to protect
> the operation of the network, new restrictions may be added in the future.
2015-06-21 16:41:38 -04:00
2024-04-08 04:16:17 -04:00
For more information on connecting a container to a network when using the `run` command,
see the [Docker network overview ](https://docs.docker.com/network/ ).
2023-03-31 05:56:40 -04:00
2023-01-06 13:28:29 -05:00
### <a name="volumes-from"></a> Mount volumes from container (--volumes-from)
2015-09-27 21:45:10 -04:00
2021-08-21 08:54:14 -04:00
```console
2017-02-07 18:42:48 -05:00
$ docker run --volumes-from 777f7dc92da7 --volumes-from ba8c0c54f0f2:ro -i -t ubuntu pwd
```
2015-06-21 16:41:38 -04:00
The `--volumes-from` flag mounts all the defined volumes from the referenced
2023-03-31 05:56:40 -04:00
containers. You can specify more than one container by repetitions of the `--volumes-from`
2015-06-21 16:41:38 -04:00
argument. The container ID may be optionally suffixed with `:ro` or `:rw` to
mount the volumes in read-only or read-write mode, respectively. By default,
2023-03-31 05:56:40 -04:00
Docker mounts the volumes in the same mode (read write or read only) as
2015-06-21 16:41:38 -04:00
the reference container.
2023-03-31 05:56:40 -04:00
Labeling systems like SELinux require placing proper labels on volume
2015-06-21 16:41:38 -04:00
content mounted into a container. Without a label, the security system might
prevent the processes running inside the container from using the content. By
default, Docker does not change the labels set by the OS.
To change the label in the container context, you can add either of two suffixes
`:z` or `:Z` to the volume mount. These suffixes tell Docker to relabel file
objects on the shared volumes. The `z` option tells Docker that two containers
share the volume content. As a result, Docker labels the content with a shared
content label. Shared volume labels allow all containers to read/write content.
The `Z` option tells Docker to label the content with a private unshared label.
Only the current container can use a private volume.
2023-10-20 10:38:17 -04:00
### <a name="detach"></a> Detached mode (-d, --detach)
2015-06-21 16:41:38 -04:00
2023-10-20 10:38:17 -04:00
The `--detach` (or `-d` ) flag starts a container as a background process that
doesn't occupy your terminal window. By design, containers started in detached
mode exit when the root process used to run the container exits, unless you
also specify the `--rm` option. If you use `-d` with `--rm` , the container is
removed when it exits or when the daemon exits, whichever happens first.
2015-06-21 16:41:38 -04:00
2023-10-20 10:38:17 -04:00
Don't pass a `service x start` command to a detached container. For example,
this command attempts to start the `nginx` service.
2015-06-21 16:41:38 -04:00
2021-08-21 08:54:14 -04:00
```console
2023-10-20 10:38:17 -04:00
$ docker run -d -p 80:80 my_image service nginx start
2017-02-07 18:42:48 -05:00
```
2015-06-21 16:41:38 -04:00
2023-10-20 10:38:17 -04:00
This succeeds in starting the `nginx` service inside the container. However, it
fails the detached container paradigm in that, the root process (`service nginx
start`) returns and the detached container stops as designed. As a result, the
`nginx` service starts but can't be used. Instead, to start a process such as
the `nginx` web server do the following:
2015-06-21 16:41:38 -04:00
2021-08-21 08:54:14 -04:00
```console
2023-10-20 10:38:17 -04:00
$ docker run -d -p 80:80 my_image nginx -g 'daemon off;'
2017-02-07 18:42:48 -05:00
```
2015-06-21 16:41:38 -04:00
2023-10-20 10:38:17 -04:00
To do input/output with a detached container use network connections or shared
volumes. These are required because the container is no longer listening to the
command line where `docker run` was run.
2022-10-28 11:12:54 -04:00
2023-06-08 08:37:21 -04:00
### <a name="detach-keys"></a> Override the detach sequence (--detach-keys)
Use the `--detach-keys` option to override the Docker key sequence for detach.
This is useful if the Docker default sequence conflicts with key sequence you
use for other applications. There are two ways to define your own detach key
sequence, as a per-container override or as a configuration property on your
entire configuration.
To override the sequence for an individual container, use the
`--detach-keys="<sequence>"` flag with the `docker attach` command. The format of
the `<sequence>` is either a letter [a-Z], or the `ctrl-` combined with any of
the following:
* `a-z` (a single lowercase alpha character )
* `@` (at sign)
* `[` (left bracket)
* `\\` (two backward slashes)
* `_` (underscore)
* `^` (caret)
These `a` , `ctrl-a` , `X` , or `ctrl-\\` values are all examples of valid key
sequences. To configure a different configuration default key sequence for all
2024-04-12 05:10:58 -04:00
containers, see [**Configuration file** section ](https://docs.docker.com/reference/cli/docker/#configuration-files ).
2023-06-08 08:37:21 -04:00
2023-01-06 13:28:29 -05:00
### <a name="device"></a> Add host device to container (--device)
2015-09-27 21:45:10 -04:00
2021-08-21 08:54:14 -04:00
```console
2022-10-10 18:29:42 -04:00
$ docker run -it --rm \
--device=/dev/sdc:/dev/xvdc \
--device=/dev/sdd \
--device=/dev/zero:/dev/foobar \
ubuntu ls -l /dev/{xvdc,sdd,foobar}
2017-02-07 18:42:48 -05:00
brw-rw---- 1 root disk 8, 2 Feb 9 16:05 /dev/xvdc
brw-rw---- 1 root disk 8, 3 Feb 9 16:05 /dev/sdd
2022-10-10 18:29:42 -04:00
crw-rw-rw- 1 root root 1, 5 Feb 9 16:05 /dev/foobar
2017-02-07 18:42:48 -05:00
```
2015-06-21 16:41:38 -04:00
2023-03-31 05:56:40 -04:00
It's often necessary to directly expose devices to a container. The `--device`
option enables that. For example, adding a specific block storage device or loop
device or audio device to an otherwise unprivileged container
2015-06-21 16:41:38 -04:00
(without the `--privileged` flag) and have the application directly access it.
2023-03-31 05:56:40 -04:00
By default, the container is able to `read` , `write` and `mknod` these devices.
2015-06-21 16:41:38 -04:00
This can be overridden using a third `:rwm` set of options to each `--device`
2023-03-31 05:56:40 -04:00
flag. If the container is running in privileged mode, then Docker ignores the
specified permissions.
2015-06-21 16:41:38 -04:00
2021-08-21 08:54:14 -04:00
```console
2017-02-07 18:42:48 -05:00
$ docker run --device=/dev/sda:/dev/xvdc --rm -it ubuntu fdisk /dev/xvdc
2015-06-21 16:41:38 -04:00
2017-02-07 18:42:48 -05:00
Command (m for help): q
$ docker run --device=/dev/sda:/dev/xvdc:r --rm -it ubuntu fdisk /dev/xvdc
You will not be able to write the partition table.
2015-06-21 16:41:38 -04:00
2017-02-07 18:42:48 -05:00
Command (m for help): q
2015-06-21 16:41:38 -04:00
2017-02-07 18:42:48 -05:00
$ docker run --device=/dev/sda:/dev/xvdc:rw --rm -it ubuntu fdisk /dev/xvdc
2015-06-21 16:41:38 -04:00
2017-02-07 18:42:48 -05:00
Command (m for help): q
2015-06-21 16:41:38 -04:00
2017-02-07 18:42:48 -05:00
$ docker run --device=/dev/sda:/dev/xvdc:m --rm -it ubuntu fdisk /dev/xvdc
fdisk: unable to open /dev/xvdc: Operation not permitted
```
2015-06-21 16:41:38 -04:00
2024-08-16 05:02:10 -04:00
> [!NOTE]
2023-03-31 05:56:40 -04:00
> The `--device` option cannot be safely used with ephemeral devices. You shouldn't
> add block devices that may be removed to untrusted containers with `--device`.
2015-06-21 16:41:38 -04:00
2019-02-07 12:56:05 -05:00
For Windows, the format of the string passed to the `--device` option is in
the form of `--device=<IdType>/<Id>` . Beginning with Windows Server 2019
and Windows 10 October 2018 Update, Windows only supports an IdType of
`class` and the Id as a [device interface class
GUID](https://docs.microsoft.com/en-us/windows-hardware/drivers/install/overview-of-device-interface-classes).
Refer to the table defined in the [Windows container
docs](https://docs.microsoft.com/en-us/virtualization/windowscontainers/deploy-containers/hardware-devices-in-containers)
for a list of container-supported device interface class GUIDs.
2023-03-31 05:56:40 -04:00
If you specify this option for a process-isolated Windows container, Docker makes
_all_ devices that implement the requested device interface class GUID
2019-02-07 12:56:05 -05:00
available in the container. For example, the command below makes all COM
ports on the host visible in the container.
```powershell
PS C:\> docker run --device=class/86E0D1E0-8089-11D0-9CE4-08003E301F73 mcr.microsoft.com/windows/servercore:ltsc2019
```
2024-08-16 05:02:10 -04:00
> [!NOTE]
2022-03-01 06:46:49 -05:00
> The `--device` option is only supported on process-isolated Windows containers,
> and produces an error if the container isolation is `hyperv`.
2019-02-07 12:56:05 -05:00
2024-01-18 07:24:23 -05:00
#### CDI devices
2024-08-16 05:02:10 -04:00
> [!NOTE]
2024-04-15 18:05:38 -04:00
> The CDI feature is experimental, and potentially subject to change.
> CDI is currently only supported for Linux containers.
2024-01-18 07:24:23 -05:00
2024-04-15 18:05:38 -04:00
[Container Device Interface
(CDI)](https://github.com/cncf-tags/container-device-interface/blob/main/SPEC.md)
is a standardized mechanism for container runtimes to create containers which
are able to interact with third party devices.
2024-01-18 07:24:23 -05:00
2024-04-15 18:05:38 -04:00
With CDI, device configurations are declaratively defined using a JSON or YAML
file. In addition to enabling the container to interact with the device node,
it also lets you specify additional configuration for the device, such as
environment variables, host mounts (such as shared objects), and executable
hooks.
2024-01-18 07:24:23 -05:00
You can reference a CDI device with the `--device` flag using the
fully-qualified name of the device, as shown in the following example:
```console
$ docker run --device=vendor.com/class=device-name --rm -it ubuntu
```
This starts an `ubuntu` container with access to the specified CDI device,
`vendor.com/class=device-name` , assuming that:
2024-04-15 18:05:38 -04:00
- A valid CDI specification (JSON or YAML file) for the requested device is
available on the system running the daemon, in one of the configured CDI
specification directories.
- The CDI feature has been enabled in the daemon; see [Enable CDI
2024-02-13 07:40:53 -05:00
devices](https://docs.docker.com/reference/cli/dockerd/#enable-cdi-devices).
2024-01-18 07:24:23 -05:00
2023-10-20 10:38:17 -04:00
### <a name="attach"></a> Attach to STDIN/STDOUT/STDERR (-a, --attach)
The `--attach` (or `-a` ) flag tells `docker run` to bind to the container's
`STDIN` , `STDOUT` or `STDERR` . This makes it possible to manipulate the output
and input as needed. You can specify to which of the three standard streams
(`STDIN`, `STDOUT` , `STDERR` ) you'd like to connect instead, as in:
```console
$ docker run -a stdin -a stdout -i -t ubuntu /bin/bash
```
The following example pipes data into a container and prints the container's ID
by attaching only to the container's `STDIN` .
```console
$ echo "test" | docker run -i -a stdin ubuntu cat -
```
The following example doesn't print anything to the console unless there's an
error because output is only attached to the `STDERR` of the container. The
container's logs still store what's written to `STDERR` and `STDOUT` .
```console
$ docker run -a stderr ubuntu echo test
```
The following example shows a way of using `--attach` to pipe a file into a
container. The command prints the container's ID after the build completes and
you can retrieve the build logs using `docker logs` . This is useful if you need
to pipe a file or something else into a container and retrieve the container's
ID once the container has finished running.
```console
$ cat somefile | docker run -i -a stdin mybuilder dobuild
```
2024-08-16 05:02:10 -04:00
> [!NOTE]
2023-12-13 09:16:56 -05:00
> A process running as PID 1 inside a container is treated specially by
> Linux: it ignores any signal with the default action. So, the process
> doesn't terminate on `SIGINT` or `SIGTERM` unless it's coded to do so.
2023-10-20 10:38:17 -04:00
2024-01-19 08:06:29 -05:00
See also [the `docker cp` command ](container_cp.md ).
2023-10-20 10:38:17 -04:00
### <a name="interactive"></a> Keep STDIN open (-i, --interactive)
The `--interactive` (or `-i` ) flag keeps the container's `STDIN` open, and lets
you send input to the container through standard input.
```console
$ echo hello | docker run --rm -i busybox cat
hello
```
The `-i` flag is most often used together with the `--tty` flag to bind the I/O
streams of the container to a pseudo terminal, creating an interactive terminal
session for the container. See [Allocate a pseudo-TTY ](#tty ) for more examples.
```console
$ docker run -it debian
root@10a3e71492b0:/# factor 90
90: 2 3 3 5
root@10a3e71492b0:/# exit
exit
```
Using the `-i` flag on its own allows for composition, such as piping input to
containers:
```console
$ docker run --rm -i busybox echo "foo bar baz" \
| docker run --rm -i busybox awk '{ print $2 }' \
| docker run --rm -i busybox rev
rab
```
2024-01-05 10:41:26 -05:00
### <a name="init"></a> Specify an init process
2023-11-23 08:15:17 -05:00
You can use the `--init` flag to indicate that an init process should be used as
the PID 1 in the container. Specifying an init process ensures the usual
responsibilities of an init system, such as reaping zombie processes, are
performed inside the created container.
The default init process used is the first `docker-init` executable found in the
system path of the Docker daemon process. This `docker-init` binary, included in
the default installation, is backed by [tini ](https://github.com/krallin/tini ).
2023-10-20 10:38:17 -04:00
### <a name="tty"></a> Allocate a pseudo-TTY (-t, --tty)
The `--tty` (or `-t` ) flag attaches a pseudo-TTY to the container, connecting
your terminal to the I/O streams of the container. Allocating a pseudo-TTY to
the container means that you get access to input and output feature that TTY
devices provide.
For example, the following command runs the `passwd` command in a `debian`
container, to set a new password for the `root` user.
```console
$ docker run -i debian passwd root
New password: karjalanpiirakka9
Retype new password: karjalanpiirakka9
passwd: password updated successfully
```
If you run this command with only the `-i` flag (which lets you send text to
`STDIN` of the container), the `passwd` prompt displays the password in plain
text. However, if you try the same thing but also adding the `-t` flag, the
password is hidden:
```console
2024-02-29 04:59:08 -05:00
$ docker run -it debian passwd root
2023-10-20 10:38:17 -04:00
New password:
Retype new password:
passwd: password updated successfully
```
This is because `passwd` can suppress the output of characters to the terminal
using the echo-off TTY feature.
You can use the `-t` flag without `-i` flag. This still allocates a pseudo-TTY
to the container, but with no way of writing to `STDIN` . The only time this
might be useful is if the output of the container requires a TTY environment.
2024-01-05 10:41:26 -05:00
### <a name="cgroup-parent"></a> Specify custom cgroups
2023-11-23 08:17:19 -05:00
Using the `--cgroup-parent` flag, you can pass a specific cgroup to run a
container in. This allows you to create and manage cgroups on their own. You can
define custom resources for those cgroups and put containers under a common
parent group.
2022-03-01 06:29:54 -05:00
### <a name="device-cgroup-rule"></a> Using dynamically created devices (--device-cgroup-rule)
2023-03-31 05:56:40 -04:00
Docker assigns devices available to a container at creation time. The
assigned devices are added to the cgroup.allow file and
created into the container when it runs. This poses a problem when
you need to add a new device to running container.
2022-03-01 06:29:54 -05:00
2023-03-31 05:56:40 -04:00
One solution is to add a more permissive rule to a container
2022-03-01 06:29:54 -05:00
allowing it access to a wider range of devices. For example, supposing
2023-03-31 05:56:40 -04:00
the container needs access to a character device with major `42` and
any number of minor numbers (added as new devices appear), add the
following rule:
2022-03-01 06:29:54 -05:00
```console
2023-11-27 14:58:55 -05:00
$ docker run -d --device-cgroup-rule='c 42:* rmw' --name my-container my-image
2022-03-01 06:29:54 -05:00
```
Then, a user could ask `udev` to execute a script that would `docker exec my-container mknod newDevX c 42 <minor>`
the required device when it is added.
2024-08-16 05:02:10 -04:00
> [!NOTE]
> You still need to explicitly add initially present devices to the
2022-03-01 06:29:54 -05:00
> `docker run` / `docker create` command.
2023-01-06 13:28:29 -05:00
### <a name="gpus"></a> Access an NVIDIA GPU
2019-06-21 18:40:02 -04:00
2022-03-01 06:29:54 -05:00
The `--gpus` flag allows you to access NVIDIA GPU resources. First you need to
2023-03-31 05:56:40 -04:00
install the [nvidia-container-runtime ](https://nvidia.github.io/nvidia-container-runtime/ ).
2024-08-16 05:02:10 -04:00
> [!NOTE]
2024-01-18 07:24:23 -05:00
> You can also specify a GPU as a CDI device with the `--device` flag, see
> [CDI devices](#cdi-devices).
2023-03-31 05:56:40 -04:00
Read [Specify a container's resources ](https://docs.docker.com/config/containers/resource_constraints/ )
2019-06-21 18:40:02 -04:00
for more information.
2023-03-31 05:56:40 -04:00
To use `--gpus` , specify which GPUs (or all) to use. If you provide no value, Docker uses all
available GPUs. The example below exposes all available GPUs.
2019-06-21 18:40:02 -04:00
2021-08-21 08:54:14 -04:00
```console
2019-06-21 18:40:02 -04:00
$ docker run -it --rm --gpus all ubuntu nvidia-smi
```
Use the `device` option to specify GPUs. The example below exposes a specific
GPU.
2021-08-21 08:54:14 -04:00
```console
2019-06-21 18:40:02 -04:00
$ docker run -it --rm --gpus device=GPU-3a23c669-1f69-c64e-cf85-44e9b07e7a2a ubuntu nvidia-smi
```
The example below exposes the first and third GPUs.
2021-08-21 08:54:14 -04:00
```console
2022-04-14 10:47:14 -04:00
$ docker run -it --rm --gpus '"device=0,2"' ubuntu nvidia-smi
2019-06-21 18:40:02 -04:00
```
2023-01-06 13:28:29 -05:00
### <a name="restart"></a> Restart policies (--restart)
2015-06-21 16:41:38 -04:00
2023-03-31 05:56:40 -04:00
Use the `--restart` flag to specify a container's *restart policy* . A restart
2015-06-21 16:41:38 -04:00
policy controls whether the Docker daemon restarts a container after exit.
Docker supports the following restart policies:
2024-10-07 07:05:43 -04:00
| Flag | Description |
| :------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `no` | Don't automatically restart the container. (Default) |
| `on-failure[:max-retries]` | Restart the container if it exits due to an error, which manifests as a non-zero exit code. Optionally, limit the number of times the Docker daemon attempts to restart the container using the `:max-retries` option. The `on-failure` policy only prompts a restart if the container exits with a failure. It doesn't restart the container if the daemon restarts. |
| `always` | Always restart the container if it stops. If it's manually stopped, it's restarted only when Docker daemon restarts or the container itself is manually restarted. |
| `unless-stopped` | Similar to `always` , except that when the container is stopped (manually or otherwise), it isn't restarted even after Docker daemon restarts. |
2017-02-07 18:42:48 -05:00
2021-08-21 08:54:14 -04:00
```console
2017-02-07 18:42:48 -05:00
$ docker run --restart=always redis
```
2015-06-21 16:41:38 -04:00
2023-12-13 09:16:56 -05:00
This runs the `redis` container with a restart policy of **always** .
If the container exits, Docker restarts it.
2015-06-21 16:41:38 -04:00
2023-11-23 07:43:16 -05:00
When a restart policy is active on a container, it shows as either `Up` or
2024-01-19 08:06:29 -05:00
`Restarting` in [`docker ps` ](container_ls.md ). It can also be useful to use
[`docker events` ](system_events.md ) to see the restart policy in effect.
2023-11-23 07:43:16 -05:00
An increasing delay (double the previous delay, starting at 100 milliseconds)
is added before each restart to prevent flooding the server. This means the
daemon waits for 100 ms, then 200 ms, 400, 800, 1600, and so on until either
the `on-failure` limit, the maximum delay of 1 minute is hit, or when you
`docker stop` or `docker rm -f` the container.
If a container is successfully restarted (the container is started and runs
for at least 10 seconds), the delay is reset to its default value of 100 ms.
#### Specify a limit for restart attempts
You can specify the maximum amount of times Docker attempts to restart the
container when using the **on-failure** policy. By default, Docker never stops
attempting to restart the container.
The following example runs the `redis` container with a restart policy of
**on-failure** and a maximum restart count of 10.
```console
$ docker run --restart=on-failure:10 redis
```
If the `redis` container exits with a non-zero exit status more than 10 times
in a row, Docker stops trying to restart the container. Providing a maximum
restart limit is only valid for the **on-failure** policy.
#### Inspect container restarts
The number of (attempted) restarts for a container can be obtained using the
2024-01-19 08:06:29 -05:00
[`docker inspect` ](inspect.md ) command. For example, to get the number of
restarts for container "my-container";
2023-11-23 07:43:16 -05:00
```console
$ docker inspect -f "{{ .RestartCount }}" my-container
2
```
Or, to get the last time the container was (re)started;
```console
$ docker inspect -f "{{ .State.StartedAt }}" my-container
2015-03-04T23:47:07.691840179Z
```
Combining `--restart` (restart policy) with the `--rm` (clean up) flag results
in an error. On container restart, attached clients are disconnected.
2015-06-21 16:41:38 -04:00
2023-11-23 07:52:55 -05:00
### <a name="rm"></a> Clean up (--rm)
By default, a container's file system persists even after the container exits.
This makes debugging a lot easier, since you can inspect the container's final
state and you retain all your data.
If you are running short-term **foreground** processes, these container file
systems can start to pile up. If you'd like Docker to automatically clean up
the container and remove the file system when the container exits, use the
`--rm` flag:
```text
2024-09-13 19:43:22 -04:00
--rm: Automatically remove the container when it exits
2023-11-23 07:52:55 -05:00
```
2024-08-16 05:02:10 -04:00
> [!NOTE]
2023-11-23 07:52:55 -05:00
> If you set the `--rm` flag, Docker also removes the anonymous volumes
> associated with the container when the container is removed. This is similar
2023-12-13 09:16:56 -05:00
> to running `docker rm -v my-container`. Only volumes that are specified
> without a name are removed. For example, when running the following command,
> volume `/foo` is removed, but not `/bar`:
2023-11-23 07:52:55 -05:00
>
> ```console
> $ docker run --rm -v /foo -v awesome:/bar busybox top
> ```
>
2023-12-13 09:16:56 -05:00
> Volumes inherited via `--volumes-from` are removed with the same logic:
> if the original volume was specified with a name it isn't removed.
2023-11-23 07:52:55 -05:00
2023-01-06 13:28:29 -05:00
### <a name="add-host"></a> Add entries to container hosts file (--add-host)
2015-06-21 16:41:38 -04:00
You can add other hosts into a container's `/etc/hosts` file by using one or
more `--add-host` flags. This example adds a static address for a host named
2023-11-15 10:11:46 -05:00
`my-hostname` :
2015-06-21 16:41:38 -04:00
2021-08-21 08:54:14 -04:00
```console
2023-11-15 10:11:46 -05:00
$ docker run --add-host=my-hostname=8.8.8.8 --rm -it alpine
2017-02-07 18:42:48 -05:00
2023-11-15 10:11:46 -05:00
/ # ping my-hostname
PING my-hostname (8.8.8.8): 56 data bytes
64 bytes from 8.8.8.8: seq=0 ttl=37 time=93.052 ms
64 bytes from 8.8.8.8: seq=1 ttl=37 time=92.467 ms
64 bytes from 8.8.8.8: seq=2 ttl=37 time=92.252 ms
2021-08-21 08:54:14 -04:00
^C
2023-11-15 10:11:46 -05:00
--- my-hostname ping statistics ---
2021-08-21 08:54:14 -04:00
4 packets transmitted, 4 packets received, 0% packet loss
round-trip min/avg/max = 92.209/92.495/93.052 ms
2017-02-07 18:42:48 -05:00
```
2015-06-21 16:41:38 -04:00
2023-11-15 10:11:46 -05:00
You can wrap an IPv6 address in square brackets:
```console
$ docker run --add-host my-hostname=[2001:db8::33] --rm -it alpine
```
2023-07-03 10:34:55 -04:00
The `--add-host` flag supports a special `host-gateway` value that resolves to
the internal IP address of the host. This is useful when you want containers to
connect to services running on the host machine.
2015-06-21 16:41:38 -04:00
2023-07-03 10:34:55 -04:00
It's conventional to use `host.docker.internal` as the hostname referring to
`host-gateway` . Docker Desktop automatically resolves this hostname, see
2024-11-07 04:38:19 -05:00
[Explore networking features ](https://docs.docker.com/desktop/features/networking/#i-want-to-connect-from-a-container-to-a-service-on-the-host ).
2023-07-03 10:34:55 -04:00
The following example shows how the special `host-gateway` value works. The
example runs an HTTP server that serves a file from host to container over the
`host.docker.internal` hostname, which resolves to the host's internal IP.
2015-06-21 16:41:38 -04:00
2021-08-21 08:54:14 -04:00
```console
2023-07-03 10:34:55 -04:00
$ echo "hello from host!" > ./hello
$ python3 -m http.server 8000
Serving HTTP on 0.0.0.0 port 8000 (http://0.0.0.0:8000/) ...
$ docker run \
2023-11-15 10:11:46 -05:00
--add-host host.docker.internal=host-gateway \
2023-07-03 10:34:55 -04:00
curlimages/curl -s host.docker.internal:8000/hello
hello from host!
2017-02-07 18:42:48 -05:00
```
2015-06-21 16:41:38 -04:00
2023-11-15 10:11:46 -05:00
The `--add-host` flag also accepts a `:` separator, for example:
```console
$ docker run --add-host=my-hostname:8.8.8.8 --rm -it alpine
```
2024-01-05 10:41:26 -05:00
### <a name="log-driver"></a> Logging drivers (--log-driver)
2023-11-23 08:25:06 -05:00
The container can have a different logging driver than the Docker daemon. Use
the `--log-driver=<DRIVER>` with the `docker run` command to configure the
container's logging driver.
To learn about the supported logging drivers and how to use them, refer to
2024-08-11 10:43:21 -04:00
[Configure logging drivers ](https://docs.docker.com/engine/logging/configure/ ).
2023-11-23 08:25:06 -05:00
To disable logging for a container, set the `--log-driver` flag to `none` :
```console
$ docker run --log-driver=none -d nginx:alpine
5101d3b7fe931c27c2ba0e65fd989654d297393ad65ae238f20b97a020e7295b
$ docker logs 5101d3b
Error response from daemon: configured logging driver does not support reading
```
2023-01-06 13:28:29 -05:00
### <a name="ulimit"></a> Set ulimits in container (--ulimit)
2015-06-21 16:41:38 -04:00
Since setting `ulimit` settings in a container requires extra privileges not
available in the default container, you can set these using the `--ulimit` flag.
2023-03-31 05:56:40 -04:00
Specify `--ulimit` with a soft and hard limit in the format
`<type>=<soft limit>[:<hard limit>]` . For example:
2015-06-21 16:41:38 -04:00
2021-08-21 08:54:14 -04:00
```console
2017-02-07 18:42:48 -05:00
$ docker run --ulimit nofile=1024:1024 --rm debian sh -c "ulimit -n"
1024
```
2015-06-21 16:41:38 -04:00
2024-08-16 05:02:10 -04:00
> [!NOTE]
2023-03-31 05:56:40 -04:00
> If you don't provide a hard limit value, Docker uses the soft limit value
> for both values. If you don't provide any values, they are inherited from
> the default `ulimits` set on the daemon.
2024-08-16 05:02:10 -04:00
> [!NOTE]
2023-03-31 05:56:40 -04:00
> The `as` option is deprecated.
2015-06-21 16:41:38 -04:00
> In other words, the following script is not supported:
2017-02-07 18:42:48 -05:00
>
2021-08-21 08:54:14 -04:00
> ```console
2021-10-18 08:49:18 -04:00
> $ docker run -it --ulimit as=1024 fedora /bin/bash
2017-02-07 18:42:48 -05:00
> ```
2015-06-21 16:41:38 -04:00
2023-03-31 05:56:40 -04:00
Docker sends the values to the appropriate OS `syscall` and doesn't perform any byte conversion.
Take this into account when setting the values.
2015-06-28 10:40:53 -04:00
2015-09-27 21:45:10 -04:00
#### For `nproc` usage
2015-06-28 10:40:53 -04:00
2023-03-31 05:56:40 -04:00
Be careful setting `nproc` with the `ulimit` flag as Linux uses `nproc` to set the
2022-10-28 11:12:54 -04:00
maximum number of processes available to a user, not to a container. For example, start four
2015-06-28 10:40:53 -04:00
containers with `daemon` user:
2021-08-21 08:54:14 -04:00
```console
2017-02-07 18:42:48 -05:00
$ docker run -d -u daemon --ulimit nproc=3 busybox top
$ docker run -d -u daemon --ulimit nproc=3 busybox top
$ docker run -d -u daemon --ulimit nproc=3 busybox top
$ docker run -d -u daemon --ulimit nproc=3 busybox top
```
2015-06-28 10:40:53 -04:00
2023-03-31 05:56:40 -04:00
The 4th container fails and reports a "[8] System error: resource temporarily unavailable" error.
2015-10-08 10:20:06 -04:00
This fails because the caller set `nproc=3` resulting in the first three containers using up
2015-06-28 10:40:53 -04:00
the three processes quota set for the `daemon` user.
2015-08-18 13:30:44 -04:00
2023-01-06 13:28:29 -05:00
### <a name="stop-signal"></a> Stop container with signal (--stop-signal)
2015-08-18 13:30:44 -04:00
2023-03-31 05:56:40 -04:00
The `--stop-signal` flag sends the system call signal to the
2021-08-21 07:50:05 -04:00
container to exit. This signal can be a signal name in the format `SIG<NAME>` ,
for instance `SIGKILL` , or an unsigned number that matches a position in the
kernel's syscall table, for instance `9` .
2024-02-13 07:40:53 -05:00
The default value is defined by [`STOPSIGNAL` ](https://docs.docker.com/reference/dockerfile/#stopsignal )
2021-08-11 05:00:27 -04:00
in the image, or `SIGTERM` if the image has no `STOPSIGNAL` defined.
2015-11-09 04:11:10 -05:00
2023-01-06 13:28:29 -05:00
### <a name="security-opt"></a> Optional security options (--security-opt)
2016-06-07 15:15:50 -04:00
2024-01-05 05:57:19 -05:00
| Option | Description |
|:------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `--security-opt="label=user:USER"` | Set the label user for the container |
| `--security-opt="label=role:ROLE"` | Set the label role for the container |
| `--security-opt="label=type:TYPE"` | Set the label type for the container |
| `--security-opt="label=level:LEVEL"` | Set the label level for the container |
| `--security-opt="label=disable"` | Turn off label confinement for the container |
| `--security-opt="apparmor=PROFILE"` | Set the apparmor profile to be applied to the container |
| `--security-opt="no-new-privileges=true"` | Disable container processes from gaining new privileges |
| `--security-opt="seccomp=unconfined"` | Turn off seccomp confinement for the container |
| `--security-opt="seccomp=builtin"` | Use the default (built-in) seccomp profile for the container. This can be used to enable seccomp for a container running on a daemon with a custom default profile set, or with seccomp disabled ("unconfined"). |
| `--security-opt="seccomp=profile.json"` | White-listed syscalls seccomp Json file to be used as a seccomp filter |
2024-04-05 09:59:00 -04:00
| `--security-opt="systempaths=unconfined"` | Turn off confinement for system paths (masked paths, read-only paths) for the container |
2023-11-23 08:13:24 -05:00
The `--security-opt` flag lets you override the default labeling scheme for a
container. Specifying the level in the following command allows you to share
the same content between containers.
```console
$ docker run --security-opt label=level:s0:c100,c200 -it fedora bash
```
2024-08-16 05:02:10 -04:00
> [!NOTE]
2023-11-23 08:13:24 -05:00
> Automatic translation of MLS labels isn't supported.
To disable the security labeling for a container entirely, you can use
`label=disable` :
```console
$ docker run --security-opt label=disable -it ubuntu bash
```
If you want a tighter security policy on the processes within a container, you
can specify a custom `type` label. The following example runs a container
that's only allowed to listen on Apache ports:
```console
$ docker run --security-opt label=type:svirt_apache_t -it ubuntu bash
```
2024-08-16 05:02:10 -04:00
> [!NOTE]
2023-11-23 08:13:24 -05:00
> You would have to write policy defining a `svirt_apache_t` type.
To prevent your container processes from gaining additional privileges, you can
use the following command:
```console
$ docker run --security-opt no-new-privileges -it ubuntu bash
```
2023-12-13 09:16:56 -05:00
This means that commands that raise privileges such as `su` or `sudo` no longer work.
2023-11-23 08:13:24 -05:00
It also causes any seccomp filters to be applied later, after privileges have been dropped
which may mean you can have a more restrictive set of filters.
For more details, see the [kernel documentation ](https://www.kernel.org/doc/Documentation/prctl/no_new_privs.txt ).
On Windows, you can use the `--security-opt` flag to specify the `credentialspec` option.
2016-10-19 13:25:45 -04:00
The `credentialspec` must be in the format `file://spec.txt` or `registry://keyname` .
2016-06-07 15:15:50 -04:00
2023-01-06 13:28:29 -05:00
### <a name="stop-timeout"></a> Stop container with timeout (--stop-timeout)
2016-05-26 16:34:48 -04:00
2021-08-21 07:50:05 -04:00
The `--stop-timeout` flag sets the number of seconds to wait for the container
to stop after sending the pre-defined (see `--stop-signal` ) system call signal.
2023-03-31 05:56:40 -04:00
If the container does not exit after the timeout elapses, it's forcibly killed
2021-08-21 07:50:05 -04:00
with a `SIGKILL` signal.
2023-03-31 05:56:40 -04:00
If you set `--stop-timeout` to `-1` , no timeout is applied, and the daemon
waits indefinitely for the container to exit.
2021-08-21 07:50:05 -04:00
2023-03-31 05:56:40 -04:00
The Daemon determines the default, and is 10 seconds for Linux containers,
2021-08-21 07:50:05 -04:00
and 30 seconds for Windows containers.
2016-05-26 16:34:48 -04:00
2023-01-06 13:28:29 -05:00
### <a name="isolation"></a> Specify isolation technology for container (--isolation)
2015-11-09 04:11:10 -05:00
This option is useful in situations where you are running Docker containers on
2022-03-01 06:29:54 -05:00
Windows. The `--isolation=<value>` option sets a container's isolation technology.
On Linux, the only supported is the `default` option which uses Linux namespaces.
These two commands are equivalent on Linux:
2015-11-09 04:11:10 -05:00
2021-08-21 08:54:14 -04:00
```console
2015-11-09 04:11:10 -05:00
$ docker run -d busybox top
$ docker run -d --isolation default busybox top
```
2017-01-03 19:17:55 -05:00
On Windows, `--isolation` can take one of these values:
2015-11-09 04:11:10 -05:00
2022-03-01 06:29:54 -05:00
| Value | Description |
|:----------|:-------------------------------------------------------------------------------------------|
| `default` | Use the value specified by the Docker daemon's `--exec-opt` or system default (see below). |
| `process` | Shared-kernel namespace isolation. |
| `hyperv` | Hyper-V hypervisor partition-based isolation. |
2015-11-09 04:11:10 -05:00
2022-03-01 06:29:54 -05:00
The default isolation on Windows server operating systems is `process` , and `hyperv`
2022-10-28 11:12:54 -04:00
on Windows client operating systems, such as Windows 10. Process isolation has better
performance, but requires that the image and host use the same kernel version.
2015-11-09 04:11:10 -05:00
2017-01-03 19:17:55 -05:00
On Windows server, assuming the default configuration, these commands are equivalent
and result in `process` isolation:
2015-11-09 04:11:10 -05:00
2019-05-13 19:37:30 -04:00
```powershell
2017-01-03 19:17:55 -05:00
PS C:\> docker run -d microsoft/nanoserver powershell echo process
PS C:\> docker run -d --isolation default microsoft/nanoserver powershell echo process
PS C:\> docker run -d --isolation process microsoft/nanoserver powershell echo process
2015-11-09 04:11:10 -05:00
```
2017-01-03 19:17:55 -05:00
If you have set the `--exec-opt isolation=hyperv` option on the Docker `daemon` , or
are running against a Windows client-based daemon, these commands are equivalent and
result in `hyperv` isolation:
2019-05-13 19:37:30 -04:00
```powershell
2017-01-03 19:17:55 -05:00
PS C:\> docker run -d microsoft/nanoserver powershell echo hyperv
PS C:\> docker run -d --isolation default microsoft/nanoserver powershell echo hyperv
PS C:\> docker run -d --isolation hyperv microsoft/nanoserver powershell echo hyperv
2015-11-09 04:11:10 -05:00
```
2016-03-29 08:24:28 -04:00
2023-01-06 13:28:29 -05:00
### <a name="memory"></a> Specify hard limits on memory available to containers (-m, --memory)
2017-04-26 09:30:09 -04:00
2023-03-31 05:56:40 -04:00
These parameters always set an upper limit on the memory available to the container. Linux sets this
on the cgroup and applications in a container can query it at `/sys/fs/cgroup/memory/memory.limit_in_bytes` .
2017-04-26 09:30:09 -04:00
2023-03-31 05:56:40 -04:00
On Windows, this affects containers differently depending on what type of isolation you use.
2017-04-26 09:30:09 -04:00
2023-03-31 05:56:40 -04:00
- With `process` isolation, Windows reports the full memory of the host system, not the limit to applications running inside the container
2017-08-16 11:53:57 -04:00
2017-04-26 09:30:09 -04:00
```powershell
2017-08-16 11:53:57 -04:00
PS C:\> docker run -it -m 2GB --isolation=process microsoft/nanoserver powershell Get-ComputerInfo *memory*
2017-04-26 09:30:09 -04:00
CsTotalPhysicalMemory : 17064509440
CsPhyicallyInstalledMemory : 16777216
OsTotalVisibleMemorySize : 16664560
OsFreePhysicalMemory : 14646720
OsTotalVirtualMemorySize : 19154928
OsFreeVirtualMemory : 17197440
OsInUseVirtualMemory : 1957488
OsMaxProcessMemorySize : 137438953344
```
2017-08-16 11:53:57 -04:00
2023-03-31 05:56:40 -04:00
- With `hyperv` isolation, Windows creates a utility VM that is big enough to hold the memory limit, plus the minimal OS needed to host the container. That size is reported as "Total Physical Memory."
2017-08-16 11:53:57 -04:00
2017-04-26 09:30:09 -04:00
```powershell
2017-08-16 11:53:57 -04:00
PS C:\> docker run -it -m 2GB --isolation=hyperv microsoft/nanoserver powershell Get-ComputerInfo *memory*
2017-04-26 09:30:09 -04:00
CsTotalPhysicalMemory : 2683355136
CsPhyicallyInstalledMemory :
OsTotalVisibleMemorySize : 2620464
OsFreePhysicalMemory : 2306552
OsTotalVirtualMemorySize : 2620464
OsFreeVirtualMemory : 2356692
OsInUseVirtualMemory : 263772
OsMaxProcessMemorySize : 137438953344
```
2023-01-06 13:28:29 -05:00
### <a name="sysctl"></a> Configure namespaced kernel parameters (sysctls) at runtime (--sysctl)
2016-03-29 08:24:28 -04:00
The `--sysctl` sets namespaced kernel parameters (sysctls) in the
container. For example, to turn on IP forwarding in the containers
network namespace, run this command:
2021-08-21 08:54:14 -04:00
```console
2017-02-07 18:42:48 -05:00
$ docker run --sysctl net.ipv4.ip_forward=1 someimage
```
2016-03-29 08:24:28 -04:00
2024-08-16 05:02:10 -04:00
> [!NOTE]
2020-04-19 09:43:08 -04:00
> Not all sysctls are namespaced. Docker does not support changing sysctls
2016-10-19 13:25:45 -04:00
> inside of a container that also modify the host system. As the kernel
2016-03-29 08:24:28 -04:00
> evolves we expect to see more sysctls become namespaced.
2023-03-31 05:56:40 -04:00
2016-03-29 08:24:28 -04:00
#### Currently supported sysctls
2020-04-19 09:43:08 -04:00
IPC Namespace:
2016-03-29 08:24:28 -04:00
2020-04-19 09:43:08 -04:00
- `kernel.msgmax` , `kernel.msgmnb` , `kernel.msgmni` , `kernel.sem` ,
`kernel.shmall` , `kernel.shmmax` , `kernel.shmmni` , `kernel.shm_rmid_forced` .
- Sysctls beginning with `fs.mqueue.*`
- If you use the `--ipc=host` option these sysctls are not allowed.
2017-02-07 18:42:48 -05:00
2020-04-19 09:43:08 -04:00
Network Namespace:
2016-03-29 08:24:28 -04:00
2020-04-19 09:43:08 -04:00
- Sysctls beginning with `net.*`
- If you use the `--network=host` option using these sysctls are not allowed.
2023-03-31 05:56:40 -04:00
## Command internals
The `docker run` command is equivalent to the following API calls:
- `/<API version>/containers/create`
- If that call returns a 404 (image not found), and depending on the `--pull` option ("always", "missing", "never") the call can trigger a `docker pull <image>` .
- `/containers/create` again after pulling the image.
- `/containers/(id)/start` to start the container.
2023-06-26 09:42:50 -04:00
- `/containers/(id)/attach` to attach to the container when starting with the `-it` flags for interactive containers.
