centersl/docker-docs
1
0
Fork 0
mirror of https://github.com/docker/docs.git synced 2026-03-27 14:28:47 +07:00
Code Issues Packages Projects Releases Wiki Activity

ENGDOCS-1273 (#16960)

Browse Source 
* ENGDOCS-1273

* fix

* fix broken link
This commit is contained in:
Allie Sadler
2023-03-27 09:21:37 +01:00
committed by GitHub
parent f4258c0c1e
commit 3e6a00fdbd
5 changed files with 45 additions and 51 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
_data/toc.yaml
View File

@@ -1779,10 +1779,10 @@ manuals:
section:
- path: /docker-hub/
title: Overview
- path: /docker-id/
title: Create an account
- path: /docker-hub/quickstart/
title: Quickstart
- path: /docker-id/
title: Docker ID accounts
- sectiontitle: Repositories
section:
- path: /docker-hub/repos/create/

23
docker-hub/quickstart.md
View File

@@ -76,11 +76,11 @@ redirect_from:
- /apidocs/overview/
---
The following section contains step-by-step instructions on how to easily get started with Docker Hub.
The following section contains step-by-step instructions on how to get started with Docker Hub.
### Step 1: Sign up for a Docker account
Let's start by creating a [Docker ID](https://hub.docker.com/signup){: target="_blank" rel="noopener" class="_"}.
Start by creating a [Docker ID](https://hub.docker.com/signup){: target="_blank" rel="noopener" class="_"}.
A Docker ID grants you access to Docker Hub repositories and allows you to explore images that are available from the community and verified publishers. You'll also need a Docker ID to share images on Docker Hub.
@@ -89,29 +89,24 @@ A Docker ID grants you access to Docker Hub repositories and allows you to explo
To create a repository:
1. Sign in to [Docker Hub](https://hub.docker.com){: target="_blank" rel="noopener" class="_"}.
2. Click **Create a Repository** on the Docker Hub welcome page.
2. Select **Create a Repository** on the Docker Hub welcome page.
3. Name it **<your-username>/my-private-repo**.
4. Set the visibility to **Private**.
5. Select **Create**.
![Create a repository](images/index-create-repo.png)
5. Click **Create**.
You've created your first repository. You should see:
![Repository created](images/index-repo-created.png)
You've created your first repository.
### Step 3: Download and install Docker Desktop
You'll need to download Docker Desktop to build, push, and pull container images.
You need to download Docker Desktop to build, push, and pull container images.
1. Download and install [Docker Desktop](../desktop/index.md).
2. Sign in to the Docker Desktop application using the Docker ID you've just created.
2. Sign in to Docker Desktop using the Docker ID you created in step one.
### Step 4: Pull and run a container image from Docker Hub
1. Run `docker pull hello-world` to pull the image from Docker Hub. You should see output similar to:
1. In your terminal, run `docker pull hello-world` to pull the image from Docker Hub. You should see output similar to:
```console
$ docker pull hello-world
@@ -177,7 +172,7 @@ Docker image locally.
![Tag created](images/index-tag.png)
Congratulations! You've successfully:
You've successfully:
- Signed up for a Docker account
- Created your first repository

4
docker-hub/service-accounts.md
View File

@@ -3,6 +3,10 @@ description: Docker Service accounts
keywords: Docker, service, accounts, Docker Hub
title: Service accounts
---
> **Note**
>
> Service accounts requires a
> [Docker Team, or Business subscription](../subscription/index.md).
A service account is a Docker ID used for automated management of container images or containerized applications. Service accounts are typically used in automated workflows, and don't share Docker IDs with the members in the organization. Common use cases for service accounts include mirroring content on Docker Hub, or tying in image pulls from your CI/CD process.

49
docker-hub/webhooks.md
View File

@@ -1,36 +1,31 @@
---
description: Docker Hub Webhooks
keywords: Docker, webhooks, hub, builds
title: Docker Hub Webhooks
title: Webhooks
---
You can use webhooks to cause an action in another service in response to a push event in the repository. Webhooks are POST requests sent to a URL you define in Docker Hub.
Configure webhooks through the "Webhooks" tab on your Docker Hub repository:
## Create a webhook
![Webhooks page](images/webhooks-empty.png)
To create a webhook:
1. In your chosen respository, select the **Webhooks** tabThen:
2. Provide a name for the webhook
3. Provide a destination webhook URL. This is where webhook POST requests are delivered.
4. Select **Create**.
### Create Webhooks
## View webhook delivery history
To create a webhook, visit the webhooks tab for your repository. Then:
1. Provide a name for the webhooks
2. Provide a destination webhook URL. This is where webhook POST requests will be delivered:
To view the history of the webhook:
1. Hover over your webhook under the **Current Webhooks section**.
2. Select the **Menu options** icon.
3. Select **View History**.
![Create webhooks](images/webhooks-create.png)
You can then view the delivery history, and whether delivering the POST request was successful or not:
### View Webhook delivery history
## Example webhook payload
You can view Webhook Delivery History by clicking on the submenu of the webhook and then clicking "View History"
![Webhook delivery history](images/webhooks-submenu.png)
You can then view the delivery history, and whether delivering the POST request was successful or failed:
![Webhooks History](images/webhooks-history.png)
### Example Webhook payload
Docker Hub Webhook payloads have the following payload JSON format:
Webhook payloads have the following JSON format:
```json
{
@@ -60,23 +55,23 @@ Docker Hub Webhook payloads have the following payload JSON format:
}
```
### Validate a webhook callback
## Validate a webhook callback
To validate a callback in a webhook chain, you need to
To validate a callback in a webhook chain, you need to:
1. Retrieve the `callback_url` value in the request's JSON payload.
2. Send a POST request to this URL containing a valid JSON body.
> **Note**: A chain request is only considered complete once the last
> callback has been validated.
> **Note**
>
> A chain request is only considered complete once the last callback is validated.
#### Callback JSON data
### Callback JSON data
The following parameters are recognized in callback data:
* `state` (required): Accepted values are `success`, `failure`, and `error`.
If the state isn't `success`, the Webhook chain is interrupted.
If the state isn't `success`, the webhook chain is interrupted.
* `description`: A string containing miscellaneous information that is
available on Docker Hub. Maximum 255 characters.
* `context`: A string containing the context of the operation. Can be retrieved

16
docker-id/index.md
View File

@@ -1,27 +1,27 @@
---
description: Sign up for a Docker ID and log in
keywords: accounts, docker ID, billing, paid plans, support, Hub, Store, Forums, knowledge base, beta access, email, activation, verification
title: Docker ID accounts
title: Create an account
redirect_from:
- /docker-cloud/dockerid/
- /docker-hub/accounts/
---
Your free Docker ID grants you access to Docker Hub repositories and some beta programs. All you need is an email address.
All you need is an email address to create a Docker account. Once you've created your account with a unique Docker ID, you can access Docker Hub repositories and explore images that are available from the community and verified publishers.
## Register for a Docker ID
Your Docker ID becomes your username for hosted Docker services, and [Docker forums](https://forums.docker.com/).
Your Docker ID becomes your user namespace for hosted Docker services, and becomes your username on the [Docker forums](https://forums.docker.com/). To create a new Docker ID:
## Create a Docker ID
1. Go to the [Docker Hub signup page](https://hub.docker.com/signup/).
2. Enter a username that will become your Docker ID.
2. Enter a username.
Your Docker ID must be between 4 and 30 characters long, and can only contain numbers and lowercase letters. *Once you create your Docker ID you can't reuse it in the future if you deactivate this account*.
Your Docker ID must be between 4 and 30 characters long, and can only contain numbers and lowercase letters. Once you create your Docker ID you can't reuse it in the future if you deactivate this account.
3. Enter a unique, valid email address.
4. Enter a password that's at least 9 characters.
4. Enter a password that's at least 9 characters long.
5. Complete the Captcha verification and then select **Sign up**.
@@ -33,7 +33,7 @@ Your Docker ID becomes your user namespace for hosted Docker services, and becom
>
> You have limited actions available until you verify your email address.
## Log in
## Sign in
Once you register and verify your Docker ID email address, you can sign in to [Docker Hub](https://hub.docker.com).