diff --git a/docker-hub/download-rate-limit.md b/docker-hub/download-rate-limit.md index aa6356c1b0..363d0acb27 100644 --- a/docker-hub/download-rate-limit.md +++ b/docker-hub/download-rate-limit.md @@ -1,16 +1,18 @@ --- -description: Download rate limit -keywords: Docker, pull requests, download, limit, -title: Download rate limit +description: Learn how download rate limits for image pulls on Docker Hub work +keywords: Docker Hub, pulls, download, limit, +title: Docker Hub rate limit --- ## What's the download rate limit on Docker Hub? -Docker Hub limits the number of Docker image downloads, or pulls based on the account type of the user pulling the image. Pull rate limits are based on individual IP address. +Docker Hub limits the number of Docker image downloads, or pulls, based on the account type of the user pulling the image. Pull rate limits are based on individual IP address. -For anonymous users, the rate limit is set to 100 pulls per 6 hours per IP address. -For [authenticated](#how-do-i-authenticate-pull-requests) users, it's 200 pulls per 6 hour period. -Users with a paid [Docker subscription](https://www.docker.com/pricing){: target="_blank" rel="noopener" class="_"} get up to 5000 pulls per day. +| User type | Rate limit | +| --------- | ---------- | +| Anonymous users | 100 pulls per 6 hours per IP address | +| [Authenticated users](#how-do-i-authenticate-pull-requests)| 200 pulls per 6 hour period | +| Users with a paid [Docker subscription](https://www.docker.com/pricing){: target="_blank" rel="noopener" class="_"} | Up to 5000 pulls per day | If you require a higher number of pulls, you can also purchase an [Enhanced Service Account add-on](service-accounts.md#enhanced-service-account-add-on-pricing). @@ -97,7 +99,7 @@ If you don't see any RateLimit header, it could be because the image or your IP To take advantage of the higher limits included in a paid Docker subscription, you must [authenticate pulls](#how-do-i-authenticate-pull-requests) with your user account. -A Pro, Team, or a Business tier doesn't increase limits on your images for other users. See our [Open Source](https://www.docker.com/blog/expanded-support-for-open-source-software-projects/){: target="_blank" rel="noopener" class="_"}, [Publisher](https://www.docker.com/partners/programs){: target="_blank" rel="noopener" class="_"}, or [Large Organization](https://www.docker.com/pricing){: target="_blank" rel="noopener" class="_"} offerings. +A Pro, Team, or a Business tier doesn't increase limits on your images for other users. See Docker's [Open Source](https://www.docker.com/blog/expanded-support-for-open-source-software-projects/){: target="_blank" rel="noopener" class="_"}, [Publisher](https://www.docker.com/partners/programs){: target="_blank" rel="noopener" class="_"}, or [Large Organization](https://www.docker.com/pricing){: target="_blank" rel="noopener" class="_"} offerings. ## How do I authenticate pull requests? @@ -111,23 +113,23 @@ Select **Sign in / Create Docker ID** from the Docker Desktop menu and follow th ### Docker Engine -If you are using a standalone version of Docker Engine, run the `docker login` command from a terminal to authenticate with Docker Hub. For information on how to use the command, see [docker login](../engine/reference/commandline/login.md). +If you're using a standalone version of Docker Engine, run the `docker login` command from a terminal to authenticate with Docker Hub. For information on how to use the command, see [docker login](../engine/reference/commandline/login.md). ### Docker Swarm -If you are running Docker Swarm, you must use the `-- with-registry-auth` flag to authenticate with Docker Hub. For more information, see [docker service create](../engine/reference/commandline/service_create.md/#create-a-service). If you are using a Docker Compose file to deploy an application stack, see [docker stack deploy](../engine/reference/commandline/stack_deploy.md). +If you're running Docker Swarm, you must use the `-- with-registry-auth` flag to authenticate with Docker Hub. For more information, see [Create a service](../engine/reference/commandline/service_create.md/#create-a-service). If you are using a Docker Compose file to deploy an application stack, see [docker stack deploy](../engine/reference/commandline/stack_deploy.md). ### GitHub Actions -If you are using GitHub Actions to build and push Docker images to Docker Hub, see [login action](https://github.com/docker/login-action#dockerhub){: target="_blank" rel="noopener" class="_"}. If you are using another Action, you must add your username and access token in a similar way for authentication. +If you're using GitHub Actions to build and push Docker images to Docker Hub, see [login action](https://github.com/docker/login-action#dockerhub){: target="_blank" rel="noopener" class="_"}. If you are using another Action, you must add your username and access token in a similar way for authentication. ### Kubernetes -If you are running Kubernetes, follow the instructions in [Pull an Image from a Private Registry](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/){: target="_blank" rel="noopener" class="_"} for information on authentication. +If you're running Kubernetes, follow the instructions in [Pull an Image from a Private Registry](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/){: target="_blank" rel="noopener" class="_"} for information on authentication. ### Third-party platforms -If you are using any third-party platforms, follow your provider’s instructions on using registry authentication. +If you're using any third-party platforms, follow your provider’s instructions on using registry authentication. - [Artifactory](https://www.jfrog.com/confluence/display/JFROG/Advanced+Settings#AdvancedSettings-RemoteCredentials){: target="_blank" rel="noopener" class="_"} - [AWS CodeBuild](https://aws.amazon.com/blogs/devops/how-to-use-docker-images-from-a-private-registry-in-aws-codebuild-for-your-build-environment/){: target="_blank" rel="noopener" class="_"} @@ -145,7 +147,7 @@ If you are using any third-party platforms, follow your provider’s instruction Docker Hub also has an overall rate limit to protect the application and infrastructure. This limit applies to all requests to Hub -properties including web pages, APIs, image pulls. The limit is +properties including web pages, APIs, and image pulls. The limit is applied per-IP, and while the limit changes over time depending on load and other factors, it's in the order of thousands of requests per minute. The overall rate limit applies to all users equally diff --git a/docker-hub/dsos-program.md b/docker-hub/dsos-program.md index cfaa5f2df4..515e200bbf 100644 --- a/docker-hub/dsos-program.md +++ b/docker-hub/dsos-program.md @@ -1,5 +1,5 @@ --- -description: Docker-Sponsored Open Source Program +description: Learn about the Docker-Sponsored Open Source Program and how it works title: Docker-Sponsored Open Source Program keywords: docker hub, hub, insights, analytics, open source, Docker sponsored, program --- @@ -23,7 +23,7 @@ The program grants the following perks to eligible projects: - Removal of rate limiting for developers - Improved discoverability on Docker Hub -These benefits are valid for one year and publishers can renew annually if the project still meets the program requirements. Program members, and all users pulling public images from the project namespace get access to unlimited pulls and unlimited egress. +These benefits are valid for one year and publishers can renew annually if the project still meets the program requirements. Program members and all users pulling public images from the project namespace get access to unlimited pulls and unlimited egress. ### Repository logo @@ -42,7 +42,7 @@ over the repository can change the repository logo. #### Set the repository logo -1. Sign in to Docker Hub. +1. Sign in to [Docker Hub](https://hub.docker.com){: target="_blank" rel="noopener" class="_"}. 2. Go to the page of the repository that you want to change the logo for. 3. Select the upload logo button, represented by a camera icon (![Camera icon](images/upload_logo_sm.png){: .inline height="22px" }) @@ -52,9 +52,9 @@ over the repository can change the repository logo. #### Remove the logo -Remove a logo using the clear button (![Clear button](images/clear_logo_sm.png){: .inline width="20px" }). +Select the **Clear** button (![Clear button](images/clear_logo_sm.png){: .inline width="20px" }) to remove a logo. -Removing the logo makes the repository fallback to using the organization logo, if set, and the default logo if not. +Removing the logo makes the repository default to using the organization logo, if set, or the following default logo if not. ![Default logo which is a 3D grey cube](images/default_logo_sm.png){: width="50px" } @@ -74,8 +74,7 @@ geolocation, cloud provider, client, and more. ![The insights and analytics tab on the Docker Hub website](images/insights-and-analytics-tab.png) -You can use the view to select the time span you want to view analytics data and export the data in -either a summary or raw format. +You can select the time span for which you want to view analytics data. You can also export the data in either a summary or raw format. ### Vulnerability analysis @@ -84,9 +83,8 @@ for DVP images published to Docker Hub. Scanning images ensures that the published content is secure, and proves to developers that they can trust the image. -Analysis is enabled on a per-repository -basis, refer to [vulnerability scanning](/docker-hub/vulnerability-scanning/) for more information about how to use -it. +You can enable analysis on a per-repository +basis. For more about using this feature, see [Basic vulnerability scanning](/docker-hub/vulnerability-scanning/). > **Note** > diff --git a/docker-hub/dvp-program.md b/docker-hub/dvp-program.md index 32fd272dab..2c2bbf430f 100644 --- a/docker-hub/dvp-program.md +++ b/docker-hub/dvp-program.md @@ -1,5 +1,5 @@ --- -description: Docker Verified Publisher Program +description: Learn what the Docker Verified Publisher Program is and how it works title: Docker Verified Publisher Program redirect_from: - /docker-store/byol/ @@ -60,7 +60,7 @@ over the repository can change the repository logo. #### Set the repository logo -1. Sign in to Docker Hub. +1. Sign in to [Docker Hub](https://hub.docker.com){: target="_blank" rel="noopener" class="_"}. 2. Go to the page of the repository that you want to change the logo for. 3. Select the upload logo button, represented by a camera icon (![Camera icon](./images/upload_logo_sm.png){: .inline height="22px" }) @@ -70,9 +70,9 @@ over the repository can change the repository logo. #### Remove the logo -Remove a logo using the clear button (![Clear button](images/clear_logo_sm.png){: .inline width="20px" }). +Select the **Clear** button (![Clear button](images/clear_logo_sm.png){: .inline width="20px" }) to remove a logo. -Removing the logo makes the repository fallback to using the organization logo, if set, and the default logo if not. +Removing the logo makes the repository default to using the organization logo, if set, or the following default logo if not. ![Default logo which is a 3D grey cube](images/default_logo_sm.png){: width="50px" } @@ -93,8 +93,7 @@ geolocation, cloud provider, client, and more. ![The insights and analytics tab on the Docker Hub website](./images/insights-and-analytics-tab.png) -You can use the view to select the time span you want to view analytics data and export the data in -either a summary or raw format. +You can select the time span for which you want to view analytics data. You can also export the data in either a summary or raw format. ### Vulnerability analysis @@ -103,9 +102,8 @@ for DVP images published to Docker Hub. Scanning images ensures that the published content is secure, and proves to developers that they can trust the image. -Analysis is enabled on a per-repository -basis, refer to [vulnerability scanning](/docker-hub/vulnerability-scanning/) for more information about how to use -it. +You can enable analysis on a per-repository +basis. For more about using this feature, see [Basic vulnerability scanning](/docker-hub/vulnerability-scanning/). ### Who's eligible to become a verified publisher? diff --git a/docker-hub/index.md b/docker-hub/index.md index b55902384e..4653710b11 100644 --- a/docker-hub/index.md +++ b/docker-hub/index.md @@ -1,12 +1,12 @@ --- -description: Docker Hub overview +description: Learn about Docker Hub features and the administrative tasks available in Docker Hub keywords: Docker, docker, docker hub, hub, overview -title: Overview +title: Overview of Docker Hub --- Docker Hub is a service provided by Docker for finding and sharing container images. -It's the world’s largest repository of container images with an array of content sources including container community developers, open source projects and independent software vendors (ISV) building and distributing their code in containers. +It's the world’s largest repository of container images with an array of content sources including container community developers, open source projects, and independent software vendors (ISV) building and distributing their code in containers. Docker Hub is also where you can go to [change your Docker account settings and carry out administrative tasks](admin-overview.md). @@ -49,14 +49,14 @@ GitHub and Bitbucket and push them to Docker Hub.
-* [Create and manage teams & organizations](orgs.md) +* [Create and manage teams and organizations](orgs.md) * [Create a company](creating-companies.md) * [Enforce sign in](configure-sign-in.md) * Set up [SSO](../single-sign-on/index.md) and [SCIM](scim.md) * Use [Group mapping](group-mapping.md) * [Carry out domain audits](domain-audit.md) * [Use Image Access Management](image-access-management.md) to control developers' access to certain types of images -* [Enable Registry Access Management](../desktop/hardened-desktop/registry-access-management.md) +* [Turn on Registry Access Management](../desktop/hardened-desktop/registry-access-management.md)
@@ -70,7 +70,7 @@ GitHub and Bitbucket and push them to Docker Hub. Docker ID

Create an account

-

Sign up and create a new Docker ID

+

Register and create a new Docker ID

diff --git a/docker-hub/insights-analytics.md b/docker-hub/insights-analytics.md index b3ac2d1b62..bd2a101a8f 100644 --- a/docker-hub/insights-analytics.md +++ b/docker-hub/insights-analytics.md @@ -1,16 +1,13 @@ --- title: Insights and analytics -description: Provides usage statistics of your images on Docker Hub. +description: Discover how to access usage statistics of your images on Docker Hub keywords: docker hub, hub, insights, analytics, api, verified publisher redirect_from: - /docker-hub/publish/insights-analytics/ --- Insights and analytics provides usage analytics for Docker Verified -Publisher (DVP) and Docker-Sponsored Open Source (DSOS) images on Docker Hub, providing self-serve access -to metrics as both raw data and summary data for a desired time span. You can -view the number of image pulls by tag or by digest, and get breakdowns by -geolocation, cloud provider, client, and more. +Publisher (DVP) and Docker-Sponsored Open Source (DSOS) images on Docker Hub. This includes self-serve access to metrics as both raw data and summary data for a desired time span. You can view the number of image pulls by tag or by digest, and get breakdowns by geolocation, cloud provider, client, and more. > **Tip** @@ -45,7 +42,7 @@ To view data in the chart: ### Share analytics data -You can share the visualization with others using the share icon above the chart. +You can share the visualization with others using the **Share** icon above the chart. This is a convenient way to share statistics with others in your organization. ![Chart share icon](./images/chart-share-icon.png) diff --git a/docker-hub/quickstart.md b/docker-hub/quickstart.md index f922c8db10..5f8569d32a 100644 --- a/docker-hub/quickstart.md +++ b/docker-hub/quickstart.md @@ -1,5 +1,5 @@ --- -description: Docker Hub Quickstart +description: Learn how to get started using Docker Hub keywords: Docker, docker, registry, accounts, plans, Dockerfile, Docker Hub, accounts, organizations, repositories, groups, teams title: Docker Hub Quickstart redirect_from: @@ -82,7 +82,7 @@ The following section contains step-by-step instructions on how to get started w 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. +A Docker ID grants you access to Docker Hub repositories and lets you explore available images from the community and verified publishers. You also need a Docker ID to share images on Docker Hub. ### Step 2: Create your first repository diff --git a/docker-hub/repos/access/index.md b/docker-hub/repos/access/index.md index f55d0acaf2..431e6e4922 100644 --- a/docker-hub/repos/access/index.md +++ b/docker-hub/repos/access/index.md @@ -1,5 +1,5 @@ --- -description: Access repositories on Docker Hub +description: Discover how to access repositories on Docker Hub keywords: Docker, docker, trusted, registry, accounts, plans, Dockerfile, Docker Hub, webhooks, docs, documentation, collaborators, viewing, searching, starring title: Access repositories --- @@ -36,7 +36,7 @@ To delete a tag, select the corresponding checkbox and select **Delete** from th > Only a user with administrative access (owner or team member with Admin > permission) over the repository can delete tags. -You can select a tag's digest to view more details. +You can select a tag's digest to access more details. Image sizes are the cumulative space taken up by the image and all its parent images. This is also the disk space used by the contents of the `.tar` file @@ -59,7 +59,7 @@ tutum/centos Centos image with SSH access. For the root. ... ``` -In the example above, you can see two example results, `centos` and `ansible/centos7-ansible`. +In the previous example, you can see two example results, `centos` and `ansible/centos7-ansible`. The second result shows that it comes from the public repository of a user, named `ansible/`, while the first result, `centos`, doesn't explicitly list a diff --git a/docker-hub/repos/create.md b/docker-hub/repos/create.md index 5cdff4594a..6563b60126 100644 --- a/docker-hub/repos/create.md +++ b/docker-hub/repos/create.md @@ -1,5 +1,5 @@ --- -description: Creating repositories on Docker Hub +description: Learn how to create repositories on Docker Hub keywords: Docker, docker, trusted, registry, accounts, plans, Dockerfile, Docker Hub, webhooks, docs, documentation, manage, repos title: Create repositories toc_max: 3 @@ -10,8 +10,7 @@ redirect_from: Repositories let you share container images with your team, customers, or the Docker community at large. -A single Docker Hub repository can hold many Docker images which are stored as **tags**. Docker images are pushed to Docker Hub through the [`docker push`](/engine/reference/commandline/push/) -command. +A single Docker Hub repository can hold many Docker images which are stored as **tags**. You can push Docker images to Docker Hub with the [`docker push`](/engine/reference/commandline/push/)command. ## Create a repository @@ -24,7 +23,7 @@ When creating a new repository: - You can choose to locate it under your own user account, or under any [organization](../../docker-hub/orgs.md) where you are an [owner](../manage-a-team.md#organization-owner). - The repository name needs to: - - Be unique + - Be unique - Have between 2 and 255 characters - Only contain lowercase letters, numbers, hyphens (`-`), and underscores (`_`) @@ -32,8 +31,8 @@ When creating a new repository: > > You can't rename a Docker Hub repository once it's created. -- The description can be up to 100 characters. It is used in the search results. -- If you are a Docker Verified Publisher (DVP) or Docker-Sponsored Open Source (DSOS) organization, you can also add a logo to a repository. The maximum size is 1000x1000. +- The description can be up to 100 characters. It's used in the search results. +- If you're a Docker Verified Publisher (DVP) or Docker-Sponsored Open Source (DSOS) organization, you can also add a logo to a repository. The maximum size in pixels is 1000x1000. - You can link a GitHub or Bitbucket account now, or choose to do it later in the repository settings. - You can set the repository's default visibility to public or private. @@ -44,35 +43,16 @@ When creating a new repository: ### Add a repository overview -Once you have created a repository, add an overview to the **Repository overview** field. This describes what your image does and how to use it. +Once you have created a repository, add an overview to the **Repository overview** field. This describes what your image does and how to use it. -
- -
-

A good image description is essential to help potential users understand why and how to use the image. The below covers the best practices to follow when adding a description to your image.

-

Describe the image

-

Include a description of what the image is, the features it offers, and why people might want or need to use it in their project or image.

-

Optional information to include are examples of usage, history, the team behind the project, etc.

-

How to start and use the image

-

Provide instructions for a minimal “getting started” example with running a container using the image. Also provide a minimal example of how to use the image in a Dockerfile.

-

Optional information to include, if relevant, is:

-
    -
  • Exposing ports
  • -
  • Default environment variables
  • -
  • Non-root user
  • -
  • Running in debug mode
  • -
-

Image tags and variants

-

List the key image variants and the tags for using them along with what that variant offers and why someone might want to use that variant.

-

Where to find more information

-

Add links here for docs and support sites, communities, or mailing lists where users can find more and ask questions.

-

Who is the image maintained by and how can someone contact them with concerns.

-

License

-

What is the license for the image and where can people find more details if needed.

-
-
+Consider the following repository overview best practices. + +- Describe what the image is, the features it offers, and why it should be used. Can include examples of usage or the team behind the project. +- Explain how to get started with running a container using the image. You can include a minimal example of how to use the image in a Dockerfile. +- List the key image variants and tags to use them, as well as use cases for the variants. +- Link to documentation or support sites, communities, or mailing lists for additional resources. +- Provide contact information for the image maintainers. +- Include the license for the image and where to find more details if needed. ## Push a Docker container image to Docker Hub @@ -86,11 +66,11 @@ If you want to add multiple images to a repository, add a specific `:` to t Name your local images using one of these methods: -- When you build them, using `docker build -t /[:]` -- By re-tagging an existing local image `docker tag /[:]` -- By using `docker commit /[:]` to commit changes +- When you build them, using `docker build -t /[:` +- By re-tagging the existing local image with `docker tag /[:]`. +- By using `docker commit /[:]` to commit changes. -Now you can push this image to the repository designated by its name or tag: +Then, you can push this image to the repository designated by its name or tag: ```console $ docker push /: diff --git a/docker-hub/repos/index.md b/docker-hub/repos/index.md index 204cc37d62..4593d82f66 100644 --- a/docker-hub/repos/index.md +++ b/docker-hub/repos/index.md @@ -1,5 +1,5 @@ --- -description: Using repositories on Docker Hub +description: Learn how to use repositories on Docker Hub keywords: Docker, docker, trusted, registry, accounts, plans, Dockerfile, Docker Hub, webhooks, docs, documentation, manage, repos title: Manage repositories redirect_from: diff --git a/docker-id/index.md b/docker-id/index.md index 7016622a8b..7260a8b82d 100644 --- a/docker-id/index.md +++ b/docker-id/index.md @@ -1,5 +1,5 @@ --- -description: Sign up for a Docker ID and log in +description: Learn how to register for a Docker ID and log in to your account keywords: accounts, docker ID, billing, paid plans, support, Hub, Store, Forums, knowledge base, beta access, email, activation, verification title: Create an account redirect_from: @@ -49,7 +49,7 @@ stored in your home directory in `.docker/config.json`. The password is base64-e ## Troubleshooting -If you run into trouble with your Docker ID account, know that we are here to help! If you want to retrieve or reset your password, [enter your email address](https://id.docker.com/reset-password/){: target="_blank" rel="noopener" class="_"} for additional instructions. +If you run into trouble with your Docker ID account, know that we're here to help! If you want to retrieve or reset your password, [enter your email address](https://id.docker.com/reset-password/){: target="_blank" rel="noopener" class="_"} for additional instructions. You can use the [Docker forums](https://forums.docker.com/) to ask questions amongst other Docker community members, while our [hub-feedback GitHub repository](https://github.com/docker/hub-feedback) allows you to provide feedback on how we can better improve the experience with Docker Hub.