0a0dd116 |
% DOCKER(1) Docker User Manuals
% William Henry
% APRIL 2014
# NAME
docker \- Docker image and container command line interface
# SYNOPSIS
**docker** [OPTIONS] COMMAND [arg...]
|
fada260a |
**docker** daemon [ --help | ... ]
**docker** [ --help | -v | --version ]
|
0a0dd116 |
# DESCRIPTION
**docker** has two distinct functions. It is used for starting the Docker
daemon and to run the CLI (i.e., to command the daemon to manage images, |
cb92c471 |
containers etc.) So **docker** is both a server, as a daemon, and a client |
0a0dd116 |
to the daemon, through the CLI.
|
fada260a |
To run the Docker daemon you can specify **docker daemon**.
You can view the daemon options using **docker daemon --help**.
To see the man page for the daemon, run **man docker daemon**. |
0a0dd116 |
The Docker CLI has over 30 commands. The commands are listed below and each has |
cb92c471 |
its own man page which explain usage and arguments. |
0a0dd116 |
To see the man page for a command run **man docker <command>**.
# OPTIONS |
ceb11d96 |
**--help** |
a2b529ea |
Print usage statement
|
daced1d3 |
**--config**=""
Specifies the location of the Docker client configuration files. The default is '~/.docker'.
|
fa1fa501 |
**-D**, **--debug**=*true*|*false*
Enable debug mode. Default is false.
|
50f09060 |
**-H**, **--host**=[unix:///var/run/docker.sock]: tcp://[host]:[port][path] to bind or |
fa1fa501 |
unix://[/path/to/socket] to use.
The socket(s) to bind to in daemon mode specified using one or more |
50f09060 |
tcp://host:port/path, unix:///path/to/socket, fd://* or fd://socketfd.
If the tcp port is not specified, then it will default to either `2375` when
`--tls` is off, or `2376` when `--tls` is on, or `--tlsverify` is specified. |
fa1fa501 |
|
ed13110e |
**-l**, **--log-level**="*debug*|*info*|*warn*|*error*|*fatal*"" |
2facc046 |
Set the logging level. Default is `info`.
|
f3bea61c |
**--tls**=*true*|*false* |
fa1fa501 |
Use TLS; implied by --tlsverify. Default is false.
|
f3bea61c |
**--tlscacert**=~/.docker/ca.pem
Trust certs signed only by this CA.
**--tlscert**=~/.docker/cert.pem
Path to TLS certificate file.
**--tlskey**=~/.docker/key.pem
Path to TLS key file.
**--tlsverify**=*true*|*false* |
fa1fa501 |
Use TLS and verify the remote (daemon: verify client, client: verify daemon).
Default is false.
**-v**, **--version**=*true*|*false* |
0a0dd116 |
Print version information and quit. Default is false.
# COMMANDS |
29f379ea |
**attach** |
0a0dd116 |
Attach to a running container |
29f379ea |
See **docker-attach(1)** for full documentation on the **attach** command. |
0a0dd116 |
|
29f379ea |
**build** |
a0505edc |
Build an image from a Dockerfile |
29f379ea |
See **docker-build(1)** for full documentation on the **build** command. |
0a0dd116 |
|
29f379ea |
**commit** |
0a0dd116 |
Create a new image from a container's changes |
29f379ea |
See **docker-commit(1)** for full documentation on the **commit** command. |
0a0dd116 |
|
29f379ea |
**cp** |
ee6b81fa |
Copy files/folders between a container and the local filesystem |
29f379ea |
See **docker-cp(1)** for full documentation on the **cp** command. |
0a0dd116 |
|
29f379ea |
**create** |
22eb3a3a |
Create a new container |
29f379ea |
See **docker-create(1)** for full documentation on the **create** command. |
22eb3a3a |
|
29f379ea |
**diff** |
0a0dd116 |
Inspect changes on a container's filesystem |
29f379ea |
See **docker-diff(1)** for full documentation on the **diff** command. |
0a0dd116 |
|
29f379ea |
**events** |
0a0dd116 |
Get real time events from the server |
29f379ea |
See **docker-events(1)** for full documentation on the **events** command. |
0a0dd116 |
|
29f379ea |
**exec** |
021ecb1d |
Run a command in a running container |
29f379ea |
See **docker-exec(1)** for full documentation on the **exec** command. |
fc75ade4 |
|
29f379ea |
**export** |
0a0dd116 |
Stream the contents of a container as a tar archive |
29f379ea |
See **docker-export(1)** for full documentation on the **export** command. |
0a0dd116 |
|
29f379ea |
**history** |
0a0dd116 |
Show the history of an image |
29f379ea |
See **docker-history(1)** for full documentation on the **history** command. |
0a0dd116 |
|
29f379ea |
**images** |
0a0dd116 |
List images |
29f379ea |
See **docker-images(1)** for full documentation on the **images** command. |
0a0dd116 |
|
29f379ea |
**import** |
0a0dd116 |
Create a new filesystem image from the contents of a tarball |
29f379ea |
See **docker-import(1)** for full documentation on the **import** command. |
0a0dd116 |
|
29f379ea |
**info** |
0a0dd116 |
Display system-wide information |
29f379ea |
See **docker-info(1)** for full documentation on the **info** command. |
0a0dd116 |
|
29f379ea |
**inspect** |
471006c0 |
Return low-level information on a container or image |
29f379ea |
See **docker-inspect(1)** for full documentation on the **inspect** command. |
0a0dd116 |
|
29f379ea |
**kill** |
0a0dd116 |
Kill a running container (which includes the wrapper process and everything
inside it) |
29f379ea |
See **docker-kill(1)** for full documentation on the **kill** command. |
0a0dd116 |
|
29f379ea |
**load** |
0a0dd116 |
Load an image from a tar archive |
29f379ea |
See **docker-load(1)** for full documentation on the **load** command. |
0a0dd116 |
|
29f379ea |
**login** |
7b2b7df3 |
Register or login to a Docker Registry |
29f379ea |
See **docker-login(1)** for full documentation on the **login** command. |
0a0dd116 |
|
29f379ea |
**logout** |
7b2b7df3 |
Log the user out of a Docker Registry |
29f379ea |
See **docker-logout(1)** for full documentation on the **logout** command. |
06bc4e07 |
|
29f379ea |
**logs** |
0a0dd116 |
Fetch the logs of a container |
29f379ea |
See **docker-logs(1)** for full documentation on the **logs** command. |
0a0dd116 |
|
29f379ea |
**pause** |
b07f1938 |
Pause all processes within a container |
29f379ea |
See **docker-pause(1)** for full documentation on the **pause** command. |
b07f1938 |
|
29f379ea |
**port** |
0a0dd116 |
Lookup the public-facing port which is NAT-ed to PRIVATE_PORT |
29f379ea |
See **docker-port(1)** for full documentation on the **port** command. |
0a0dd116 |
|
29f379ea |
**ps** |
0a0dd116 |
List containers |
29f379ea |
See **docker-ps(1)** for full documentation on the **ps** command. |
0a0dd116 |
|
29f379ea |
**pull** |
7b2b7df3 |
Pull an image or a repository from a Docker Registry |
29f379ea |
See **docker-pull(1)** for full documentation on the **pull** command. |
0a0dd116 |
|
29f379ea |
**push** |
7b2b7df3 |
Push an image or a repository to a Docker Registry |
29f379ea |
See **docker-push(1)** for full documentation on the **push** command. |
0a0dd116 |
|
f3bea61c |
**rename**
Rename a container.
See **docker-rename(1)** for full documentation on the **rename** command.
|
29f379ea |
**restart** |
e4175367 |
Restart a container |
29f379ea |
See **docker-restart(1)** for full documentation on the **restart** command. |
0a0dd116 |
|
29f379ea |
**rm** |
0a0dd116 |
Remove one or more containers |
29f379ea |
See **docker-rm(1)** for full documentation on the **rm** command. |
0a0dd116 |
|
29f379ea |
**rmi** |
0a0dd116 |
Remove one or more images |
29f379ea |
See **docker-rmi(1)** for full documentation on the **rmi** command. |
0a0dd116 |
|
29f379ea |
**run** |
0a0dd116 |
Run a command in a new container |
29f379ea |
See **docker-run(1)** for full documentation on the **run** command. |
0a0dd116 |
|
29f379ea |
**save** |
0a0dd116 |
Save an image to a tar archive |
29f379ea |
See **docker-save(1)** for full documentation on the **save** command. |
0a0dd116 |
|
29f379ea |
**search** |
0a0dd116 |
Search for an image in the Docker index |
29f379ea |
See **docker-search(1)** for full documentation on the **search** command. |
0a0dd116 |
|
29f379ea |
**start** |
14e88986 |
Start a container |
29f379ea |
See **docker-start(1)** for full documentation on the **start** command. |
0a0dd116 |
|
29f379ea |
**stats** |
fa1fa501 |
Display a live stream of one or more containers' resource usage statistics |
29f379ea |
See **docker-stats(1)** for full documentation on the **stats** command. |
fa1fa501 |
|
29f379ea |
**stop** |
14e88986 |
Stop a container |
29f379ea |
See **docker-stop(1)** for full documentation on the **stop** command. |
0a0dd116 |
|
29f379ea |
**tag** |
0a0dd116 |
Tag an image into a repository |
29f379ea |
See **docker-tag(1)** for full documentation on the **tag** command. |
0a0dd116 |
|
29f379ea |
**top** |
0a0dd116 |
Lookup the running processes of a container |
29f379ea |
See **docker-top(1)** for full documentation on the **top** command. |
0a0dd116 |
|
29f379ea |
**unpause** |
b07f1938 |
Unpause all processes within a container |
29f379ea |
See **docker-unpause(1)** for full documentation on the **unpause** command. |
b07f1938 |
|
29f379ea |
**version** |
0a0dd116 |
Show the Docker version information |
29f379ea |
See **docker-version(1)** for full documentation on the **version** command. |
0a0dd116 |
|
29f379ea |
**wait** |
0a0dd116 |
Block until a container stops, then print its exit code |
29f379ea |
See **docker-wait(1)** for full documentation on the **wait** command. |
0a0dd116 |
|
d4bbbe58 |
# EXEC DRIVER OPTIONS
|
2afcd102 |
Use the **--exec-opt** flags to specify options to the exec-driver. The only
driver that accepts this flag is the *native* (libcontainer) driver. As a
result, you must also specify **-s=**native for this option to have effect. The
following is the only *native* option: |
d4bbbe58 |
#### native.cgroupdriver |
2afcd102 |
Specifies the management of the container's `cgroups`. You can specify
`cgroupfs` or `systemd`. If you specify `systemd` and it is not available, the
system uses `cgroupfs`. |
d4bbbe58 |
|
aa00ad47 |
#### Client |
a74c1217 |
For specific client examples please see the man page for the specific Docker
command. For example: |
0a0dd116 |
|
811132f4 |
man docker-run |
0a0dd116 |
# HISTORY |
aa00ad47 |
April 2014, Originally compiled by William Henry (whenry at redhat dot com) based on docker.com source material and internal work. |