mirror of
https://github.com/moby/moby.git
synced 2022-11-09 12:21:53 -05:00
Updated Docker Hub documentation
Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
This commit is contained in:
parent
a43cebf088
commit
871299de0d
8 changed files with 125 additions and 45 deletions
|
@ -6,9 +6,11 @@ page_keywords: Docker, docker, registry, accounts, plans, Dockerfile, Docker Hub
|
|||
|
||||
## Docker Hub Accounts
|
||||
|
||||
You can `search` for Docker images and `pull` them from [Docker Hub](https://hub.docker.com)
|
||||
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 Hub](https://hub.docker.com) account.
|
||||
You can `search` for Docker images and `pull` them from [Docker
|
||||
Hub](https://hub.docker.com) 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
|
||||
Hub](https://hub.docker.com) account.
|
||||
|
||||
### Registration for a Docker Hub Account
|
||||
|
||||
|
@ -29,3 +31,19 @@ https://hub.docker.com/account/resend-email-confirmation/) page.
|
|||
If you can't access your account for some reason, you can reset your password
|
||||
from the [*Password Reset*](https://hub.docker.com/account/forgot-password/)
|
||||
page.
|
||||
|
||||
## Organizations & Groups
|
||||
|
||||
Also available on the Docker Hub are organizations and groups that allow
|
||||
you to collaborate across your organization or team. You can see what
|
||||
organizations [you belong to and add new organizations](Sam Alba
|
||||
<sam@docker.com>) from the Account
|
||||
tab.
|
||||
|
||||
![organizations](/docker-hub/orgs.png)
|
||||
|
||||
From within your organizations you can create groups that allow you to
|
||||
further manage who can interact with your repositories.
|
||||
|
||||
![groups](/docker-hub/groups.png)
|
||||
|
||||
|
|
BIN
docs/sources/docker-hub/groups.png
Normal file
BIN
docs/sources/docker-hub/groups.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 106 KiB |
BIN
docs/sources/docker-hub/hub.png
Normal file
BIN
docs/sources/docker-hub/hub.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 91 KiB |
|
@ -1,8 +1,23 @@
|
|||
page_title: The Docker Hub Help
|
||||
page_description: The Docker Help documentation home
|
||||
page_keywords: Docker, docker, registry, accounts, plans, Dockerfile, Docker Hub, docs, documentation, accounts, organizations, repositories, groups
|
||||
|
||||
# Docker Hub
|
||||
|
||||
## Contents:
|
||||
![DockerHub](/docker-hub/hub.png)
|
||||
|
||||
- [Accounts](accounts/)
|
||||
- [Repositories](repos/)
|
||||
- [Automated Builds](builds/)
|
||||
## [Accounts](accounts/)
|
||||
|
||||
[Learn how to create](accounts/) a [Docker Hub](https://hub.docker.com)
|
||||
account and manage your organizations and groups.
|
||||
|
||||
## [Repositories](repos/)
|
||||
|
||||
Find out how to share your Docker images in [Docker Hub
|
||||
repositories](repos/) and how to store and manage private images.
|
||||
|
||||
## [Automated Builds](builds/)
|
||||
|
||||
Learn how to automate your build and deploy pipeline with [Automated
|
||||
Builds](builds/)
|
||||
|
||||
|
|
BIN
docs/sources/docker-hub/orgs.png
Normal file
BIN
docs/sources/docker-hub/orgs.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 71 KiB |
|
@ -4,63 +4,106 @@ page_keywords: Docker, docker, registry, accounts, plans, Dockerfile, Docker Hub
|
|||
|
||||
# Repositories and Images on Docker Hub
|
||||
|
||||
![repositories](/docker-hub/repos.png)
|
||||
|
||||
## 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 repository search results. To see repository statuses, you can look at your
|
||||
[profile page](https://hub.docker.com) on [Docker Hub](https://hub.docker.com).
|
||||
Docker.
|
||||
|
||||
$ docker search ubuntu
|
||||
|
||||
This will show you a list of the currently available repositories on the
|
||||
Docker Hub which match the provided keyword.
|
||||
|
||||
If a repository is private it won't be listed on the repository search
|
||||
results. To see repository statuses, you can look at your [profile
|
||||
page](https://hub.docker.com) on [Docker Hub](https://hub.docker.com).
|
||||
|
||||
## Repositories
|
||||
|
||||
Your Docker Hub repositories have a number of useful features.
|
||||
|
||||
### Stars
|
||||
|
||||
Stars are a way to show that you like a repository. They are also an easy way
|
||||
of bookmark your favorites.
|
||||
Your repositories can be starred and you can star repositories in
|
||||
return. Stars are a way to show that you like a repository. They are
|
||||
also an easy way of bookmarking your favorites.
|
||||
|
||||
### Comments
|
||||
|
||||
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 admins' review.
|
||||
|
||||
### Private Docker Repositories
|
||||
|
||||
To work with a private repository on [Docker Hub](https://hub.docker.com), you
|
||||
will need to add one via the [Add Repository](https://registry.hub.docker.com/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 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
|
||||
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 Hub](https://registry.hub.docker.com/plans/) plan.
|
||||
appropriate, you can flag them for review.
|
||||
|
||||
### Collaborators and their role
|
||||
|
||||
A collaborator is someone you want to give access to a private repository. Once
|
||||
designated, they can `push` and `pull`. Although, they will not be allowed to
|
||||
perform any administrative tasks such as deleting the repository or changing its
|
||||
status from private to public.
|
||||
A collaborator is someone you want to give access to a private
|
||||
repository. Once designated, they can `push` and `pull` to your
|
||||
repositories. They will not be allowed to perform any administrative
|
||||
tasks such as deleting the repository or changing its status from
|
||||
private to public.
|
||||
|
||||
> **Note:** A collaborator can not add other collaborators. Only the owner of
|
||||
> **Note:**
|
||||
> A collaborator cannot add other collaborators. Only the owner of
|
||||
> the repository has administrative access.
|
||||
|
||||
### Webhooks
|
||||
You can also collaborate on Docker Hub with organizations and groups.
|
||||
You can read more about that [here](accounts/).
|
||||
|
||||
You can configure webhooks on the repository settings page. A webhook is called
|
||||
only after a successful `push` is made. The webhook calls are HTTP POST requests
|
||||
with a JSON payload similar to the example shown below.
|
||||
## Official Repositories
|
||||
|
||||
The Docker Hub contains a number of [official
|
||||
repositories](http://registry.hub.docker.com/official). These are
|
||||
certified repositories from vendors and contributors to Docker. They
|
||||
contain Docker images from vendors like Canonical, Oracle, and Red Hat
|
||||
that you can use to build applications and services.
|
||||
|
||||
If you use Official Repositories you know you're using a supported,
|
||||
optimized and up-to-date image to power your applications.
|
||||
|
||||
> **Note:**
|
||||
> If you would like to contribute an official repository for your
|
||||
> organization, product or team you can see more information
|
||||
> [here](https://github.com/dotcloud/stackbrew).
|
||||
|
||||
## Private Docker Repositories
|
||||
|
||||
Private repositories allow you to have repositories that contain images
|
||||
that you want to keep private, either to your own account or within an
|
||||
organization or group.
|
||||
|
||||
To work with a private repository on [Docker
|
||||
Hub](https://hub.docker.com), you will need to add one via the [Add
|
||||
Repository](https://registry.hub.docker.com/account/repositories/add/)
|
||||
link. You get one private repository for free with your Docker Hub
|
||||
account. If you need more accounts you can upgrade your [Docker
|
||||
Hub](https://registry.hub.docker.com/plans/) plan.
|
||||
|
||||
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 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
|
||||
designate (i.e., collaborators) from its Settings page. From there, you
|
||||
can also switch repository status (*public* to *private*, or
|
||||
vice-versa). You will need to have an available private repository slot
|
||||
open before you can do such a switch. If you don't have any available,
|
||||
you can always upgrade your [Docker
|
||||
Hub](https://registry.hub.docker.com/plans/) plan.
|
||||
|
||||
## Webhooks
|
||||
|
||||
You can configure webhooks for your repositories on the Repository
|
||||
Settings page. A webhook is called only after a successful `push` is
|
||||
made. The webhook calls are HTTP POST requests with a JSON payload
|
||||
similar to the example shown below.
|
||||
|
||||
> **Note:** For testing, you can try an HTTP request tool like
|
||||
> [requestb.in](http://requestb.in/).
|
||||
|
@ -95,3 +138,7 @@ with a JSON payload similar to the example shown below.
|
|||
"repo_name":"username/reponame"
|
||||
}
|
||||
}
|
||||
|
||||
Webhooks allow you to notify people, services and other applications of
|
||||
new updates to your images and repositories.
|
||||
|
||||
|
|
BIN
docs/sources/docker-hub/repos.png
Normal file
BIN
docs/sources/docker-hub/repos.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 112 KiB |
|
@ -9,7 +9,7 @@ page_keywords: documentation, docs, the docker guide, docker guide, docker, dock
|
|||
In this section we're going to introduce you, very quickly!, to
|
||||
[Docker Hub](https://hub.docker.com) and create an account.
|
||||
|
||||
[Docker Hub](https://www.docker.io) is the central hub for Docker. It
|
||||
[Docker Hub](https://hub.docker.com) is the central hub for Docker. It
|
||||
helps you to manage Docker and its components. It provides services such
|
||||
as:
|
||||
|
||||
|
|
Loading…
Reference in a new issue