2014-08-20 11:10:42 +10:00
% DOCKER(1) Docker User Manuals
% Docker Community
% JUNE 2014
# NAME
docker-create - Create a new container
# SYNOPSIS
**docker create**
[**-a**|**--attach**[=*[]*]]
2014-09-25 16:07:55 +10:00
[**--add-host**[=*[]*]]
2014-08-20 11:10:42 +10:00
[**-c**|**--cpu-shares**[=*0*]]
[**--cap-add**[=*[]*]]
[**--cap-drop**[=*[]*]]
[**--cidfile**[=*CIDFILE*]]
[**--cpuset**[=*CPUSET*]]
[**--device**[=*[]*]]
[**--dns-search**[=*[]*]]
[**--dns**[=*[]*]]
[**-e**|**--env**[=*[]*]]
[**--entrypoint**[=*ENTRYPOINT*]]
[**--env-file**[=*[]*]]
[**--expose**[=*[]*]]
[**-h**|**--hostname**[=*HOSTNAME*]]
2014-10-15 17:14:12 -04:00
[**--help**]
2014-08-20 11:10:42 +10:00
[**-i**|**--interactive**[=*false*]]
2014-11-28 14:21:55 +10:00
[**--ipc**[=*IPC*]]
2014-08-20 11:10:42 +10:00
[**--link**[=*[]*]]
[**--lxc-conf**[=*[]*]]
[**-m**|**--memory**[=*MEMORY*]]
2014-11-28 14:21:55 +10:00
[**--mac-address**[=*MAC-ADDRESS*]]
2014-08-20 11:10:42 +10:00
[**--name**[=*NAME*]]
[**--net**[=*"bridge"*]]
[**-P**|**--publish-all**[=*false*]]
[**-p**|**--publish**[=*[]*]]
2014-11-25 15:10:53 -05:00
[**--pid**[=*[]*]]
2014-08-20 11:10:42 +10:00
[**--privileged**[=*false*]]
2015-01-13 13:52:51 -08:00
[**--read-only**[=*false*]]
2014-09-25 16:07:55 +10:00
[**--restart**[=*RESTART*]]
2014-11-28 14:21:55 +10:00
[**--security-opt**[=*[]*]]
2014-08-20 11:10:42 +10:00
[**-t**|**--tty**[=*false*]]
[**-u**|**--user**[=*USER*]]
[**-v**|**--volume**[=*[]*]]
[**--volumes-from**[=*[]*]]
[**-w**|**--workdir**[=*WORKDIR*]]
2014-11-28 14:21:55 +10:00
IMAGE [COMMAND] [ARG...]
2014-08-20 11:10:42 +10:00
# OPTIONS
**-a**, ** --attach**=[]
Attach to STDIN, STDOUT or STDERR.
2014-09-25 16:07:55 +10:00
**--add-host**=[]
Add a custom host-to-IP mapping (host:ip)
2014-08-20 11:10:42 +10:00
**-c**, ** --cpu-shares**=0
CPU shares (relative weight)
**--cap-add**=[]
Add Linux capabilities
**--cap-drop**=[]
Drop Linux capabilities
**--cidfile**=""
Write the container ID to the file
**--cpuset**=""
CPUs in which to allow execution (0-3, 0,1)
**--device**=[]
2014-10-08 13:10:31 +10:00
Add a host device to the container (e.g. --device=/dev/sdc:/dev/xvdc:rwm)
2014-08-20 11:10:42 +10:00
**--dns-search**=[]
2014-10-29 17:17:02 +08:00
Set custom DNS search domains (Use --dns-search=. if you don't wish to set the search domain)
2014-08-20 11:10:42 +10:00
**--dns**=[]
Set custom DNS servers
**-e**, ** --env**=[]
Set environment variables
**--entrypoint**=""
Overwrite the default ENTRYPOINT of the image
**--env-file**=[]
Read in a line delimited file of environment variables
**--expose**=[]
2014-09-17 01:08:30 +00:00
Expose a port or a range of ports (e.g. --expose=3300-3310) from the container without publishing it to your host
2014-08-20 11:10:42 +10:00
**-h**, ** --hostname**=""
Container host name
2014-10-15 17:14:12 -04:00
**--help**
Print usage statement
2014-08-20 11:10:42 +10:00
**-i**, ** --interactive**=*true*|*false*
Keep STDIN open even if not attached. The default is *false* .
2014-11-28 14:21:55 +10:00
**--ipc**=""
Default is to create a private IPC namespace (POSIX SysV IPC) for the container
'container:< name | id > ': reuses another container shared memory, semaphores and message queues
'host': use the host shared memory,semaphores and message queues inside the container. Note: the host mode gives the container full access to local shared memory and is therefore considered insecure.
2014-08-20 11:10:42 +10:00
**--link**=[]
2015-01-19 09:57:44 +08:00
Add link to another container in the form of < name or id > :alias
2014-08-20 11:10:42 +10:00
**--lxc-conf**=[]
(lxc exec-driver only) Add custom lxc options --lxc-conf="lxc.cgroup.cpuset.cpus = 0,1"
**-m**, ** --memory**=""
Memory limit (format: < number > < optional unit > , where unit = b, k, m or g)
2014-11-28 14:21:55 +10:00
**--mac-address**=""
Container MAC address (e.g. 92:d0:c6:0a:29:33)
2014-08-20 11:10:42 +10:00
**--name**=""
Assign a name to the container
**--net**="bridge"
Set the Network mode for the container
'bridge': creates a new network stack for the container on the docker bridge
'none': no networking for this container
'container:< name | id > ': reuses another container network stack
'host': use the host network stack inside the container. Note: the host mode gives the container full access to local system services such as D-bus and is therefore considered insecure.
**-P**, ** --publish-all**=*true*|*false*
2015-01-06 17:01:10 +10:00
Publish all exposed ports to random ports on the host interfaces. The default is *false* .
2014-08-20 11:10:42 +10:00
**-p**, ** --publish**=[]
2014-11-03 18:15:55 +00:00
Publish a container's port, or a range of ports, to the host
2014-09-25 16:07:55 +10:00
format: ip:hostPort:containerPort | ip::containerPort | hostPort:containerPort | containerPort
2014-11-03 18:15:55 +00:00
Both hostPort and containerPort can be specified as a range of ports.
When specifying ranges for both, the number of container ports in the range must match the number of host ports in the range. (e.g., `-p 1234-1236:1234-1236/tcp` )
2014-08-20 11:10:42 +10:00
(use 'docker port' to see the actual mapping)
2014-11-25 15:10:53 -05:00
**--pid**=host
Set the PID mode for the container
**host** : use the host's PID namespace inside the container.
Note: the host mode gives the container full access to local PID and is therefore considered insecure.
2014-08-20 11:10:42 +10:00
**--privileged**=*true*|*false*
Give extended privileges to this container. The default is *false* .
2015-01-13 13:52:51 -08:00
**--read-only**=*true*|*false*
Mount the container's root filesystem as read only.
2014-09-25 16:07:55 +10:00
**--restart**=""
Restart policy to apply when a container exits (no, on-failure[:max-retry], always)
2014-11-28 14:21:55 +10:00
**--security-opt**=[]
Security Options
2014-08-20 11:10:42 +10:00
**-t**, ** --tty**=*true*|*false*
Allocate a pseudo-TTY. The default is *false* .
**-u**, ** --user**=""
Username or UID
**-v**, ** --volume**=[]
Bind mount a volume (e.g., from the host: -v /host:/container, from Docker: -v /container)
**--volumes-from**=[]
Mount volumes from the specified container(s)
**-w**, ** --workdir**=""
Working directory inside the container
# HISTORY
August 2014, updated by Sven Dowideit < SvenDowideit @home .org.au >
2014-09-25 16:07:55 +10:00
September 2014, updated by Sven Dowideit < SvenDowideit @home .org.au >
2014-11-28 14:21:55 +10:00
November 2014, updated by Sven Dowideit < SvenDowideit @home .org.au >