2014-04-16 14:07:55 -04:00
|
|
|
% DOCKER(1) Docker User Manuals
|
2014-06-30 22:58:04 -04:00
|
|
|
% Docker Community
|
|
|
|
% JUNE 2014
|
2014-04-16 14:07:55 -04:00
|
|
|
# NAME
|
2014-06-30 22:58:04 -04:00
|
|
|
docker-tag - Tag an image into a repository
|
2014-04-16 14:07:55 -04:00
|
|
|
|
|
|
|
# SYNOPSIS
|
2014-06-30 22:58:04 -04:00
|
|
|
**docker tag**
|
|
|
|
[**-f**|**--force**[=*false*]]
|
2014-10-15 17:14:12 -04:00
|
|
|
[**--help**]
|
2015-04-01 15:20:59 -04:00
|
|
|
IMAGE[:TAG] [REGISTRY_HOST/][USERNAME/]NAME[:TAG]
|
2014-04-16 14:07:55 -04:00
|
|
|
|
|
|
|
# DESCRIPTION
|
2015-04-01 15:20:59 -04:00
|
|
|
Assigns a new alias to an image in a registry. An alias refers to 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.
|
2014-04-16 14:07:55 -04:00
|
|
|
|
|
|
|
# "OPTIONS"
|
2014-04-17 11:36:58 -04:00
|
|
|
**-f**, **--force**=*true*|*false*
|
2014-06-01 19:16:14 -04:00
|
|
|
When set to true, force the alias. The default is *false*.
|
2014-04-16 14:07:55 -04:00
|
|
|
|
2015-09-03 12:15:08 -04:00
|
|
|
**--help**
|
|
|
|
Print usage statement.
|
|
|
|
|
|
|
|
**REGISTRY_HOST**
|
2014-04-17 11:36:58 -04:00
|
|
|
The hostname of the registry if required. This may also include the port
|
2014-04-16 14:07:55 -04:00
|
|
|
separated by a ':'
|
|
|
|
|
|
|
|
**USERNAME**
|
2014-04-17 11:36:58 -04:00
|
|
|
The username or other qualifying identifier for the image.
|
2014-04-16 14:07:55 -04:00
|
|
|
|
|
|
|
**NAME**
|
2014-04-17 11:36:58 -04:00
|
|
|
The image name.
|
2014-04-16 14:07:55 -04:00
|
|
|
|
|
|
|
**TAG**
|
2014-05-31 17:44:17 -04:00
|
|
|
The tag you are assigning to the image. Though this is arbitrary it is
|
2014-07-10 00:14:06 -04:00
|
|
|
recommended to be used for a version to distinguish images with the same name.
|
2015-07-01 11:15:17 -04:00
|
|
|
Also, for consistency tags should only include a-z0-9-_. .
|
2014-05-31 17:44:17 -04:00
|
|
|
Note that here TAG is a part of the overall name or "tag".
|
2014-04-17 11:36:58 -04:00
|
|
|
|
2014-04-16 14:07:55 -04:00
|
|
|
# EXAMPLES
|
|
|
|
|
2014-06-01 19:16:14 -04:00
|
|
|
## Giving an image a new alias
|
2014-04-16 14:07:55 -04:00
|
|
|
|
2014-06-29 21:31:15 -04:00
|
|
|
Here is an example of aliasing an image (e.g., 0e5574283393) as "httpd" and
|
2014-05-31 17:44:17 -04:00
|
|
|
tagging it into the "fedora" repository with "version1.0":
|
2014-04-16 14:07:55 -04:00
|
|
|
|
|
|
|
docker tag 0e5574283393 fedora/httpd:version1.0
|
|
|
|
|
|
|
|
## Tagging an image for a private repository
|
|
|
|
|
2015-08-03 12:51:10 -04:00
|
|
|
To push an image to a private registry and not the central Docker
|
2014-04-16 14:07:55 -04:00
|
|
|
registry you must tag it with the registry hostname and port (if needed).
|
|
|
|
|
|
|
|
docker tag 0e5574283393 myregistryhost:5000/fedora/httpd:version1.0
|
|
|
|
|
|
|
|
# HISTORY
|
2014-04-17 11:36:58 -04:00
|
|
|
April 2014, Originally compiled by William Henry (whenry at redhat dot com)
|
2014-07-01 20:30:25 -04:00
|
|
|
based on docker.com source material and internal work.
|
2014-07-02 21:07:42 -04:00
|
|
|
June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
|
2014-07-22 22:40:10 -04:00
|
|
|
July 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
|
2015-04-01 15:20:59 -04:00
|
|
|
April 2015, updated by Mary Anthony for v2 <mary@docker.com>
|
2015-07-01 11:15:17 -04:00
|
|
|
June 2015, updated by Sally O'Malley <somalley@redhat.com>
|