2014-09-16 06:43:43 +00:00
% DOCKER(1) Docker User Manuals
% Docker Community
2014-11-28 04:21:55 +00:00
% JUNE 2014
2014-09-16 06:43:43 +00:00
# NAME
2014-09-17 18:36:51 +00:00
docker-exec - Run a command in a running container
2014-09-16 06:43:43 +00:00
# SYNOPSIS
**docker exec**
2015-12-23 14:37:06 +00:00
[**-d**|**--detach**]
2016-01-03 22:03:39 +00:00
[**--detach-keys**[=*[]*]]
2016-07-13 17:24:41 +00:00
[**-e**|**--env**[=*[]*]]
2014-10-15 21:14:12 +00:00
[**--help**]
2015-12-23 14:37:06 +00:00
[**-i**|**--interactive**]
[**--privileged**]
[**-t**|**--tty**]
2015-04-11 03:04:24 +00:00
[**-u**|**--user**[=*USER*]]
2014-11-28 04:21:55 +00:00
CONTAINER COMMAND [ARG...]
2014-09-16 06:43:43 +00:00
# DESCRIPTION
2015-06-22 03:06:07 +00:00
Run a process in a running container.
2014-09-16 06:43:43 +00:00
2014-11-11 05:54:31 +00:00
The command started using `docker exec` will only run while the container's primary
process (`PID 1`) is running, and will not be restarted if the container is restarted.
If the container is paused, then the `docker exec` command will wait until the
2014-11-28 04:21:55 +00:00
container is unpaused, and then run
2014-09-16 06:43:43 +00:00
2014-11-28 04:21:55 +00:00
# OPTIONS
2014-09-16 06:43:43 +00:00
**-d**, ** --detach**=*true*|*false*
2016-02-17 03:55:56 +00:00
Detached mode: run command in the background. The default is *false* .
2016-01-03 22:03:39 +00:00
**--detach-keys**=""
2016-02-17 03:55:56 +00:00
Override the key sequence for detaching a container. Format is a single character `[a-Z]` or `ctrl-<value>` where `<value>` is one of: `a-z` , `@` , `^` , `[` , `,` or `_` .
2014-09-16 06:43:43 +00:00
2016-07-13 17:24:41 +00:00
**-e**, ** --env**=[]
Set environment variables
This option allows you to specify arbitrary environment variables that are
available for the command to be executed.
2014-10-15 21:14:12 +00:00
**--help**
Print usage statement
2014-09-16 06:43:43 +00:00
**-i**, ** --interactive**=*true*|*false*
2014-11-28 04:21:55 +00:00
Keep STDIN open even if not attached. The default is *false* .
2014-09-16 06:43:43 +00:00
2015-06-19 06:01:50 +00:00
**--privileged**=*true*|*false*
2015-06-22 03:06:07 +00:00
Give the process extended [Linux capabilities ](http://man7.org/linux/man-pages/man7/capabilities.7.html )
when running in a container. The default is *false* .
2015-06-19 06:01:50 +00:00
2015-06-22 03:06:07 +00:00
Without this flag, the process run by `docker exec` in a running container has
the same capabilities as the container, which may be limited. Set
`--privileged` to give all capabilities to the process.
2015-06-19 06:01:50 +00:00
2014-09-16 06:43:43 +00:00
**-t**, ** --tty**=*true*|*false*
2014-11-28 04:21:55 +00:00
Allocate a pseudo-TTY. The default is *false* .
2015-04-11 03:04:24 +00:00
**-u**, ** --user**=""
Sets the username or UID used and optionally the groupname or GID for the specified command.
The followings examples are all valid:
--user [user | user:group | uid | uid:gid | user:gid | uid:group ]
Without this argument the command will be run as root in the container.
2014-12-06 00:50:56 +00:00
The ** -t** option is incompatible with a redirection of the docker client
standard input.
2014-11-28 04:21:55 +00:00
# HISTORY
November 2014, updated by Sven Dowideit < SvenDowideit @ home . org . au >