hub and admin: tier 1 refresh (#18118)

Signed-off-by: Craig Osterhout <craig.osterhout@docker.com>
This commit is contained in:
Craig Osterhout 2023-09-07 08:32:02 -07:00 committed by GitHub
parent b80744c552
commit 713c7e314d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
19 changed files with 50 additions and 50 deletions

View File

@ -1,7 +1,7 @@
--- ---
description: Single Sign-on description: Overview of Single Sign-On for companies.
keywords: Single Sign-on, SSO, sign-on keywords: Single Sign-On, SSO, sign-on
title: Single Sign-On overview title: Single Sign-On overview for companies
--- ---
{{< include "admin-early-access.md" >}} {{< include "admin-early-access.md" >}}

View File

@ -1,7 +1,7 @@
--- ---
description: Learn how about general settings for organizations. description: Learn how about general settings for organizations.
keywords: organization, settings keywords: organization, settings
title: General settings title: General organization settings
--- ---
{{< include "admin-early-access.md" >}} {{< include "admin-early-access.md" >}}

View File

@ -1,7 +1,7 @@
--- ---
description: Manage organization members description: Manage organization members
keywords: members, teams, organizations keywords: members, teams, organizations
title: Manage members title: Manage organization members
--- ---
{{< include "admin-early-access.md" >}} {{< include "admin-early-access.md" >}}

View File

@ -1,7 +1,7 @@
--- ---
description: Single sign-on overview description: Single Sign-On overview for organizations
keywords: Single sign-on, SSO, sign-on keywords: Single Sign-On, SSO, sign-on
title: Single Sign-On overview title: Single Sign-On overview for organizations
--- ---
{{< include "admin-early-access.md" >}} {{< include "admin-early-access.md" >}}

View File

@ -1,8 +1,8 @@
--- ---
description: Recover your Docker Hub account description: Recover your Docker account
keywords: Docker, docker, registry, security, Docker Hub, authentication, two-factor keywords: Docker, docker, registry, security, Docker Hub, authentication, two-factor
authentication authentication
title: Recover your Docker Hub account title: Recover your Docker account
--- ---
If you have lost access to both your two-factor authentication application and your recovery code: If you have lost access to both your two-factor authentication application and your recovery code:

View File

@ -49,7 +49,7 @@ when the tests succeed.
5. Optional: Enable [autotests](automated-testing.md#enable-automated-tests-on-a-repository). 5. Optional: Enable [autotests](automated-testing.md#enable-automated-tests-on-a-repository).
6. Review the default **Build Rules** 6. Review the default **Build Rules**.
Build rules control what Docker Hub builds into images from the contents Build rules control what Docker Hub builds into images from the contents
of the source code repository, and how the resulting images are tagged of the source code repository, and how the resulting images are tagged
@ -231,7 +231,7 @@ Docker build system, add the [environment variable](index.md#environment-variabl
`DOCKER_BUILDKIT=0`. Refer to the [BuildKit](../../build/buildkit/index.md) `DOCKER_BUILDKIT=0`. Refer to the [BuildKit](../../build/buildkit/index.md)
page for more information on BuildKit. page for more information on BuildKit.
## Autobuild for Teams ## Autobuild for teams
When you create an automated build repository in your own user account, you When you create an automated build repository in your own user account, you
can start, cancel, and retry builds, and edit and delete your own repositories. can start, cancel, and retry builds, and edit and delete your own repositories.

View File

@ -103,11 +103,11 @@ The following hooks are available:
Docker Hub allows you to define build environment variables either in the hook Docker Hub allows you to define build environment variables either in the hook
files, or from the automated build interface, which you can then reference in hooks. files, or from the automated build interface, which you can then reference in hooks.
In the following example, we define a build hook that uses `docker build` arguments The following example defines a build hook that uses `docker build` arguments to
to set the variable `CUSTOM` based on the value of variable we defined using the set the variable `CUSTOM` based on the value of variable defined using the
Docker Hub build settings. `$DOCKERFILE_PATH` is a variable that we provide with Docker Hub build settings. `$DOCKERFILE_PATH` is a variable that you provide
the name of the Dockerfile we wish to build, and `$IMAGE_NAME` is the name of with the name of the Dockerfile you want to build, and `$IMAGE_NAME` is the name
the image being built. of the image being built.
```console ```console
$ docker build --build-arg CUSTOM=$VAR -f $DOCKERFILE_PATH -t $IMAGE_NAME . $ docker build --build-arg CUSTOM=$VAR -f $DOCKERFILE_PATH -t $IMAGE_NAME .
@ -122,7 +122,7 @@ the automated build fails.
Refer to the [docker build documentation](../../engine/reference/commandline/build.md#build-arg) Refer to the [docker build documentation](../../engine/reference/commandline/build.md#build-arg)
to learn more about Docker build-time variables. to learn more about Docker build-time variables.
#### Push to multiple repos #### Push to multiple repositories
By default the build process pushes the image only to the repository where the By default the build process pushes the image only to the repository where the
build settings are configured. If you need to push the same image to multiple build settings are configured. If you need to push the same image to multiple
@ -137,7 +137,7 @@ $ docker push $DOCKER_REPO:$SOURCE_COMMIT
## Source repository or branch clones ## Source repository or branch clones
When Docker Hub pulls a branch from a source code repository, it performs When Docker Hub pulls a branch from a source code repository, it performs
a shallow clone, it clones only the tip of the specified branch. This has the advantage a shallow clone, it clones only the tip of the specified branch. This has the advantage
of minimizing the amount of data transfer necessary from the repository and of minimizing the amount of data transfer necessary from the repository and
speeding up the build because it pulls only the minimal code necessary. speeding up the build because it pulls only the minimal code necessary.

View File

@ -65,7 +65,7 @@ in the `test.yml` files.
## Enable Automated tests on a repository ## Enable Automated tests on a repository
To enable testing on a source code repository, you must first create an To enable testing on a source code repository, you must first create an
associated build-repository in Docker Hub. Your `Autotest` settings are associated build-repository in Docker Hub. Your `Autotest` settings are
configured on the same page as [automated builds](index.md), however configured on the same page as [automated builds](index.md), however
you do not need to enable Autobuilds to use `Autotest`. Autobuild is enabled per you do not need to enable Autobuilds to use `Autotest`. Autobuild is enabled per
branch or tag, and you do not need to enable it at all. branch or tag, and you do not need to enable it at all.

View File

@ -2,7 +2,7 @@
description: Link to GitHub and BitBucket description: Link to GitHub and BitBucket
keywords: Docker, docker, registry, accounts, plans, Dockerfile, Docker Hub, trusted, keywords: Docker, docker, registry, accounts, plans, Dockerfile, Docker Hub, trusted,
builds, trusted builds, automated builds, GitHub builds, trusted builds, automated builds, GitHub
title: Configure Automated builds from GitHub and BitBucket title: Configure automated builds from GitHub and BitBucket
aliases: aliases:
- /docker-hub/github/ - /docker-hub/github/
- /docker-hub/bitbucket/ - /docker-hub/bitbucket/
@ -29,7 +29,7 @@ If you are linking a source code provider to create autobuilds for a team, follo
3. Select **Link provider** for the source provider you want to link. 3. Select **Link provider** for the source provider you want to link.
If you want to unlink your current GitHub account and relink to a new GitHub account, make sure to completely logout of [GitHub](https://github.com/) before linking via Docker Hub. If you want to unlink your current GitHub account and relink to a new GitHub account, make sure to completely sign out of [GitHub](https://github.com/) before linking via Docker Hub.
4. Review the settings for the **Docker Hub Builder** OAuth application. 4. Review the settings for the **Docker Hub Builder** OAuth application.
@ -83,12 +83,12 @@ To revoke Docker Hub's access to an organization's GitHub repositories:
1. From your GitHub Account settings, locate the **Organization settings** section at the lower left. 1. From your GitHub Account settings, locate the **Organization settings** section at the lower left.
2. Click the organization you want to revoke Docker Hub's access to. 2. Select the organization you want to revoke Docker Hub's access to.
3. From the Organization Profile menu, click **Third-party access**. 3. From the Organization Profile menu, select **Third-party access**.
The page displays a list of third party applications and their access status. The page displays a list of third party applications and their access status.
4. Click the pencil icon next to Docker Hub Builder. 4. Select the pencil icon next to Docker Hub Builder.
5. On the next page, select **Deny access**. 5. On the next page, select **Deny access**.

View File

@ -1,5 +1,5 @@
--- ---
title: Troubleshoot your builds title: Troubleshoot your autobuilds
description: How to troubleshoot Automated builds description: How to troubleshoot Automated builds
keywords: docker hub, troubleshoot, automated builds, autobuilds keywords: docker hub, troubleshoot, automated builds, autobuilds
--- ---

View File

@ -2,7 +2,7 @@
description: Configure registry.json to enforce users to sign into Docker Desktop description: Configure registry.json to enforce users to sign into Docker Desktop
toc_max: 2 toc_max: 2
keywords: authentication, registry.json, configure, keywords: authentication, registry.json, configure,
title: Configure registry.json to enforce sign-in title: Enforce sign-in for Desktop
--- ---
By default, members of your organization can use Docker Desktop on their machines without signing in to any Docker account. To ensure that a user signs in to a Docker account that is a member of your organization and that the By default, members of your organization can use Docker Desktop on their machines without signing in to any Docker account. To ensure that a user signs in to a Docker account that is a member of your organization and that the

View File

@ -7,7 +7,7 @@ keywords: docker hub, hub, organization
You can convert an existing user account to an organization. This is useful if you need multiple users to access your account and the repositories that its connected to. Converting it to an organization gives you better control over permissions for these users through [teams](manage-a-team.md). You can convert an existing user account to an organization. This is useful if you need multiple users to access your account and the repositories that its connected to. Converting it to an organization gives you better control over permissions for these users through [teams](manage-a-team.md).
When you convert a user account to an organization, the account When you convert a user account to an organization, the account
is migrated to a Team plan and charged $35 per month for 5 seats. For more information, is migrated to a Team plan that requires a paid subscription. For more information,
see [Docker Pricing](https://www.docker.com/pricing). see [Docker Pricing](https://www.docker.com/pricing).
> **Important** > **Important**
@ -30,7 +30,7 @@ Before you convert a user account to an organization, ensure that you meet the f
- You must have a separate Docker ID ready to assign it as the owner of the organization during conversion. - You must have a separate Docker ID ready to assign it as the owner of the organization during conversion.
If you wish to convert your user account into an organization account and you do not have any other user accounts, you need to create a new user account to assign it as the owner of the new organization. With the owner role assigned, this user account has full administrative access to configure and manage the organization. You can assign more users the owner role after the conversion. If you want to convert your user account into an organization account and you don't have any other user accounts, you need to create a new user account to assign it as the owner of the new organization. With the owner role assigned, this user account has full administrative access to configure and manage the organization. You can assign more users the owner role after the conversion.
## Convert an account into an organization ## Convert an account into an organization
@ -44,4 +44,4 @@ Before you convert a user account to an organization, ensure that you meet the f
5. Enter a **Docker ID** to set an organization owner. This is the user account that will manage the organization, and the only way to access the organization settings after conversion. You cannot use the same Docker ID as the account you are trying to convert. 5. Enter a **Docker ID** to set an organization owner. This is the user account that will manage the organization, and the only way to access the organization settings after conversion. You cannot use the same Docker ID as the account you are trying to convert.
6. Select **Convert and Purchase** to confirm. The new owner receives a notification email. Use that owner account to log in to your new organization. 6. Select **Convert and Purchase** to confirm. The new owner receives a notification email. Use that owner account to sign in to your new organization.

View File

@ -8,14 +8,14 @@ You can deactivate an account at any time.
>**Warning** >**Warning**
> >
> If your Docker Hub account or organization is linked to other Docker products and services, deactivating your account also removes access to those products and services. > All Docker products and services that use your Docker account or organization account will be inaccessible after deactivating your account.
{ .warning } { .warning }
## Deactivate a user account ## Deactivate a user account
### Prerequisites ### Prerequisites
Before deactivating your Docker Hub account, ensure that you meet the following requirements: Before deactivating your Docker account, ensure that you meet the following requirements:
- You must not be a member of a company or any teams or organizations. You must remove the account from all teams, organizations, or the company. - You must not be a member of a company or any teams or organizations. You must remove the account from all teams, organizations, or the company.
@ -45,7 +45,7 @@ Once you have completed all the steps above, you can deactivate your account.
## Deactivate an organization ## Deactivate an organization
Before deactivating an organization, please complete the following: Before deactivating an organization, complete the following:
- Download any images and tags you want to keep: - Download any images and tags you want to keep:
`docker pull -a <image>:<tag>`. `docker pull -a <image>:<tag>`.

View File

@ -6,7 +6,7 @@ title: Service accounts
> **Note** > **Note**
> >
> Service accounts requires a > Service accounts require a
> [Docker Team, or Business subscription](../subscription/index.md). > [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. 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,7 +49,7 @@ To create a new service account for your Team account:
> **Note** > **Note**
> >
> If you want a read-only PAT just for your open-source repos, or to access > If you want a read-only PAT just for your open-source repositories, or to access
official images and other public images, you don't have to grant any access permissions to the new Docker ID. official images and other public images, you don't have to grant any access permissions to the new Docker ID.
## Additional information ## Additional information
@ -57,4 +57,4 @@ official images and other public images, you don't have to grant any access perm
Refer to the following topics for additional information: Refer to the following topics for additional information:
- [Mirroring Docker Hub](../registry/recipes/mirror.md) - [Mirroring Docker Hub](../registry/recipes/mirror.md)
- [Resource Consumption Updates FAQ](https://www.docker.com/pricing/resource-consumption-updates) - [Docker pricing FAQs](https://www.docker.com/pricing/faq/)

View File

@ -10,18 +10,18 @@ You can use webhooks to cause an action in another service in response to a push
To create a webhook: To create a webhook:
1. In your chosen repository, select the **Webhooks** tab. 1. In your chosen repository, select the **Webhooks** tab.
2. Provide a name for the webhook 2. Provide a name for the webhook.
3. Provide a destination webhook URL. This is where webhook POST requests are delivered. 3. Provide a destination webhook URL. This is where webhook POST requests are delivered.
4. Select **Create**. 4. Select **Create**.
## View webhook delivery history ## View webhook delivery history
To view the history of the webhook: To view the history of the webhook:
1. Hover over your webhook under the **Current Webhooks section**. 1. Hover over your webhook under the **Current Webhooks section**.
2. Select the **Menu options** icon. 2. Select the **Menu options** icon.
3. Select **View History**. 3. Select **View History**.
You can then view the delivery history, and whether delivering the POST request was successful or not: You can then view the delivery history, and whether delivering the POST request was successful or not.
## Example webhook payload ## Example webhook payload
@ -79,7 +79,7 @@ The following parameters are recognized in callback data:
* `target_url`: The URL where the results of the operation can be found. Can be * `target_url`: The URL where the results of the operation can be found. Can be
retrieved on the Docker Hub. retrieved on the Docker Hub.
*Example callback payload:* The following is an example of a callback payload:
{ {
"state": "success", "state": "success",

View File

@ -1,7 +1,7 @@
--- ---
description: Single Sign-on description: Overview of Single Sign-On
keywords: Single Sign-on, SSO, sign-on keywords: Single Sign-On, SSO, sign-on
title: Overview title: Single Sign-On overview
--- ---
{{% admin-sso product="hub" %}} {{% admin-sso product="hub" %}}

View File

@ -1,7 +1,7 @@
--- ---
description: SSO configuration description: Learn how to configure Single Sign-On for your organization or company.
keywords: configure, sso, docker hub, hub keywords: configure, sso, docker hub, hub
title: Configure title: Configure Single Sign-On
aliases: aliases:
- /docker-hub/domains/ - /docker-hub/domains/
- /docker-hub/sso-connection/ - /docker-hub/sso-connection/

View File

@ -1,7 +1,7 @@
--- ---
description: Manage SSO description: Learn how to manage Single Sign-On for your organization or company.
keywords: manage, single sign-on, SSO, sign-on keywords: manage, single sign-on, SSO, sign-on
title: Manage SSO title: Manage Single Sign-On
--- ---
## Manage organizations ## Manage organizations

View File

@ -6,7 +6,7 @@
{{ if eq (.Get "product") "admin" }} {{ if eq (.Get "product") "admin" }}
{{ $product_link = "[Docker Admin](https://admin.docker.com)" }} {{ $product_link = "[Docker Admin](https://admin.docker.com)" }}
{{ $domain_navigation := "Select your organization in the left navigation drop-down menu, and then select **Domain management**." }} {{ $domain_navigation = "Select your organization in the left navigation drop-down menu, and then select **Domain management**." }}
{{ if eq (.Get "layer") "company" }} {{ if eq (.Get "layer") "company" }}
{{ $domain_navigation = "Select your company in the left navigation drop-down menu, and then select **Domain management**." }} {{ $domain_navigation = "Select your company in the left navigation drop-down menu, and then select **Domain management**." }}
{{ end }} {{ end }}