Merge pull request #5414 from jamtur01/privreg
Addressed regression of private repository documentation.
This commit is contained in:
commit
6c4e5ee826
30 changed files with 205 additions and 186 deletions
|
@ -82,12 +82,12 @@ pages:
|
|||
# - ['user-guide/configuration.md', 'User Guide', 'Configuration']
|
||||
# ./faq.md
|
||||
|
||||
# Docker Index docs:
|
||||
- ['index/index.md', '**HIDDEN**']
|
||||
# Docker.io docs:
|
||||
- ['docker-io/index.md', '**HIDDEN**']
|
||||
# - ['index/home.md', 'Docker Index', 'Help']
|
||||
- ['index/accounts.md', 'Docker Index', 'Accounts']
|
||||
- ['index/repos.md', 'Docker Index', 'Repositories']
|
||||
- ['index/builds.md', 'Docker Index', 'Trusted Builds']
|
||||
- ['docker-io/accounts.md', 'Docker.io', 'Accounts']
|
||||
- ['docker-io/repos.md', 'Docker.io', 'Repositories']
|
||||
- ['docker-io/builds.md', 'Docker.io', 'Trusted Builds']
|
||||
|
||||
# Reference
|
||||
- ['reference/index.md', '**HIDDEN**']
|
||||
|
@ -99,7 +99,7 @@ pages:
|
|||
- ['articles/security.md', 'Reference', 'Security']
|
||||
- ['articles/baseimages.md', 'Reference', 'Creating a Base Image']
|
||||
- ['use/networking.md', 'Reference', 'Advanced networking']
|
||||
- ['reference/api/index_api.md', 'Reference', 'Docker Index API']
|
||||
- ['reference/api/docker-io_api.md', 'Reference', 'Docker.io API']
|
||||
- ['reference/api/registry_api.md', 'Reference', 'Docker Registry API']
|
||||
- ['reference/api/registry_index_spec.md', 'Reference', 'Registry & Index Spec']
|
||||
- ['reference/api/docker_remote_api.md', 'Reference', 'Docker Remote API']
|
||||
|
@ -126,4 +126,3 @@ pages:
|
|||
- ['terms/repository.md', '**HIDDEN**', 'repository']
|
||||
- ['terms/filesystem.md', '**HIDDEN**', 'filesystem']
|
||||
- ['terms/image.md', '**HIDDEN**', 'image']
|
||||
|
||||
|
|
32
docs/sources/docker-io/accounts.md
Normal file
32
docs/sources/docker-io/accounts.md
Normal file
|
@ -0,0 +1,32 @@
|
|||
page_title: Accounts on Docker.io
|
||||
page_description: Docker.io accounts
|
||||
page_keywords: Docker, docker, registry, accounts, plans, Dockerfile, Docker.io, docs, documentation
|
||||
|
||||
# Accounts on Docker.io
|
||||
|
||||
## Docker.io Accounts
|
||||
|
||||
You can `search` for Docker images and `pull` them from [Docker.io](https://index.docker.io)
|
||||
without signing in or even having an account. However, in order to `push` images,
|
||||
leave comments or to *star* a repository, you are going to need a [Docker.io](
|
||||
https://www.docker.io) account.
|
||||
|
||||
### Registration for a Docker.io Account
|
||||
|
||||
You can get a [Docker.io](https://index.docker.io) account by
|
||||
[signing up for one here](https://www.docker.io/account/signup/). A valid
|
||||
email address is required to register, which you will need to verify for
|
||||
account activation.
|
||||
|
||||
### Email activation process
|
||||
|
||||
You need to have at least one verified email address to be able to use your
|
||||
[Docker.io](https://index.docker.io) account. If you can't find the validation email,
|
||||
you can request another by visiting the [Resend Email Confirmation](
|
||||
https://www.docker.io/account/resend-email-confirmation/) page.
|
||||
|
||||
### Password reset process
|
||||
|
||||
If you can't access your account for some reason, you can reset your password
|
||||
from the [*Password Reset*](https://www.docker.io/account/forgot-password/)
|
||||
page.
|
|
@ -1,15 +1,15 @@
|
|||
page_title: Trusted Builds in the Docker Index
|
||||
page_description: Docker Index Trusted Builds
|
||||
page_keywords: Docker, docker, index, accounts, plans, Dockerfile, Docker.io, docs, documentation, trusted, builds, trusted builds
|
||||
page_title: Trusted Builds on Docker.io
|
||||
page_description: Docker.io Trusted Builds
|
||||
page_keywords: Docker, docker, registry, accounts, plans, Dockerfile, Docker.io, docs, documentation, trusted, builds, trusted builds
|
||||
|
||||
# Trusted Builds in the Docker Index
|
||||
# Trusted Builds on Docker.io
|
||||
|
||||
## Trusted Builds
|
||||
|
||||
*Trusted Builds* is a special feature allowing you to specify a source
|
||||
repository with a *Dockerfile* to be built by the Docker build clusters. The
|
||||
system will clone your repository and build the Dockerfile using the repository
|
||||
as the context. The resulting image will then be uploaded to the index and
|
||||
as the context. The resulting image will then be uploaded to the registry and
|
||||
marked as a `Trusted Build`.
|
||||
|
||||
Trusted Builds have a number of advantages. For example, users of *your* Trusted
|
||||
|
@ -17,18 +17,18 @@ Build can be certain that the resulting image was built exactly how it claims
|
|||
to be.
|
||||
|
||||
Furthermore, the Dockerfile will be available to anyone browsing your repository
|
||||
on the Index. Another advantage of the Trusted Builds feature is the automated
|
||||
on the registry. Another advantage of the Trusted Builds feature is the automated
|
||||
builds. This makes sure that your repository is always up to date.
|
||||
|
||||
### Linking with a GitHub account
|
||||
|
||||
In order to setup a Trusted Build, you need to first link your Docker Index
|
||||
account with a GitHub one. This will allow the Docker Index to see your
|
||||
repositories.
|
||||
In order to setup a Trusted Build, you need to first link your [Docker.io](
|
||||
https://index.docker.io) account with a GitHub one. This will allow the registry
|
||||
to see your repositories.
|
||||
|
||||
> *Note:* We currently request access for *read* and *write* since the Index
|
||||
> needs to setup a GitHub service hook. Although nothing else is done with
|
||||
> your account, this is how GitHub manages permissions, sorry!
|
||||
> *Note:* We currently request access for *read* and *write* since [Docker.io](
|
||||
> https://index.docker.io) needs to setup a GitHub service hook. Although nothing
|
||||
> else is done with your account, this is how GitHub manages permissions, sorry!
|
||||
|
||||
### Creating a Trusted Build
|
||||
|
||||
|
@ -77,8 +77,8 @@ Trusted Build:
|
|||
### The Dockerfile and Trusted Builds
|
||||
|
||||
During the build process, we copy the contents of your Dockerfile. We also
|
||||
add it to the Docker Index for the Docker community to see on the repository
|
||||
page.
|
||||
add it to the [Docker.io](https://index.docker.io) for the Docker community
|
||||
to see on the repository page.
|
||||
|
||||
### README.md
|
||||
|
13
docs/sources/docker-io/home.md
Normal file
13
docs/sources/docker-io/home.md
Normal file
|
@ -0,0 +1,13 @@
|
|||
page_title: The Docker.io Registry Help
|
||||
page_description: The Docker Registry help documentation home
|
||||
page_keywords: Docker, docker, registry, accounts, plans, Dockerfile, Docker.io, docs, documentation
|
||||
|
||||
# The Docker.io Registry Help
|
||||
|
||||
## Introduction
|
||||
|
||||
For your questions about the [Docker.io](https://index.docker.io) registry you
|
||||
can use [this documentation](docs.md).
|
||||
|
||||
If you can not find something you are looking for, please feel free to
|
||||
[contact us](https://index.docker.io/help/support/).
|
|
@ -1,15 +1,16 @@
|
|||
page_title: Repositories and Images in the Docker Index
|
||||
page_description: Docker Index repositories
|
||||
page_keywords: Docker, docker, index, accounts, plans, Dockerfile, Docker.io, docs, documentation
|
||||
page_title: Repositories and Images on Docker.io
|
||||
page_description: Repositories and Images on Docker.io
|
||||
page_keywords: Docker, docker, registry, accounts, plans, Dockerfile, Docker.io, docs, documentation
|
||||
|
||||
# Repositories and Images in the Docker Index
|
||||
# Repositories and Images on Docker.io
|
||||
|
||||
## Searching for repositories and images
|
||||
|
||||
You can `search` for all the publicly available repositories and images using
|
||||
Docker. If a repository is not public (i.e., private), it won't be listed on
|
||||
the Index search results. To see repository statuses, you can look at your
|
||||
[profile page](https://index.docker.io/account/).
|
||||
the repository search results. To see repository statuses, you can look at your
|
||||
[profile page](https://index.docker.io/account/) on [Docker.io](
|
||||
https://index.docker.io).
|
||||
|
||||
## Repositories
|
||||
|
||||
|
@ -22,20 +23,20 @@ of bookmark your favorites.
|
|||
|
||||
You can interact with other members of the Docker community and maintainers by
|
||||
leaving comments on repositories. If you find any comments that are not
|
||||
appropriate, you can flag them for the Index admins' review.
|
||||
appropriate, you can flag them for the admins' review.
|
||||
|
||||
### Private Docker Repositories
|
||||
|
||||
To work with a private repository on the Docker Index, you will need to add one
|
||||
via the [Add Repository](https://index.docker.io/account/repositories/add) link.
|
||||
Once the private repository is created, you can `push` and `pull` images to and
|
||||
from it using Docker.
|
||||
To work with a private repository on [Docker.io](https://index.docker.io), you
|
||||
will need to add one via the [Add Repository](https://index.docker.io/account/repositories/add)
|
||||
link. Once the private repository is created, you can `push` and `pull` images
|
||||
to and from it using Docker.
|
||||
|
||||
> *Note:* You need to be signed in and have access to work with a private
|
||||
> repository.
|
||||
|
||||
Private repositories are just like public ones. However, it isn't possible to
|
||||
browse them or search their content on the public index. They do not get cached
|
||||
browse them or search their content on the public registry. They do not get cached
|
||||
the same way as a public repository either.
|
||||
|
||||
It is possible to give access to a private repository to those whom you
|
||||
|
@ -44,7 +45,7 @@ designate (i.e., collaborators) from its settings page.
|
|||
From there, you can also switch repository status (*public* to *private*, or
|
||||
viceversa). You will need to have an available private repository slot open
|
||||
before you can do such a switch. If you don't have any, you can always upgrade
|
||||
your [Docker Index plan](https://index.docker.io/plans/).
|
||||
your [Docker.io](https://index.docker.io/plans/) plan.
|
||||
|
||||
### Collaborators and their role
|
||||
|
|
@ -35,11 +35,10 @@ Download the small base image named `busybox`:
|
|||
# Download a busybox image
|
||||
$ sudo docker pull busybox
|
||||
|
||||
The `busybox` image is a minimal Linux system. You
|
||||
can do the same with any number of other images, such as
|
||||
`debian`, `ubuntu` or
|
||||
`centos`. The images can be found and retrieved
|
||||
using the [Docker index](http://index.docker.io).
|
||||
The `busybox` image is a minimal Linux system. You can do the same with
|
||||
any number of other images, such as `debian`, `ubuntu` or `centos`. The
|
||||
images can be found and retrieved using the
|
||||
[Docker.io](http://index.docker.io) registry.
|
||||
|
||||
$ sudo docker run busybox /bin/echo hello world
|
||||
|
||||
|
|
|
@ -1,31 +0,0 @@
|
|||
page_title: Accounts in the Docker Index
|
||||
page_description: Docker Index accounts
|
||||
page_keywords: Docker, docker, index, accounts, plans, Dockerfile, Docker.io, docs, documentation
|
||||
|
||||
# Accounts in the Docker Index
|
||||
|
||||
## Docker IO and Docker Index Accounts
|
||||
|
||||
You can `search` for Docker images and `pull` them from the [Docker Index](
|
||||
https://index.docker.io) without signing in or even having an account. However,
|
||||
in order to `push` images, leave comments or to *star* a repository, you are going
|
||||
to need a [Docker IO](https://www.docker.io) account.
|
||||
|
||||
### Registration for a Docker IO Account
|
||||
|
||||
You can get a Docker IO account by [signing up for one here](
|
||||
https://www.docker.io/account/signup/). A valid email address is required to
|
||||
register, which you will need to verify for account activation.
|
||||
|
||||
### Email activation process
|
||||
|
||||
You need to have at least one verified email address to be able to use your
|
||||
Docker IO account. If you can't find the validation email, you can request
|
||||
another by visiting the [Resend Email Confirmation](
|
||||
https://www.docker.io/account/resend-email-confirmation/) page.
|
||||
|
||||
### Password reset process
|
||||
|
||||
If you can't access your account for some reason, you can reset your password
|
||||
from the [*Password Reset*](https://www.docker.io/account/forgot-password/)
|
||||
page.
|
|
@ -1,13 +0,0 @@
|
|||
page_title: The Docker Index Help
|
||||
page_description: The Docker Index help documentation home
|
||||
page_keywords: Docker, docker, index, accounts, plans, Dockerfile, Docker.io, docs, documentation
|
||||
|
||||
# The Docker Index Help
|
||||
|
||||
## Introduction
|
||||
|
||||
For your questions about the [Docker Index](https://index.docker.io) you can
|
||||
use [this documentation](docs.md).
|
||||
|
||||
If you can not find something you are looking for, please feel free to
|
||||
[contact us](https://index.docker.io/help/support/).
|
|
@ -43,7 +43,7 @@ Docker's main components are:
|
|||
|
||||
- Docker *daemon*;
|
||||
- Docker *client*, and;
|
||||
- The Docker Index.
|
||||
- [Docker.io](https://index.docker.io) registry.
|
||||
|
||||
### The Docker daemon
|
||||
|
||||
|
@ -57,9 +57,9 @@ The Docker client is the primary user interface to Docker. It is tasked
|
|||
with accepting commands from the user and communicating back and forth
|
||||
with a Docker daemon to manage the container lifecycle on any host.
|
||||
|
||||
### Docker Index, the central Docker registry
|
||||
### Docker.io registry
|
||||
|
||||
The [Docker Index](http://index.docker.io) is the global archive (and
|
||||
[Docker.io](https://index.docker.io) is the global archive (and
|
||||
directory) of user supplied Docker container images. It currently hosts
|
||||
a large – in fact, rapidly growing – number of projects where you
|
||||
can find almost any popular application or deployment stack readily
|
||||
|
@ -70,28 +70,29 @@ tools for everyone to grow with other *Dockers*. By issuing a single
|
|||
command through the Docker client you can start sharing your own
|
||||
creations with the rest of the world.
|
||||
|
||||
However, knowing that not everything can be shared the Docker Index also
|
||||
offers private repositories. In order to see the available plans, you
|
||||
can click [here](https://index.docker.io/plans).
|
||||
However, knowing that not everything can be shared the [Docker.io](
|
||||
https://index.docker.io) also offers private repositories. In order to see
|
||||
the available plans, you can click [here](https://index.docker.io/plans).
|
||||
|
||||
Using the [Docker Registry](https://github.com/dotcloud/docker-registry), it is
|
||||
Using [*docker-registry*](https://github.com/dotcloud/docker-registry), it is
|
||||
also possible to run your own private Docker image registry service on your own
|
||||
servers.
|
||||
|
||||
> **Note:** To learn more about the [*Docker Image Index*](
|
||||
> http://index.docker.io) (public *and* private), check out the [Registry &
|
||||
> **Note:** To learn more about the [*Docker.io*](http://index.docker.io)
|
||||
> registry (for public *and* private repositories), check out the [Registry &
|
||||
> Index Spec](http://docs.docker.io/api/registry_index_spec/).
|
||||
|
||||
### Summary
|
||||
|
||||
- **When you install Docker, you get all the components:**
|
||||
The daemon, the client and access to the public image registry: the [Docker Index](http://index.docker.io).
|
||||
The daemon, the client and access to the [Docker.io](http://index.docker.io) registry.
|
||||
- **You can run these components together or distributed:**
|
||||
Servers with the Docker daemon running, controlled by the Docker client.
|
||||
- **You can benefit form the public registry:**
|
||||
Download and build upon images created by the community.
|
||||
- **You can start a private repository for proprietary use.**
|
||||
Sign up for a [plan](https://index.docker.io/plans) or host your own [Docker registry](https://github.com/dotcloud/docker-registry).
|
||||
Sign up for a [plan](https://index.docker.io/plans) or host your own [docker-registry](
|
||||
https://github.com/dotcloud/docker-registry).
|
||||
|
||||
## Elements of Docker
|
||||
|
||||
|
@ -198,7 +199,7 @@ Docker begins with:
|
|||
|
||||
- **Pulling the `ubuntu` image:**
|
||||
Docker checks for the presence of the `ubuntu` image and if it doesn't
|
||||
exist locally on the host, then Docker downloads it from the [Docker Index](https://index.docker.io)
|
||||
exist locally on the host, then Docker downloads it from [Docker.io](https://index.docker.io)
|
||||
- **Creates a new container:**
|
||||
Once Docker has the image it creates a container from it.
|
||||
- **Allocates a filesystem and mounts a read-write _layer_:**
|
||||
|
@ -226,28 +227,27 @@ UnionFS technology we saw earlier.
|
|||
|
||||
Every image starts from a base image, for example `ubuntu` a base Ubuntu
|
||||
image or `fedora` a base Fedora image. Docker builds and provides these
|
||||
base images via the [Docker Index](http://index.docker.io).
|
||||
base images via [Docker.io](http://index.docker.io).
|
||||
|
||||
### How does a Docker registry work?
|
||||
|
||||
The Docker registry is a store for your Docker images. Once you build a
|
||||
Docker image you can *push* it to the [Docker
|
||||
Index](http://index.docker.io) or to a private registry you run behind
|
||||
your firewall.
|
||||
Docker image you can *push* it to a public or private repository on [Docker.io](
|
||||
http://index.docker.io) or to your own registry running behind your firewall.
|
||||
|
||||
Using the Docker client, you can search for already published images and
|
||||
then pull them down to your Docker host to build containers from them
|
||||
(or even build on these images).
|
||||
|
||||
The [Docker Index](http://index.docker.io) provides both public and
|
||||
[Docker.io](http://index.docker.io) provides both public and
|
||||
private storage for images. Public storage is searchable and can be
|
||||
downloaded by anyone. Private repositories are excluded from search
|
||||
results and only you and your users can pull them down and use them to
|
||||
build containers. You can [sign up for a plan here](https://index.docker.io/plans).
|
||||
|
||||
To learn more, check out the [Working With Repositories](
|
||||
http://docs.docker.io/use/workingwithrepository) section of our
|
||||
[User's Manual](http://docs.docker.io).
|
||||
To learn more, check out the [Working with Repositories](
|
||||
http://docs.docker.io/use/workingwithrepository) section from the
|
||||
[Docker documentation](http://docs.docker.io).
|
||||
|
||||
## Where to go from here
|
||||
|
||||
|
|
|
@ -179,10 +179,10 @@ Without dealing with complicated commands or third party applications.
|
|||
Docker allows you to share the images you've built with the world. And
|
||||
lots of people have already shared their own images.
|
||||
|
||||
To facilitate this sharing Docker comes with a public registry and index
|
||||
called the [Docker Index](http://index.docker.io). If you don't want
|
||||
your images to be public you can also use private images on the Index or
|
||||
even run your own registry behind your firewall.
|
||||
To facilitate this sharing Docker comes with a public registry called
|
||||
[Docker.io](http://index.docker.io). If you don't want your images to be
|
||||
public you can also use private images on [Docker.io](https://index.docker.io)
|
||||
or even run your own registry behind your firewall.
|
||||
|
||||
**This translates to:**
|
||||
|
||||
|
|
|
@ -42,7 +42,7 @@ interfaces:
|
|||
|
||||
- [3 Authorization](registry_api/#authorization)
|
||||
|
||||
- [Docker Index API](index_api/)
|
||||
- [Docker.io API](index_api/)
|
||||
- [1. Brief introduction](index_api/#brief-introduction)
|
||||
- [2. Endpoints](index_api/#endpoints)
|
||||
- [2.1 Repository](index_api/#repository)
|
||||
|
|
|
@ -734,7 +734,7 @@ Remove the image `name` from the filesystem
|
|||
|
||||
`GET /images/search`
|
||||
|
||||
Search for an image in the docker index
|
||||
Search for an image on [Docker.io](https://index.docker.io)
|
||||
|
||||
**Example request**:
|
||||
|
||||
|
|
|
@ -745,7 +745,7 @@ Remove the image `name` from the filesystem
|
|||
|
||||
`GET /images/search`
|
||||
|
||||
Search for an image in the docker index
|
||||
Search for an image on [Docker.io](https://index.docker.io)
|
||||
|
||||
**Example request**:
|
||||
|
||||
|
|
|
@ -772,7 +772,7 @@ Remove the image `name` from the filesystem
|
|||
|
||||
`GET /images/search`
|
||||
|
||||
Search for an image in the docker index
|
||||
Search for an image on [Docker.io](https://index.docker.io)
|
||||
|
||||
**Example request**:
|
||||
|
||||
|
|
|
@ -821,7 +821,7 @@ Remove the image `name` from the filesystem
|
|||
|
||||
`GET /images/search`
|
||||
|
||||
Search for an image in the docker index
|
||||
Search for an image on [Docker.io](https://index.docker.io)
|
||||
|
||||
**Example request**:
|
||||
|
||||
|
|
|
@ -866,7 +866,7 @@ Remove the image `name` from the filesystem
|
|||
|
||||
`GET /images/search`
|
||||
|
||||
Search for an image in the docker index
|
||||
Search for an image on [Docker.io](https://index.docker.io)
|
||||
|
||||
**Example request**:
|
||||
|
||||
|
|
|
@ -871,7 +871,7 @@ Remove the image `name` from the filesystem
|
|||
|
||||
`GET /images/search`
|
||||
|
||||
Search for an image in the docker index
|
||||
Search for an image on [Docker.io](https://index.docker.io)
|
||||
|
||||
**Example request**:
|
||||
|
||||
|
|
|
@ -976,7 +976,7 @@ Remove the image `name` from the filesystem
|
|||
|
||||
`GET /images/search`
|
||||
|
||||
Search for an image in the docker index
|
||||
Search for an image on [Docker.io](https://index.docker.io)
|
||||
|
||||
**Example request**:
|
||||
|
||||
|
|
|
@ -902,7 +902,7 @@ Remove the image `name` from the filesystem
|
|||
|
||||
`GET /images/search`
|
||||
|
||||
Search for an image in the docker index.
|
||||
Search for an image on [Docker.io](https://index.docker.io).
|
||||
|
||||
> **Note**:
|
||||
> The response keys have changed from API v1.6 to reflect the JSON
|
||||
|
|
|
@ -944,7 +944,7 @@ Remove the image `name` from the filesystem
|
|||
|
||||
`GET /images/search`
|
||||
|
||||
Search for an image in the docker index.
|
||||
Search for an image on [Docker.io](https://index.docker.io).
|
||||
|
||||
> **Note**:
|
||||
> The response keys have changed from API v1.6 to reflect the JSON
|
||||
|
|
|
@ -1,12 +1,12 @@
|
|||
page_title: Index API
|
||||
page_description: API Documentation for Docker Index
|
||||
page_keywords: API, Docker, index, REST, documentation
|
||||
page_title: Docker.io API
|
||||
page_description: API Documentation for the Docker.io API
|
||||
page_keywords: API, Docker, index, REST, documentation, Docker.io, registry
|
||||
|
||||
# Docker Index API
|
||||
# Docker.io API
|
||||
|
||||
## Introduction
|
||||
|
||||
- This is the REST API for the Docker index
|
||||
- This is the REST API for [Docker.io](http://index.docker.io).
|
||||
- Authorization is done with basic auth over SSL
|
||||
- Not all commands require authentication, only those noted as such.
|
||||
|
|
@ -933,7 +933,7 @@ Tag the image `name` into a repository
|
|||
|
||||
`GET /images/search`
|
||||
|
||||
Search for an image in the docker index.
|
||||
Search for an image on [Docker.io](https://index.docker.io).
|
||||
|
||||
> **Note**:
|
||||
> The response keys have changed from API v1.6 to reflect the JSON
|
||||
|
|
|
@ -937,7 +937,7 @@ Remove the image `name` from the filesystem
|
|||
|
||||
`GET /images/search`
|
||||
|
||||
Search for an image in the docker index.
|
||||
Search for an image on [Docker.io](https://index.docker.io).
|
||||
|
||||
> **Note**:
|
||||
> The response keys have changed from API v1.6 to reflect the JSON
|
||||
|
|
|
@ -947,7 +947,7 @@ Tag the image `name` into a repository
|
|||
|
||||
`GET /images/search`
|
||||
|
||||
Search for an image in the docker index.
|
||||
Search for an image on [Docker.io](https://index.docker.io).
|
||||
|
||||
> **Note**:
|
||||
> The response keys have changed from API v1.6 to reflect the JSON
|
||||
|
|
|
@ -694,10 +694,10 @@ Pull an image or a repository from the registry
|
|||
Usage: docker pull NAME[:TAG]
|
||||
|
||||
Most of your images will be created on top of a base image from the
|
||||
Docker Index ([https://index.docker.io](https://index.docker.io)).
|
||||
[Docker.io](https://index.docker.io) registry.
|
||||
|
||||
The Docker Index contains many pre-built images that you can
|
||||
`pull` and try without needing to define and configure your own.
|
||||
[Docker.io](https://index.docker.io) contains many pre-built images that you
|
||||
can `pull` and try without needing to define and configure your own.
|
||||
|
||||
To download a particular image, or set of images (i.e., a repository),
|
||||
use `docker pull`:
|
||||
|
@ -1067,7 +1067,7 @@ It is used to create a backup that can then be used with
|
|||
|
||||
## search
|
||||
|
||||
Search the docker index for images
|
||||
Search [Docker.io](https://index.docker.io) for images
|
||||
|
||||
Usage: docker search TERM
|
||||
|
||||
|
@ -1075,8 +1075,8 @@ Search the docker index for images
|
|||
-s, --stars=0: Only displays with at least xxx stars
|
||||
-t, --trusted=false: Only show trusted builds
|
||||
|
||||
See [*Find Public Images on the Central Index*](
|
||||
/use/workingwithrepository/#searching-central-index) for
|
||||
See [*Find Public Images on Docker.io*](
|
||||
/use/workingwithrepository/#find-public-images-on-dockerio) for
|
||||
more details on finding shared images from the commandline.
|
||||
|
||||
## start
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
page_title: Registry
|
||||
page_description: Definition of an Registry
|
||||
page_keywords: containers, lxc, concepts, explanation, image, repository, container
|
||||
page_keywords: containers, concepts, explanation, image, repository, container
|
||||
|
||||
# Registry
|
||||
|
||||
|
@ -11,7 +11,7 @@ A Registry is a hosted service containing [*repositories*](
|
|||
responds to the Registry API.
|
||||
|
||||
The default registry can be accessed using a browser at
|
||||
[http://images.docker.io](http://images.docker.io) or using the
|
||||
[Docker.io](http://index.docker.io) or using the
|
||||
`sudo docker search` command.
|
||||
|
||||
## Further Reading
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
page_title: Repository
|
||||
page_description: Definition of an Repository
|
||||
page_keywords: containers, lxc, concepts, explanation, image, repository, container
|
||||
page_keywords: containers, concepts, explanation, image, repository, container
|
||||
|
||||
# Repository
|
||||
|
||||
|
|
|
@ -25,9 +25,9 @@ for installation instructions.
|
|||
# Download an ubuntu image
|
||||
sudo docker pull ubuntu
|
||||
|
||||
This will find the `ubuntu` image by name in the
|
||||
[*Central Index*](../workingwithrepository/#searching-central-index) and
|
||||
download it from the top-level Central Repository to a local image
|
||||
This will find the `ubuntu` image by name on
|
||||
[*Docker.io*](../workingwithrepository/#find-public-images-on-dockerio) and
|
||||
download it from [Docker.io](https://index.docker.io) to a local image
|
||||
cache.
|
||||
|
||||
> **Note**:
|
||||
|
|
|
@ -6,33 +6,35 @@ page_keywords: repo, repositories, usage, pull image, push image, image, documen
|
|||
|
||||
## Introduction
|
||||
|
||||
A *repository* is a shareable collection of tagged
|
||||
Docker is not only a tool for creating and managing your own
|
||||
[*containers*](/terms/container/#container-def) – **Docker is also a
|
||||
tool for sharing**. A *repository* is a shareable collection of tagged
|
||||
[*images*](/terms/image/#image-def) that together create the file
|
||||
systems for containers. The repository's name is a label that indicates
|
||||
the provenance of the repository, i.e. who created it and where the
|
||||
original copy is located.
|
||||
|
||||
You can find one or more repositories hosted on a *registry*. There can
|
||||
be an implicit or explicit host name as part of the repository tag. The
|
||||
implicit registry is located at `index.docker.io`,
|
||||
the home of "top-level" repositories and the Central Index. This
|
||||
registry may also include public "user" repositories.
|
||||
You can find one or more repositories hosted on a *registry*. There are
|
||||
two types of *registry*: public and private. There's also a default
|
||||
*registry* that Docker uses which is called
|
||||
[Docker.io](http://index.docker.io).
|
||||
[Docker.io](http://index.docker.io) is the home of
|
||||
"top-level" repositories and public "user" repositories. The Docker
|
||||
project provides [Docker.io](http://index.docker.io) to host public and
|
||||
[private repositories](https://index.docker.io/plans/), namespaced by
|
||||
user. We provide user authentication and search over all the public
|
||||
repositories.
|
||||
|
||||
Docker is not only a tool for creating and managing your own
|
||||
[*containers*](/terms/container/#container-def) – **Docker is also
|
||||
a tool for sharing**. The Docker project provides a Central Registry to
|
||||
host public repositories, namespaced by user, and a Central Index which
|
||||
provides user authentication and search over all the public
|
||||
repositories. You can host your own Registry too! Docker acts as a
|
||||
client for these services via `docker search, pull, login`
|
||||
and `push`.
|
||||
Docker acts as a client for these services via the `docker search, pull,
|
||||
login` and `push` commands.
|
||||
|
||||
## Repositories
|
||||
|
||||
### Local Repositories
|
||||
|
||||
Docker images which have been created and labeled on your local Docker
|
||||
server need to be pushed to a Public or Private registry to be shared.
|
||||
server need to be pushed to a Public (by default they are pushed to
|
||||
[Docker.io](http://index.docker.io)) or Private registry to be shared.
|
||||
|
||||
### Public Repositories
|
||||
|
||||
|
@ -41,22 +43,29 @@ which are controlled by the Docker team, and *user* repositories created
|
|||
by individual contributors. Anyone can read from these repositories –
|
||||
they really help people get started quickly! You could also use
|
||||
[*Trusted Builds*](#trusted-builds) if you need to keep
|
||||
control of who accesses your images, but we will only refer to public
|
||||
repositories in these examples.
|
||||
control of who accesses your images.
|
||||
|
||||
- Top-level repositories can easily be recognized by **not** having a
|
||||
`/` (slash) in their name. These repositories can generally be trusted.
|
||||
`/` (slash) in their name. These repositories represent trusted images
|
||||
provided by the Docker team.
|
||||
- User repositories always come in the form of `<username>/<repo_name>`.
|
||||
This is what your published images will look like if you push to the public
|
||||
Central Registry.
|
||||
- Only the authenticated user can push to their *username* namespace
|
||||
on the Central Registry.
|
||||
- User images are not checked, it is therefore up to you whether or not you
|
||||
trust the creator of this image.
|
||||
This is what your published images will look like if you push to the
|
||||
public [Docker.io](http://index.docker.io) registry.
|
||||
- Only the authenticated user can push to their *username* namespace on
|
||||
a [Docker.io](http://index.docker.io) repository.
|
||||
- User images are not curated, it is therefore up to you whether or not
|
||||
you trust the creator of this image.
|
||||
|
||||
## Find Public Images on the Central Index
|
||||
### Private repositories
|
||||
|
||||
You can search the Central Index [online](https://index.docker.io) or
|
||||
You can also create private repositories on
|
||||
[Docker.io](https://index.docker.io/plans/). These allow you to store
|
||||
images that you don't want to share publicly. Only authenticated users
|
||||
can push to private repositories.
|
||||
|
||||
## Find Public Images on Docker.io
|
||||
|
||||
You can search the [Docker.io](https://index.docker.io) registry or
|
||||
using the command line interface. Searching can find images by name,
|
||||
user name or description:
|
||||
|
||||
|
@ -78,7 +87,7 @@ There you can see two example results: `centos` and
|
|||
shows that it comes from the public repository of a user,
|
||||
`slantview/`, while the first result
|
||||
(`centos`) doesn't explicitly list a repository so
|
||||
it comes from the trusted Central Repository. The `/`
|
||||
it comes from the trusted top-level namespace. The `/`
|
||||
character separates a user's repository and the image name.
|
||||
|
||||
Once you have found the image name, you can download it:
|
||||
|
@ -92,13 +101,13 @@ What can you do with that image? Check out the
|
|||
[*Examples*](/examples/#example-list) and, when you're ready with
|
||||
your own image, come back here to learn how to share it.
|
||||
|
||||
## Contributing to the Central Registry
|
||||
## Contributing to Docker.io
|
||||
|
||||
Anyone can pull public images from the Central Registry, but if you
|
||||
would like to share one of your own images, then you must register a
|
||||
unique user name first. You can create your username and login on the
|
||||
[central Docker Index online](https://index.docker.io/account/signup/),
|
||||
or by running
|
||||
Anyone can pull public images from the
|
||||
[Docker.io](http://index.docker.io) registry, but if you would like to
|
||||
share one of your own images, then you must register a unique user name
|
||||
first. You can create your username and login on
|
||||
[Docker.io](https://index.docker.io/account/signup/), or by running
|
||||
|
||||
sudo docker login
|
||||
|
||||
|
@ -110,15 +119,19 @@ also prompt you to enter a password and your e-mail address. It will
|
|||
then automatically log you in. Now you're ready to commit and push your
|
||||
own images!
|
||||
|
||||
> **Note:**
|
||||
> Your authentication credentials will be stored in the [`.dockercfg`
|
||||
> authentication file](#authentication-file).
|
||||
|
||||
## Committing a Container to a Named Image
|
||||
|
||||
When you make changes to an existing image, those changes get saved to a
|
||||
container's file system. You can then promote that container to become
|
||||
an image by making a `commit`. In addition to
|
||||
converting the container to an image, this is also your opportunity to
|
||||
name the image, specifically a name that includes your user name from
|
||||
the Central Docker Index (as you did a `login`
|
||||
above) and a meaningful name for the image.
|
||||
an image by making a `commit`. In addition to converting the container
|
||||
to an image, this is also your opportunity to name the image,
|
||||
specifically a name that includes your user name from
|
||||
[Docker.io](http://index.docker.io) (as you did a `login` above) and a
|
||||
meaningful name for the image.
|
||||
|
||||
# format is "sudo docker commit <container_id> <username>/<imagename>"
|
||||
$ sudo docker commit $CONTAINER_ID myname/kickassapp
|
||||
|
@ -143,7 +156,7 @@ when you push a commit.
|
|||
|
||||
### To setup a trusted build
|
||||
|
||||
1. Create a [Docker Index account](https://index.docker.io/) and login.
|
||||
1. Create a [Docker.io account](https://index.docker.io/) and login.
|
||||
2. Link your GitHub account through the `Link Accounts` menu.
|
||||
3. [Configure a Trusted build](https://index.docker.io/builds/).
|
||||
4. Pick a GitHub project that has a `Dockerfile` that you want to build.
|
||||
|
@ -154,8 +167,9 @@ when you push a commit.
|
|||
|
||||
Once the Trusted Build is configured it will automatically trigger a
|
||||
build, and in a few minutes, if there are no errors, you will see your
|
||||
new trusted build on the Docker Index. It will will stay in sync with
|
||||
your GitHub repo until you deactivate the Trusted Build.
|
||||
new trusted build on the [Docker.io](https://index.docker.io) Registry.
|
||||
It will will stay in sync with your GitHub repo until you deactivate the
|
||||
Trusted Build.
|
||||
|
||||
If you want to see the status of your Trusted Builds you can go to your
|
||||
[Trusted Builds page](https://index.docker.io/builds/) on the Docker
|
||||
|
@ -167,15 +181,20 @@ cannot however push to a Trusted Build with the `docker push` command.
|
|||
You can only manage it by committing code to your GitHub repository.
|
||||
|
||||
You can create multiple Trusted Builds per repository and configure them
|
||||
to point to specific Dockerfile's or Git branches.
|
||||
to point to specific `Dockerfile`'s or Git branches.
|
||||
|
||||
## Private Registry
|
||||
|
||||
Private registries and private shared repositories are only possible by
|
||||
hosting [your own registry](https://github.com/dotcloud/docker-registry).
|
||||
To push or pull to a repository on your own registry, you must prefix the
|
||||
tag with the address of the registry's host (a `.` or `:` is used to identify
|
||||
a host), like this:
|
||||
Private registries are possible by hosting [your own
|
||||
registry](https://github.com/dotcloud/docker-registry).
|
||||
|
||||
> **Note**:
|
||||
> You can also use private repositories on
|
||||
> [Docker.io](https://index.docker.io/plans/).
|
||||
|
||||
To push or pull to a repository on your own registry, you must prefix
|
||||
the tag with the address of the registry's host (a `.` or `:` is used to
|
||||
identify a host), like this:
|
||||
|
||||
# Tag to create a repository with the full registry location.
|
||||
# The location (e.g. localhost.localdomain:5000) becomes
|
||||
|
@ -187,9 +206,9 @@ a host), like this:
|
|||
|
||||
Once a repository has your registry's host name as part of the tag, you
|
||||
can push and pull it like any other repository, but it will **not** be
|
||||
searchable (or indexed at all) in the Central Index, and there will be
|
||||
searchable (or indexed at all) on [Docker.io](http://index.docker.io), and there will be
|
||||
no user name checking performed. Your registry will function completely
|
||||
independently from the Central Index.
|
||||
independently from the [Docker.io](http://index.docker.io) registry.
|
||||
|
||||
<iframe width="640" height="360" src="//www.youtube.com/embed/CAewZCBT4PI?rel=0" frameborder="0" allowfullscreen></iframe>
|
||||
|
||||
|
|
Loading…
Add table
Reference in a new issue