docker container run
Description
Run a command in a new container
Usage
docker container run [OPTIONS] IMAGE [COMMAND] [ARG...]
Options
Name, shorthand | Default | Description |
--add-host |
Add a custom host-to-IP mapping (host:ip) | |
--attach , -a |
Attach to STDIN, STDOUT or STDERR | |
--blkio-weight |
Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0) | |
--blkio-weight-device |
Block IO weight (relative device weight) | |
--cap-add |
Add Linux capabilities | |
--cap-drop |
Drop Linux capabilities | |
--cgroup-parent |
Optional parent cgroup for the container | |
--cidfile |
Write the container ID to the file | |
--cpu-count |
CPU count (Windows only) | |
--cpu-percent |
CPU percent (Windows only) | |
--cpu-period |
Limit CPU CFS (Completely Fair Scheduler) period | |
--cpu-quota |
Limit CPU CFS (Completely Fair Scheduler) quota | |
--cpu-rt-period |
API 1.25+ Limit CPU real-time period in microseconds |
|
--cpu-rt-runtime |
API 1.25+ Limit CPU real-time runtime in microseconds |
|
--cpu-shares , -c |
CPU shares (relative weight) | |
--cpus |
API 1.25+ Number of CPUs |
|
--cpuset-cpus |
CPUs in which to allow execution (0-3, 0,1) | |
--cpuset-mems |
MEMs in which to allow execution (0-3, 0,1) | |
--detach , -d |
Run container in background and print container ID | |
--detach-keys |
Override the key sequence for detaching a container | |
--device |
Add a host device to the container | |
--device-cgroup-rule |
Add a rule to the cgroup allowed devices list | |
--device-read-bps |
Limit read rate (bytes per second) from a device | |
--device-read-iops |
Limit read rate (IO per second) from a device | |
--device-write-bps |
Limit write rate (bytes per second) to a device | |
--device-write-iops |
Limit write rate (IO per second) to a device | |
--disable-content-trust |
true |
Skip image verification |
--dns |
Set custom DNS servers | |
--dns-opt |
Set DNS options | |
--dns-option |
Set DNS options | |
--dns-search |
Set custom DNS search domains | |
--domainname |
Container NIS domain name | |
--entrypoint |
Overwrite the default ENTRYPOINT of the image | |
--env , -e |
Set environment variables | |
--env-file |
Read in a file of environment variables | |
--expose |
Expose a port or a range of ports | |
--gpus |
API 1.40+ GPU devices to add to the container (‘all’ to pass all GPUs) |
|
--group-add |
Add additional groups to join | |
--health-cmd |
Command to run to check health | |
--health-interval |
Time between running the check (ms|s|m|h) (default 0s) | |
--health-retries |
Consecutive failures needed to report unhealthy | |
--health-start-period |
API 1.29+ Start period for the container to initialize before starting health-retries countdown (ms|s|m|h) (default 0s) |
|
--health-timeout |
Maximum time to allow one check to run (ms|s|m|h) (default 0s) | |
--help |
Print usage | |
--hostname , -h |
Container host name | |
--init |
API 1.25+ Run an init inside the container that forwards signals and reaps processes |
|
--interactive , -i |
Keep STDIN open even if not attached | |
--io-maxbandwidth |
Maximum IO bandwidth limit for the system drive (Windows only) | |
--io-maxiops |
Maximum IOps limit for the system drive (Windows only) | |
--ip |
IPv4 address (e.g., 172.30.100.104) | |
--ip6 |
IPv6 address (e.g., 2001:db8::33) | |
--ipc |
IPC mode to use | |
--isolation |
Container isolation technology | |
--kernel-memory |
Kernel memory limit | |
--label , -l |
Set meta data on a container | |
--label-file |
Read in a line delimited file of labels | |
--link |
Add link to another container | |
--link-local-ip |
Container IPv4/IPv6 link-local addresses | |
--log-driver |
Logging driver for the container | |
--log-opt |
Log driver options | |
--mac-address |
Container MAC address (e.g., 92:d0:c6:0a:29:33) | |
--memory , -m |
Memory limit | |
--memory-reservation |
Memory soft limit | |
--memory-swap |
Swap limit equal to memory plus swap: ‘-1’ to enable unlimited swap | |
--memory-swappiness |
-1 |
Tune container memory swappiness (0 to 100) |
--mount |
Attach a filesystem mount to the container | |
--name |
Assign a name to the container | |
--net |
Connect a container to a network | |
--net-alias |
Add network-scoped alias for the container | |
--network |
Connect a container to a network | |
--network-alias |
Add network-scoped alias for the container | |
--no-healthcheck |
Disable any container-specified HEALTHCHECK | |
--oom-kill-disable |
Disable OOM Killer | |
--oom-score-adj |
Tune host’s OOM preferences (-1000 to 1000) | |
--pid |
PID namespace to use | |
--pids-limit |
Tune container pids limit (set -1 for unlimited) | |
--platform |
experimental (daemon)API 1.32+ Set platform if server is multi-platform capable |
|
--privileged |
Give extended privileges to this container | |
--publish , -p |
Publish a container’s port(s) to the host | |
--publish-all , -P |
Publish all exposed ports to random ports | |
--read-only |
Mount the container’s root filesystem as read only | |
--restart |
no |
Restart policy to apply when a container exits |
--rm |
Automatically remove the container when it exits | |
--runtime |
Runtime to use for this container | |
--security-opt |
Security Options | |
--shm-size |
Size of /dev/shm | |
--sig-proxy |
true |
Proxy received signals to the process |
--stop-signal |
SIGTERM |
Signal to stop a container |
--stop-timeout |
API 1.25+ Timeout (in seconds) to stop a container |
|
--storage-opt |
Storage driver options for the container | |
--sysctl |
Sysctl options | |
--tmpfs |
Mount a tmpfs directory | |
--tty , -t |
Allocate a pseudo-TTY | |
--ulimit |
Ulimit options | |
--user , -u |
Username or UID (format: <name|uid>[:<group|gid>]) | |
--userns |
User namespace to use | |
--uts |
UTS namespace to use | |
--volume , -v |
Bind mount a volume | |
--volume-driver |
Optional volume driver for the container | |
--volumes-from |
Mount volumes from the specified container(s) | |
--workdir , -w |
Working directory inside the container |
Parent command
Command | Description |
---|---|
docker container | Manage containers |
Related commands
Command | Description |
docker container attach | Attach local standard input, output, and error streams to a running container |
docker container commit | Create a new image from a container’s changes |
docker container cp | Copy files/folders between a container and the local filesystem |
docker container create | Create a new container |
docker container diff | Inspect changes to files or directories on a container’s filesystem |
docker container exec | Run a command in a running container |
docker container export | Export a container’s filesystem as a tar archive |
docker container inspect | Display detailed information on one or more containers |
docker container kill | Kill one or more running containers |
docker container logs | Fetch the logs of a container |
docker container ls | List containers |
docker container pause | Pause all processes within one or more containers |
docker container port | List port mappings or a specific mapping for the container |
docker container prune | Remove all stopped containers |
docker container rename | Rename a container |
docker container restart | Restart one or more containers |
docker container rm | Remove one or more containers |
docker container run | Run a command in a new container |
docker container start | Start one or more stopped containers |
docker container stats | Display a live stream of container(s) resource usage statistics |
docker container stop | Stop one or more running containers |
docker container top | Display the running processes of a container |
docker container unpause | Unpause all processes within one or more containers |
docker container update | Update configuration of one or more containers |
docker container wait | Block until one or more containers stop, then print their exit codes |