mirror of
https://github.com/moby/moby.git
synced 2022-11-09 12:21:53 -05:00
Updating with man pages for distribution
Went through the man pages to update for the v2 instance. Checked against the commands. Signed-off-by: Mary Anthony <mary@docker.com>
This commit is contained in:
parent
b9be50b578
commit
b6d55ebcbc
9 changed files with 76 additions and 48 deletions
|
@ -8,7 +8,7 @@ MAINTAINER Sven Dowideit <SvenDowideit@docker.com> (@SvenDowideit)
|
||||||
COPY . /src
|
COPY . /src
|
||||||
|
|
||||||
# Reset the /docs dir so we can replace the theme meta with the new repo's git info
|
# Reset the /docs dir so we can replace the theme meta with the new repo's git info
|
||||||
RUN git reset --hard
|
# RUN git reset --hard
|
||||||
|
|
||||||
# Then copy the desired docs into the /docs/sources/ dir
|
# Then copy the desired docs into the /docs/sources/ dir
|
||||||
COPY ./sources/ /docs/sources
|
COPY ./sources/ /docs/sources
|
||||||
|
@ -23,6 +23,20 @@ COPY ./mkdocs.yml mkdocs.yml
|
||||||
COPY ./s3_website.json s3_website.json
|
COPY ./s3_website.json s3_website.json
|
||||||
COPY ./release.sh release.sh
|
COPY ./release.sh release.sh
|
||||||
|
|
||||||
|
|
||||||
|
# Docker Distribution
|
||||||
|
#ADD https://raw.githubusercontent.com/moxiegirl/distribution/doc-tooling-changes/docs/mkdocs.yml /docs/mkdocs-distribution.yml
|
||||||
|
|
||||||
|
ADD https://raw.githubusercontent.com/moxiegirl/distribution/doc-tooling-changes/docs/overview.md /docs/sources/distribution/overview.md
|
||||||
|
RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/distribution/overview.md
|
||||||
|
|
||||||
|
ADD https://raw.githubusercontent.com/moxiegirl/distribution/doc-tooling-changes/docs/install.md /docs/sources/distribution/install.md
|
||||||
|
RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/distribution/install.md
|
||||||
|
|
||||||
|
ADD https://raw.githubusercontent.com/moxiegirl/distribution/doc-tooling-changes/docs/architecture.md /docs/sources/distribution/architecture.md
|
||||||
|
RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/distribution/architecture.md
|
||||||
|
|
||||||
|
|
||||||
# Docker Swarm
|
# Docker Swarm
|
||||||
#ADD https://raw.githubusercontent.com/docker/swarm/master/docs/mkdocs.yml /docs/mkdocs-swarm.yml
|
#ADD https://raw.githubusercontent.com/docker/swarm/master/docs/mkdocs.yml /docs/mkdocs-swarm.yml
|
||||||
ADD https://raw.githubusercontent.com/docker/swarm/master/docs/index.md /docs/sources/swarm/index.md
|
ADD https://raw.githubusercontent.com/docker/swarm/master/docs/index.md /docs/sources/swarm/index.md
|
||||||
|
|
|
@ -2,7 +2,7 @@
|
||||||
% Docker Community
|
% Docker Community
|
||||||
% JUNE 2014
|
% JUNE 2014
|
||||||
# NAME
|
# NAME
|
||||||
docker-login - Register or log in to a Docker registry server, if no server is specified "https://index.docker.io/v1/" is the default.
|
docker-login - Register or log in to a Docker registry.
|
||||||
|
|
||||||
# SYNOPSIS
|
# SYNOPSIS
|
||||||
**docker login**
|
**docker login**
|
||||||
|
@ -13,12 +13,14 @@ docker-login - Register or log in to a Docker registry server, if no server is s
|
||||||
[SERVER]
|
[SERVER]
|
||||||
|
|
||||||
# DESCRIPTION
|
# DESCRIPTION
|
||||||
Register or Login to a docker registry server, if no server is
|
Register or log in to a Docker Registry Service located on the specified
|
||||||
specified "https://index.docker.io/v1/" is the default. If you want to
|
`SERVER`. You can specify a URL or a `hostname` for the `SERVER` value. If you
|
||||||
login to a private registry you can specify this by adding the server name.
|
do not specify a `SERVER`, the command uses Docker's public registry located at
|
||||||
|
`https://registry-1.docker.io/` by default. To get a username/password for Docker's public registry, create an account on Docker Hub.
|
||||||
|
|
||||||
This stores encoded credentials in `$HOME/.dockercfg` on Linux or `%USERPROFILE%/.dockercfg`
|
You can log into any public or private repository for which you have
|
||||||
on Windows.
|
credentials. When you log in, the command stores encoded credentials in
|
||||||
|
`$HOME/.dockercfg` on Linux or `%USERPROFILE%/.dockercfg` on Windows.
|
||||||
|
|
||||||
# OPTIONS
|
# OPTIONS
|
||||||
**-e**, **--email**=""
|
**-e**, **--email**=""
|
||||||
|
@ -35,7 +37,7 @@ on Windows.
|
||||||
|
|
||||||
# EXAMPLES
|
# EXAMPLES
|
||||||
|
|
||||||
## Login to a local registry
|
## Login to a registry on your localhost
|
||||||
|
|
||||||
# docker login localhost:8080
|
# docker login localhost:8080
|
||||||
|
|
||||||
|
@ -46,3 +48,4 @@ on Windows.
|
||||||
April 2014, Originally compiled by William Henry (whenry at redhat dot com)
|
April 2014, Originally compiled by William Henry (whenry at redhat dot com)
|
||||||
based on docker.com source material and internal work.
|
based on docker.com source material and internal work.
|
||||||
June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
|
June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
|
||||||
|
April 2015, updated by Mary Anthony for v2 <mary@docker.com>
|
||||||
|
|
|
@ -2,23 +2,24 @@
|
||||||
% Docker Community
|
% Docker Community
|
||||||
% JUNE 2014
|
% JUNE 2014
|
||||||
# NAME
|
# NAME
|
||||||
docker-logout - Log out from a Docker registry, if no server is specified "https://index.docker.io/v1/" is the default.
|
docker-logout - Log out from a Docker Registry Service.
|
||||||
|
|
||||||
# SYNOPSIS
|
# SYNOPSIS
|
||||||
**docker logout**
|
**docker logout**
|
||||||
[SERVER]
|
[SERVER]
|
||||||
|
|
||||||
# DESCRIPTION
|
# DESCRIPTION
|
||||||
Log the user out from a Docker registry, if no server is
|
Log out of a Docker Registry Service located on the specified `SERVER`. You can
|
||||||
specified "https://index.docker.io/v1/" is the default. If you want to
|
specify a URL or a `hostname` for the `SERVER` value. If you do not specify a
|
||||||
log out from a private registry you can specify this by adding the server name.
|
`SERVER`, the command attempts to log you out of Docker's public registry
|
||||||
|
located at `https://registry-1.docker.io/` by default.
|
||||||
|
|
||||||
# OPTIONS
|
# OPTIONS
|
||||||
There are no available options.
|
There are no available options.
|
||||||
|
|
||||||
# EXAMPLES
|
# EXAMPLES
|
||||||
|
|
||||||
## Log out from a local registry
|
## Log out from a registry on your localhost
|
||||||
|
|
||||||
# docker logout localhost:8080
|
# docker logout localhost:8080
|
||||||
|
|
||||||
|
@ -28,3 +29,4 @@ There are no available options.
|
||||||
# HISTORY
|
# HISTORY
|
||||||
June 2014, Originally compiled by Daniel, Dao Quang Minh (daniel at nitrous dot io)
|
June 2014, Originally compiled by Daniel, Dao Quang Minh (daniel at nitrous dot io)
|
||||||
July 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
|
July 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
|
||||||
|
April 2015, updated by Mary Anthony for v2 <mary@docker.com>
|
||||||
|
|
|
@ -2,7 +2,7 @@
|
||||||
% Docker Community
|
% Docker Community
|
||||||
% JUNE 2014
|
% JUNE 2014
|
||||||
# NAME
|
# NAME
|
||||||
docker-pull - Pull an image or a repository from the registry
|
docker-pull - Pull an image or a repository from a registry
|
||||||
|
|
||||||
# SYNOPSIS
|
# SYNOPSIS
|
||||||
**docker pull**
|
**docker pull**
|
||||||
|
@ -12,10 +12,12 @@ NAME[:TAG] | [REGISTRY_HOST[:REGISTRY_PORT]/]NAME[:TAG]
|
||||||
|
|
||||||
# DESCRIPTION
|
# DESCRIPTION
|
||||||
|
|
||||||
This command pulls down an image or a repository from the registry. If
|
This command pulls down an image or a repository from a registry. If
|
||||||
there is more than one image for a repository (e.g., fedora) then all
|
there is more than one image for a repository (e.g., fedora) then all
|
||||||
images for that repository name are pulled down including any tags.
|
images for that repository name are pulled down including any tags.
|
||||||
It is also possible to specify a non-default registry to pull from.
|
|
||||||
|
If you do not specify a `REGISTRY_HOST`, the command uses Docker's public
|
||||||
|
registry located at `registry-1.docker.io` by default.
|
||||||
|
|
||||||
# OPTIONS
|
# OPTIONS
|
||||||
**-a**, **--all-tags**=*true*|*false*
|
**-a**, **--all-tags**=*true*|*false*
|
||||||
|
@ -45,7 +47,7 @@ It is also possible to specify a non-default registry to pull from.
|
||||||
fedora heisenbug 105182bb5e8b 5 days ago 372.7 MB
|
fedora heisenbug 105182bb5e8b 5 days ago 372.7 MB
|
||||||
fedora latest 105182bb5e8b 5 days ago 372.7 MB
|
fedora latest 105182bb5e8b 5 days ago 372.7 MB
|
||||||
|
|
||||||
# Pull an image, manually specifying path to the registry and tag
|
# Pull an image, manually specifying path to Docker's public registry and tag
|
||||||
# Note that if the image is previously downloaded then the status would be
|
# Note that if the image is previously downloaded then the status would be
|
||||||
# 'Status: Image is up to date for registry.hub.docker.com/fedora:20'
|
# 'Status: Image is up to date for registry.hub.docker.com/fedora:20'
|
||||||
|
|
||||||
|
@ -68,3 +70,4 @@ based on docker.com source material and internal work.
|
||||||
June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
|
June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
|
||||||
August 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
|
August 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
|
||||||
April 2015, updated by John Willis <john.willis@docker.com>
|
April 2015, updated by John Willis <john.willis@docker.com>
|
||||||
|
April 2015, updated by Mary Anthony for v2 <mary@docker.com>
|
||||||
|
|
|
@ -2,18 +2,18 @@
|
||||||
% Docker Community
|
% Docker Community
|
||||||
% JUNE 2014
|
% JUNE 2014
|
||||||
# NAME
|
# NAME
|
||||||
docker-push - Push an image or a repository to the registry
|
docker-push - Push an image or a repository to a registry
|
||||||
|
|
||||||
# SYNOPSIS
|
# SYNOPSIS
|
||||||
**docker push**
|
**docker push**
|
||||||
[**--help**]
|
[**--help**]
|
||||||
NAME[:TAG]
|
NAME[:TAG] | [REGISTRY_HOST[:REGISTRY_PORT]/]NAME[:TAG]
|
||||||
|
|
||||||
# DESCRIPTION
|
# DESCRIPTION
|
||||||
Push an image or a repository to a registry. The default registry is the Docker
|
|
||||||
Hub located at [hub.docker.com](https://hub.docker.com/). However the
|
This command pushes an image or a repository to a registry. If you do not
|
||||||
image can be pushed to another, perhaps private, registry as demonstrated in
|
specify a `REGISTRY_HOST`, the command uses Docker's public registry located at
|
||||||
the example below.
|
`registry-1.docker.io` by default.
|
||||||
|
|
||||||
# OPTIONS
|
# OPTIONS
|
||||||
**--help**
|
**--help**
|
||||||
|
@ -28,12 +28,10 @@ and then committing it to a new image name:
|
||||||
|
|
||||||
# docker commit c16378f943fe rhel-httpd
|
# docker commit c16378f943fe rhel-httpd
|
||||||
|
|
||||||
Now push the image to the registry using the image ID. In this example
|
Now, push the image to the registry using the image ID. In this example the
|
||||||
the registry is on host named registry-host and listening on port 5000.
|
registry is on host named `registry-host` and listening on port `5000`. To do
|
||||||
Default Docker commands will push to the default `hub.docker.com`
|
this, tag the image with the host name or IP address, and the port of the
|
||||||
registry. Instead, push to the local registry, which is on a host called
|
registry:
|
||||||
registry-host*. To do this, tag the image with the host name or IP
|
|
||||||
address, and the port of the registry:
|
|
||||||
|
|
||||||
# docker tag rhel-httpd registry-host:5000/myadmin/rhel-httpd
|
# docker tag rhel-httpd registry-host:5000/myadmin/rhel-httpd
|
||||||
# docker push registry-host:5000/myadmin/rhel-httpd
|
# docker push registry-host:5000/myadmin/rhel-httpd
|
||||||
|
@ -49,3 +47,5 @@ listed.
|
||||||
April 2014, Originally compiled by William Henry (whenry at redhat dot com)
|
April 2014, Originally compiled by William Henry (whenry at redhat dot com)
|
||||||
based on docker.com source material and internal work.
|
based on docker.com source material and internal work.
|
||||||
June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
|
June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
|
||||||
|
April 2015, updated by Mary Anthony for v2 <mary@docker.com>
|
||||||
|
|
||||||
|
|
|
@ -13,10 +13,9 @@ IMAGE [IMAGE...]
|
||||||
|
|
||||||
# DESCRIPTION
|
# DESCRIPTION
|
||||||
|
|
||||||
This will remove one or more images from the host node. This does not
|
Removes one or more images from the host node. This does not remove images from
|
||||||
remove images from a registry. You cannot remove an image of a running
|
a registry. You cannot remove an image of a running container unless you use the
|
||||||
container unless you use the **-f** option. To see all images on a host
|
**-f** option. To see all images on a host use the **docker images** command.
|
||||||
use the **docker images** command.
|
|
||||||
|
|
||||||
# OPTIONS
|
# OPTIONS
|
||||||
**-f**, **--force**=*true*|*false*
|
**-f**, **--force**=*true*|*false*
|
||||||
|
@ -40,3 +39,4 @@ Here is an example of removing and image:
|
||||||
April 2014, Originally compiled by William Henry (whenry at redhat dot com)
|
April 2014, Originally compiled by William Henry (whenry at redhat dot com)
|
||||||
based on docker.com source material and internal work.
|
based on docker.com source material and internal work.
|
||||||
June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
|
June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
|
||||||
|
April 2015, updated by Mary Anthony for v2 <mary@docker.com>
|
||||||
|
|
|
@ -14,10 +14,9 @@ TERM
|
||||||
|
|
||||||
# DESCRIPTION
|
# DESCRIPTION
|
||||||
|
|
||||||
Search an index for an image with that matches the term TERM. The table
|
Search Docker Hub for an image with that matches the specified `TERM`. The table
|
||||||
of images returned displays the name, description (truncated by default),
|
of images returned displays the name, description (truncated by default), number
|
||||||
number of stars awarded, whether the image is official, and whether it
|
of stars awarded, whether the image is official, and whether it is automated.
|
||||||
is automated.
|
|
||||||
|
|
||||||
*Note* - Search queries will only return up to 25 results
|
*Note* - Search queries will only return up to 25 results
|
||||||
|
|
||||||
|
@ -36,9 +35,9 @@ is automated.
|
||||||
|
|
||||||
# EXAMPLES
|
# EXAMPLES
|
||||||
|
|
||||||
## Search the registry for ranked images
|
## Search Docker Hub for ranked images
|
||||||
|
|
||||||
Search the registry for the term 'fedora' and only display those images
|
Search a registry for the term 'fedora' and only display those images
|
||||||
ranked 3 or higher:
|
ranked 3 or higher:
|
||||||
|
|
||||||
$ docker search -s 3 fedora
|
$ docker search -s 3 fedora
|
||||||
|
@ -48,9 +47,9 @@ ranked 3 or higher:
|
||||||
mattdm/fedora-small A small Fedora image on which to build. Co... 8
|
mattdm/fedora-small A small Fedora image on which to build. Co... 8
|
||||||
goldmann/wildfly A WildFly application server running on a ... 3 [OK]
|
goldmann/wildfly A WildFly application server running on a ... 3 [OK]
|
||||||
|
|
||||||
## Search the registry for automated images
|
## Search Docker Hub for automated images
|
||||||
|
|
||||||
Search the registry for the term 'fedora' and only display automated images
|
Search Docker Hub for the term 'fedora' and only display automated images
|
||||||
ranked 1 or higher:
|
ranked 1 or higher:
|
||||||
|
|
||||||
$ docker search -s 1 -t fedora
|
$ docker search -s 1 -t fedora
|
||||||
|
@ -62,3 +61,5 @@ ranked 1 or higher:
|
||||||
April 2014, Originally compiled by William Henry (whenry at redhat dot com)
|
April 2014, Originally compiled by William Henry (whenry at redhat dot com)
|
||||||
based on docker.com source material and internal work.
|
based on docker.com source material and internal work.
|
||||||
June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
|
June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
|
||||||
|
April 2015, updated by Mary Anthony for v2 <mary@docker.com>
|
||||||
|
|
||||||
|
|
|
@ -8,11 +8,14 @@ docker-tag - Tag an image into a repository
|
||||||
**docker tag**
|
**docker tag**
|
||||||
[**-f**|**--force**[=*false*]]
|
[**-f**|**--force**[=*false*]]
|
||||||
[**--help**]
|
[**--help**]
|
||||||
IMAGE[:TAG] [REGISTRYHOST/][USERNAME/]NAME[:TAG]
|
IMAGE[:TAG] [REGISTRY_HOST/][USERNAME/]NAME[:TAG]
|
||||||
|
|
||||||
# DESCRIPTION
|
# DESCRIPTION
|
||||||
This will give a new alias to an image in the repository. This refers to the
|
Assigns a new alias to an image in a registry. An alias refers to the
|
||||||
entire image name including the optional TAG after the ':'.
|
entire image name including the optional `TAG` after the ':'.
|
||||||
|
|
||||||
|
If you do not specify a `REGISTRY_HOST`, the command uses Docker's public
|
||||||
|
registry located at `registry-1.docker.io` by default.
|
||||||
|
|
||||||
# "OPTIONS"
|
# "OPTIONS"
|
||||||
**-f**, **--force**=*true*|*false*
|
**-f**, **--force**=*true*|*false*
|
||||||
|
@ -58,3 +61,5 @@ April 2014, Originally compiled by William Henry (whenry at redhat dot com)
|
||||||
based on docker.com source material and internal work.
|
based on docker.com source material and internal work.
|
||||||
June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
|
June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
|
||||||
July 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
|
July 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
|
||||||
|
April 2015, updated by Mary Anthony for v2 <mary@docker.com>
|
||||||
|
|
||||||
|
|
|
@ -172,10 +172,10 @@ inside it)
|
||||||
Load an image from a tar archive
|
Load an image from a tar archive
|
||||||
|
|
||||||
**docker-login(1)**
|
**docker-login(1)**
|
||||||
Register or Login to a Docker registry server
|
Register or login to a Docker Registry Service
|
||||||
|
|
||||||
**docker-logout(1)**
|
**docker-logout(1)**
|
||||||
Log the user out of a Docker registry server
|
Log the user out of a Docker Registry Service
|
||||||
|
|
||||||
**docker-logs(1)**
|
**docker-logs(1)**
|
||||||
Fetch the logs of a container
|
Fetch the logs of a container
|
||||||
|
@ -190,10 +190,10 @@ inside it)
|
||||||
List containers
|
List containers
|
||||||
|
|
||||||
**docker-pull(1)**
|
**docker-pull(1)**
|
||||||
Pull an image or a repository from a Docker registry server
|
Pull an image or a repository from a Docker Registry Service
|
||||||
|
|
||||||
**docker-push(1)**
|
**docker-push(1)**
|
||||||
Push an image or a repository to a Docker registry server
|
Push an image or a repository to a Docker Registry Service
|
||||||
|
|
||||||
**docker-restart(1)**
|
**docker-restart(1)**
|
||||||
Restart a running container
|
Restart a running container
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue