Skip to content

Commit 435a720

Browse files
author
Jeffrey Morgan
committed
Re-write Orgs & Webhooks docs
1 parent dc62a08 commit 435a720

32 files changed

+178
-200
lines changed

_data/toc.yaml

+7-5
Original file line numberDiff line numberDiff line change
@@ -3628,17 +3628,19 @@ manuals:
36283628
- sectiontitle: Docker Hub
36293629
section:
36303630
- path: /docker-hub/
3631-
title: Get Started
3632-
- path: /docker-hub/accounts/
3633-
title: Docker ID
3631+
title: Quickstart
36343632
- path: /docker-hub/repos/
3635-
title: Public Repositories
3633+
title: Repositories
36363634
- path: /docker-hub/official_images/
36373635
title: Official Images
36383636
- path: /docker-hub/orgs/
36393637
title: Teams & Organizations
3638+
- path: /docker-hub/upgrade/
3639+
title: Upgrading your plan
36403640
- path: /docker-hub/webhooks/
3641-
title: Repository Webhooks
3641+
title: Webhooks
3642+
- path: /docker-hub/slack_integration/
3643+
title: Slack Integration
36423644
- sectiontitle: Builds
36433645
section:
36443646
- path: /docker-hub/builds/

docker-hub/accounts.md

-27
This file was deleted.
243 KB
Loading
222 KB
Loading

docker-hub/images/index-tag.png

180 KB
Loading

docker-hub/images/index-terminal.png

136 KB
Loading
207 KB
Loading

docker-hub/images/index-welcome.png

238 KB
Loading
Loading
199 KB
Loading

docker-hub/images/orgs-create.png

186 KB
Loading

docker-hub/images/orgs-list-repos.png

216 KB
Loading
198 KB
Loading
186 KB
Loading
203 KB
Loading
209 KB
Loading
178 KB
Loading
220 KB
Loading
215 KB
Loading

docker-hub/images/webhooks-create.png

222 KB
Loading

docker-hub/images/webhooks-empty.png

202 KB
Loading
217 KB
Loading
212 KB
Loading

docker-hub/images/webhooks.png

-45.4 KB
Binary file not shown.

docker-hub/index.md

+53-54
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
---
2-
description: Get Started with Docker Hub
2+
description: Docker Hub Quickstart
33
keywords: Docker, docker, registry, accounts, plans, Dockerfile, Docker Hub, docs, documentation, accounts, organizations, repositories, groups, teams
4-
title: Get Started with Docker Hub
4+
title: Docker Hub Quickstart
55
redirect_from:
66
- /docker-hub/overview/
77
- /apidocs/docker-cloud/
8+
- /docker-cloud/
89
- /docker-cloud/migration/
910
- /docker-cloud/migration/cloud-to-swarm/
1011
- /docker-cloud/migration/cloud-to-kube-aks/
@@ -72,84 +73,82 @@ redirect_from:
7273
- /docker-cloud/docker-errors-faq/
7374
- /docker-cloud/release-notes/
7475
- /docker-store/
75-
7676
---
7777

78-
[Docker Hub](https://hub.docker.com) is a service provided by Docker for finding and sharing container images with your team.
79-
80-
![Docker Hub Landing Page](/docker-hub/images/getting-started.png)
81-
82-
Docker Hub provides the following major features:
83-
84-
* [Repositories](/docker-hub/repos.md): Push and pull container images. Private
85-
repositories allow you to share container images with your team. Public
86-
repositories allow you to share them with anyone.
87-
* [Teams & Organizations](/docker-hub/orgs.md): Manage access to private repositories.
78+
[Docker Hub](https://hub.docker.com) is a service provided by Docker for finding and sharing container images with your team. It provides the following major features:
79+
* [Repositories](/docker-hub/repos.md): Push and pull container images.
80+
* [Teams & Organizations](/docker-hub/orgs.md): Manage access to private repositories of container images.
8881
* [Official Images](/docker-hub/official_images.md): Pull & use high-quality container images provided by Docker.
8982
* [Publisher Images](/docker-hub/publish/customer_faq.md): Pull & use high-quality container
9083
images provided by external vendors. Certified images also include support and guarantee
9184
compatibility with Docker Enterprise.
92-
* [Builds](/docker-hub/builds.md): Automatically build container images and push them to your repositories when you make changes to code in GitHub or BitBucket.
85+
* [Builds](/docker-hub/builds.md): Automatically build container images from GitHub and Bitbucket and push them to Docker Hub
9386
* [Webhooks](/docker-hub/webhooks.md): Trigger actions after a successful push
9487
to a repository to integrate Docker Hub with other services.
9588

9689

97-
## Sign up for Docker Hub
9890

99-
Start by creating an [account](/docker-hub/accounts.md) at [https://hub.docker.com](https://hub.docker.com).
91+
### Step 1: Sign up for Docker Hub
10092

101-
> **Note**: You can search for and pull Docker images from Hub without logging
102-
> in, however to push images or share them with your team, you must log in.
93+
Start by [creating an account](https://hub.docker.com/signup).
10394

104-
## Find & Pull an Official Image
95+
### Step 2: Create your first repository
10596

106-
Docker Hub contains a number of [Official
107-
Repositories](http://hub.docker.com/explore/). These are curated repositories from vendors and contributors to Docker. They contain Docker images from vendors like Canonical, Oracle, and Elastic that you can use as the basis to build your applications and services.
97+
To create a repo:
98+
1. Sign in to [Docker Hub](https://hub.docker.com)
99+
2. Click on Create Repository on the Docker Hub welcome page:
108100

109-
With Official Images you know you're using an optimized and
110-
up-to-date image that was built by experts to power your applications.
101+
![Welcome](images/index-welcome.png)
111102

112-
> **Note**: If you would like to contribute an Official Image for your
113-
> organization or product, see the documentation on
114-
> [Official Images on Docker Hub](/docker-hub/official_images.md) for more
115-
> information.
103+
3. Name it **<your_username>/my-first-repo** as shown below. Select **Private**:
116104

117-
## Create your first repository and push an image to it
105+
![Create Repository](images/index-create-repo.png)
118106

119-
To create a repo:
120-
1. Log into [Docker Hub](https://hub.docker.com)
121-
2. Click on Create Repositories on the home page:
122-
3. Name it <your namespace>/<redis>
107+
You've created your first repo. You should see:
108+
109+
![Repository Created](images/index-repo-created.png)
123110

124-
Next, we'll push an images
111+
### Step 3: Download and install Docker Desktop
125112

126-
1. Download [Docker Desktop](https://docker.com/get-started)
127-
2. `docker pull redis` to pull the Official **redis** image from Docker Hub
128-
3. `docker tag redis <namespace>/redis`
129-
4. `docker push <namespace>/redis`
113+
We'll need to download Docker Desktop to build and push a container image to Docker Hub.
130114

131-
(insert pic here)
115+
1. Download and install [Docker Desktop](https://docker.com/get-started). If on Linux, download [Docker Engine - Community](https://hub.docker.com/search?type=edition&offering=community)
116+
2. Open the terminal and sign in to Docker Hub on your computer by running `docker login`
132117

133-
## Upgrading your Plan
118+
### Step 4: Build and push an image to Docker Hub from your computer
134119

135-
Your Docker ID includes one private Docker Hub repository for free. If you need
136-
more private repositories, you can upgrade from your free account to a paid
137-
plan.
120+
1. Create a Dockerfile to specify your application by running:
138121

139-
To upgrade, log in to Docker Hub and click [Upgrade Plan](https://hub.docker.com/account/billing-plans/), in the dropdown menu.
122+
```shell
123+
cat > Dockerfile <<EOF
124+
FROM busybox
125+
CMD echo "Hello world! This is my first Docker image."
126+
EOF
127+
```
140128

141-
(insert pic here)
129+
More on Dockerfiles [here](https://docs.docker.com/engine/reference/builder/)
130+
131+
2. Run `docker build -t <your_username>/my-first-repo .` to build your Docker image
132+
3. Test your docker image locally by running `docker run <your_username>/my-first-repo`
133+
4. Run `docker push <your_username>/my-first-repo` to push your Docker image to Docker Hub
134+
135+
You should see something similar to:
136+
137+
![Terminal](images/index-terminal.png)
138+
139+
And in Docker Hub, your repository should have a new `latest` tag available under **Tags**:
140+
141+
![Tag Created](images/index-tag.png)
142+
143+
Congratulations! You've successfully:
144+
- Signed up for Docker Hub
145+
- Created your first repository
146+
- Built a Docker image on your computer
147+
- Pushed it to Docker Hub
142148

143149
### Next Steps
144150

145-
You've successfully create a repo and pushed a Docker image to it. Next:
146-
- Create an [Organization](/docker-hub/orgs.md) to use Docker Hub with your team.
147-
- Automatically build container images from code via [Builds](/docker-hub/builds/index.md).
151+
- Create an [Organization](orgs.md) to use Docker Hub with your team.
152+
- Automatically build container images from code via [Builds](builds/index.md).
148153
- [Explore](https://hub.docker.com/explore) Official & Publisher Images
149-
150-
### Docker Commands to Interact with Docker Hub
151-
Docker itself provides access to Docker Hub services via the
152-
[`docker search`](/engine/reference/commandline/search.md),
153-
[`pull`](/engine/reference/commandline/pull.md),
154-
[`login`](/engine/reference/commandline/login.md), and
155-
[`push`](/engine/reference/commandline/push.md) commands.
154+
- [Upgrade your plan](upgrade.md) to push additional private Docker images to Docker Hub

docker-hub/orgs.md

+61-30
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,88 @@
11
---
2-
description: Docker Hub Teams and Organizations
2+
description: Docker Hub Teams & Organizations
33
keywords: Docker, docker, registry, teams, organizations, plans, Dockerfile, Docker Hub, docs, documentation
4-
title: Organizations and teams in Docker Hub
4+
title: Teams & Organizations
55
redirect_from:
66
- /docker-cloud/orgs/
77
---
88

9-
Docker Hub [organizations](https://hub.docker.com/organizations/) let you create
10-
teams so you can give colleagues access to shared image repositories. A Docker
11-
Hub organization can contain public and private repositories just like a user
12-
account. Access to push or pull for these repositories is allocated by defining
13-
teams of users and then assigning team rights to specific repositories.
14-
Repository creation is limited to users in the organization owner's group. This
15-
allows you to distribute limited access Docker images, and to select which
16-
Docker Hub users can publish new images.
9+
Docker Hub Organizations let you create teams so you can give your team access to shared image repositories.
1710

18-
### Create an organization
11+
### How Organizations & Teams Work
1912

20-
You can see which organizations you belong to and add new organizations by
21-
clicking **Organizations** in the top nav bar.
13+
- **Organizations** are a collection of teams and repositories that can be managed together.
14+
- **Teams** are groups of Docker Hub users that belong to your organization.
2215

23-
![organizations](images/orgs.png)
16+
**Note:** in Docker Hub, users cannot be associated directly to an organization. They below only to teams within an the organization.
2417

25-
### Create a team
18+
### Creating an organization
2619

27-
Users in the "Owners" team of an organization can create and modify the
28-
membership of all teams.
20+
1. Start by clicking on [Organizations](https://cloud.docker.com/orgs) in Docker Hub
21+
2. Click on "Create Organization"
22+
3. Provide information about your organization:
2923

30-
Other users can only see teams they belong to.
24+
![Create Organization](images/orgs-create.png)
3125

32-
![teams](images/groups.png)
26+
You've created an organization. You'll see you have a team, the **owners** team with a single member (you!)
3327

34-
### Add a member to a team
28+
### The owners team
3529

36-
### Manage team permissions
30+
The **owners** team is a special team that has full access to all repositories in the Organization.
3731

38-
Use teams to manage who can interact with your repositories.
32+
Members of this team can:
33+
- Manage Organization settings and billing.
34+
- Create a team and modify the membership of any team
35+
- Access and modify any repository belonging to the Organization
3936

40-
You need to be a member of the organization's "Owners" team to create a new
41-
team, Hub repository, or automated build. As an "Owner", you then delegate the
42-
following repository access rights to a team using the "Collaborators" section
43-
of the repository view.
37+
### Creating a team
38+
39+
To create a team:
40+
41+
1. Go to your organization by clicking on **Organizations** in Docker Hub, and select your organization.
42+
2. Click **Create Team** ![Create Team](images/orgs-team-create.png)
43+
3. Fill out your team's information and click **Create** ![Create Modal](images/orgs-team-create-submit.png)
44+
45+
### Adding a member to a team
46+
47+
1. Visit your team's page in Docker Hub. Click on **Organizations** > **_Your Organization_** > **_Your Team Name_**
48+
2. Click on **Add User**
49+
3. Provide the user's Docker ID username _or_ email to add them to the team ![Add User to Team](images/orgs-team-add-user.png)
50+
51+
**Note:** you are not automatically added to teams created by your.
52+
53+
### Removing team members
54+
55+
To remove a member from a team, click the **x** next to their name:
56+
57+
![Add User to Team](images/orgs-team-remove-user.png)
58+
59+
### Giving a team access to a repository
60+
61+
To provide a team to access a repository:
62+
63+
1. Visit the repository list on Docker Hub by clicking on **Repositories**
64+
2. Select your organization in the namespace dropdown list
65+
3. Click the repository you'd like to edit ![Org Repos](images/orgs-list-repos.png)
66+
4. Click the **Permissions** tab
67+
5. Select the team, permissions level (more on this below) and click **+**
68+
6. Click the **+** button to add ![Add Repo Permissions for Team](images/orgs-add-team-permissions.png)
69+
70+
### Viewing a team's permissions for all repositories
71+
72+
To view a team's permissions over all repos:
73+
1. Click on **Organizations**, then select your organization and team.
74+
2. Click on the **Permissions** tab where you can view which repositories this team has access to ![Team Audit Permissions](images/orgs-audit-permissions.png)
75+
76+
77+
### Permissions Reference
4478

4579
Permissions are cumulative. For example, if you have Write permissions, you
4680
automatically have Read permissions:
4781

4882
- `Read` access allows users to view, search, and pull a private repository in the same way as they can a public repository.
49-
- `Write` access allows users to push to non-automated repositories on the Docker Hub.
83+
- `Write` access allows users to push to repositories on Docker Hub.
5084
- `Admin` access allows users to modify the repositories "Description", "Collaborators" rights, "Public/Private" visibility and "Delete".
5185

5286
> **Note**: A User who has not yet verified their email address only has
5387
> `Read` access to the repository, regardless of the rights their team
5488
> membership has given them.
55-
56-
57-
![Organization repository collaborators](images/org-repo-collaborators.png)

0 commit comments

Comments
 (0)