diff --git a/_includes/registry.md b/_includes/registry.md new file mode 100644 index 0000000000..3a3229a1e0 --- /dev/null +++ b/_includes/registry.md @@ -0,0 +1,8 @@ + + +> +> This page contains information about hosting your own registry using the +> open source Docker Registry. For information about Docker Hub, which offers a +> hosted registry with additional features such as teams, organizations, web +> hooks, automated builds, etc, see [Docker Hub](/docker-hub/). +{: .important } diff --git a/registry/compatibility.md b/registry/compatibility.md index 6462b55797..d162d8d4ff 100644 --- a/registry/compatibility.md +++ b/registry/compatibility.md @@ -4,6 +4,8 @@ keywords: registry, manifest, images, tags, repository, distribution, digest title: Registry compatibility --- +{% include registry.md %} + ## Synopsis If a manifest is pulled by _digest_ from a registry 2.3 with Docker Engine 1.9 and older, and the manifest was pushed with Docker Engine 1.10, a security check diff --git a/registry/deploying.md b/registry/deploying.md index 8616cac285..ab26d756a6 100644 --- a/registry/deploying.md +++ b/registry/deploying.md @@ -4,6 +4,8 @@ keywords: registry, on-prem, images, tags, repository, distribution, deployment title: Deploy a registry server --- +{% include registry.md %} + Before you can deploy a registry, you need to install Docker on the host. A registry is an instance of the `registry` image, and runs within Docker. diff --git a/registry/deprecated.md b/registry/deprecated.md index d3242b2521..a46b2c1fdc 100644 --- a/registry/deprecated.md +++ b/registry/deprecated.md @@ -4,6 +4,8 @@ keywords: registry, manifest, images, signatures, repository, distribution, dige title: Docker Registry deprecation --- +{% include registry.md %} + This document details functionality or components which are deprecated within the registry. diff --git a/registry/garbage-collection.md b/registry/garbage-collection.md index cc301c6a80..7683286501 100644 --- a/registry/garbage-collection.md +++ b/registry/garbage-collection.md @@ -4,6 +4,8 @@ keywords: registry, garbage, images, tags, repository, distribution title: Garbage collection --- +{% include registry.md %} + As of v2.4.0 a garbage collector command is included within the registry binary. This document describes what this command does and how and why it should be used. diff --git a/registry/help.md b/registry/help.md index da1f16f987..ea745f34e4 100644 --- a/registry/help.md +++ b/registry/help.md @@ -4,6 +4,8 @@ keywords: registry, on-prem, images, tags, repository, distribution, help, 101, title: Get help --- +{% include registry.md %} + If you need help, or just want to chat, you can reach us: - on the [Docker forums](https://forums.docker.com/c/open-source-projects/opensrcreg). diff --git a/registry/index.md b/registry/index.md index 5d05205a3a..a9158ee4c2 100644 --- a/registry/index.md +++ b/registry/index.md @@ -6,6 +6,8 @@ redirect_from: title: Docker Registry --- +{% include registry.md %} + ## What it is The Registry is a stateless, highly scalable server side application that stores diff --git a/registry/insecure.md b/registry/insecure.md index 7aa512a9ff..df630ee8c7 100644 --- a/registry/insecure.md +++ b/registry/insecure.md @@ -4,6 +4,8 @@ keywords: registry, on-prem, images, tags, repository, distribution, insecure title: Test an insecure registry --- +{% include registry.md %} + While it's highly recommended to secure your registry using a TLS certificate issued by a known CA, you can choose to use self-signed certificates, or use your registry over an unencrypted HTTP connection. Either of these choices diff --git a/registry/introduction.md b/registry/introduction.md index 471ad510d0..bb634861ad 100644 --- a/registry/introduction.md +++ b/registry/introduction.md @@ -4,6 +4,8 @@ keywords: registry, on-prem, images, tags, repository, distribution, use cases, title: About Registry --- +{% include registry.md %} + A registry is a storage and content delivery system, holding named Docker images, available in different tagged versions. diff --git a/registry/notifications.md b/registry/notifications.md index f11b53f15d..62854f8113 100644 --- a/registry/notifications.md +++ b/registry/notifications.md @@ -4,6 +4,8 @@ keywords: registry, on-prem, images, tags, repository, distribution, notificatio title: Work with notifications --- +{% include registry.md %} + The Registry supports sending webhook notifications in response to events happening within the registry. Notifications are sent in response to manifest pushes and pulls and layer pushes and pulls. These actions are serialized into diff --git a/registry/recipes/apache.md b/registry/recipes/apache.md index b559d26485..45a10c66b1 100644 --- a/registry/recipes/apache.md +++ b/registry/recipes/apache.md @@ -4,6 +4,8 @@ keywords: registry, on-prem, images, tags, repository, distribution, authenticat title: Authenticate proxy with apache --- +{% include registry.md %} + ## Use-case People already relying on an apache proxy to authenticate their users to other services might want to leverage it and have Registry communications tunneled through the same pipeline. diff --git a/registry/recipes/index.md b/registry/recipes/index.md index 97d3226985..c7c0cae326 100644 --- a/registry/recipes/index.md +++ b/registry/recipes/index.md @@ -4,6 +4,8 @@ keywords: registry, on-prem, images, tags, repository, distribution, recipes, ad title: Recipes overview --- +{% include registry.md %} + This list of "recipes" provides end-to-end scenarios for exotic or otherwise advanced use-cases. These recipes are not useful for most standard set-ups. diff --git a/registry/recipes/mirror.md b/registry/recipes/mirror.md index 09e25abb84..949a8118b2 100644 --- a/registry/recipes/mirror.md +++ b/registry/recipes/mirror.md @@ -6,6 +6,8 @@ redirect_from: - /engine/admin/registry_mirror/ --- +{% include registry.md %} + ## Use-case If you have multiple instances of Docker running in your environment, such as diff --git a/registry/recipes/nginx.md b/registry/recipes/nginx.md index 87d0358bf3..892e132a45 100644 --- a/registry/recipes/nginx.md +++ b/registry/recipes/nginx.md @@ -6,6 +6,8 @@ redirect_from: - /registry/nginx/ --- +{% include registry.md %} + ## Use-case People already relying on a nginx proxy to authenticate their users to other diff --git a/registry/recipes/osx-setup-guide.md b/registry/recipes/osx-setup-guide.md index d5f09299a7..90891fd426 100644 --- a/registry/recipes/osx-setup-guide.md +++ b/registry/recipes/osx-setup-guide.md @@ -4,6 +4,8 @@ keywords: registry, on-prem, images, tags, repository, distribution, macOS, reci title: macOS setup guide --- +{% include registry.md %} + ## Use-case This is useful if you intend to run a registry server natively on macOS. diff --git a/registry/storage-drivers/azure.md b/registry/storage-drivers/azure.md index 28363e55e9..bc3007ac37 100644 --- a/registry/storage-drivers/azure.md +++ b/registry/storage-drivers/azure.md @@ -4,6 +4,8 @@ keywords: registry, service, driver, images, storage, azure title: Microsoft Azure storage driver --- +{% include registry.md %} + An implementation of the `storagedriver.StorageDriver` interface which uses [Microsoft Azure Blob Storage](http://azure.microsoft.com/en-us/services/storage/) for object storage. ## Parameters diff --git a/registry/storage-drivers/filesystem.md b/registry/storage-drivers/filesystem.md index ab50f0f650..7935f7d37d 100644 --- a/registry/storage-drivers/filesystem.md +++ b/registry/storage-drivers/filesystem.md @@ -4,6 +4,8 @@ keywords: registry, service, driver, images, storage, filesystem title: Filesystem storage driver --- +{% include registry.md %} + An implementation of the `storagedriver.StorageDriver` interface which uses the local filesystem. ## Parameters diff --git a/registry/storage-drivers/gcs.md b/registry/storage-drivers/gcs.md index 624ea61632..d91842548d 100644 --- a/registry/storage-drivers/gcs.md +++ b/registry/storage-drivers/gcs.md @@ -4,6 +4,8 @@ keywords: registry, service, driver, images, storage, gcs, google, cloud title: Google Cloud Storage driver --- +{% include registry.md %} + An implementation of the `storagedriver.StorageDriver` interface which uses Google Cloud for object storage. ## Parameters diff --git a/registry/storage-drivers/index.md b/registry/storage-drivers/index.md index 9025bced11..097ffab7cc 100644 --- a/registry/storage-drivers/index.md +++ b/registry/storage-drivers/index.md @@ -6,6 +6,8 @@ redirect_from: title: Docker Registry storage driver --- +{% include registry.md %} + This document describes the registry storage driver model, implementation, and explains how to contribute new storage drivers. ## Provided drivers diff --git a/registry/storage-drivers/inmemory.md b/registry/storage-drivers/inmemory.md index b4bdaeed7c..6e91304542 100644 --- a/registry/storage-drivers/inmemory.md +++ b/registry/storage-drivers/inmemory.md @@ -4,6 +4,8 @@ keywords: registry, service, driver, images, storage, in-memory title: In-memory storage driver (testing only) --- +{% include registry.md %} + For purely tests purposes, you can use the `inmemory` storage driver. This driver is an implementation of the `storagedriver.StorageDriver` interface which uses local memory for object storage. If you would like to run a registry from diff --git a/registry/storage-drivers/oss.md b/registry/storage-drivers/oss.md index 23016dd57d..4a18c1f52c 100644 --- a/registry/storage-drivers/oss.md +++ b/registry/storage-drivers/oss.md @@ -4,6 +4,8 @@ keywords: registry, service, driver, images, storage, OSS, aliyun title: Aliyun OSS storage driver --- +{% include registry.md %} + An implementation of the `storagedriver.StorageDriver` interface which uses [Aliyun OSS](https://www.alibabacloud.com/product/oss) for object storage. diff --git a/registry/storage-drivers/s3.md b/registry/storage-drivers/s3.md index 6dafd9470f..91a13dc632 100644 --- a/registry/storage-drivers/s3.md +++ b/registry/storage-drivers/s3.md @@ -4,6 +4,8 @@ keywords: registry, service, driver, images, storage, S3 title: S3 storage driver --- +{% include registry.md %} + An implementation of the `storagedriver.StorageDriver` interface which uses Amazon S3 or S3 compatible services for object storage. diff --git a/registry/storage-drivers/swift.md b/registry/storage-drivers/swift.md index cda1d060af..f0027ee84d 100644 --- a/registry/storage-drivers/swift.md +++ b/registry/storage-drivers/swift.md @@ -4,6 +4,8 @@ keywords: registry, service, driver, images, storage, swift title: OpenStack Swift storage driver --- +{% include registry.md %} + An implementation of the `storagedriver.StorageDriver` interface that uses [OpenStack Swift](http://docs.openstack.org/developer/swift/) for object storage.