diff --git a/docs/compatibility.md b/docs/compatibility.md index 37f6d07a..246d8631 100644 --- a/docs/compatibility.md +++ b/docs/compatibility.md @@ -1,7 +1,6 @@ --- description: describes get by digest pitfall -keywords: -- registry, manifest, images, tags, repository, distribution, digest +keywords: registry, manifest, images, tags, repository, distribution, digest title: Registry compatibility --- @@ -75,4 +74,4 @@ constraints of CAS.* For this reason 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 will cause the Engine to receive a manifest it cannot use and the -pull will fail. +pull will fail. \ No newline at end of file diff --git a/docs/configuration.md b/docs/configuration.md index c71b8a33..d979cec7 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -1,7 +1,6 @@ --- description: Explains how to configure a registry -keywords: -- registry, on-prem, images, tags, repository, distribution, configuration +keywords: registry, on-prem, images, tags, repository, distribution, configuration title: Registry configuration reference --- @@ -1857,4 +1856,4 @@ The following example illustrates these values: >**Note**: Cloudfront keys exist separately to other AWS keys. See >[the documentation on AWS credentials](http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html) ->for more information. +>for more information. \ No newline at end of file diff --git a/docs/deploying.md b/docs/deploying.md index 4f346186..7c674c00 100644 --- a/docs/deploying.md +++ b/docs/deploying.md @@ -1,7 +1,6 @@ --- description: Explains how to deploy a registry -keywords: -- registry, on-prem, images, tags, repository, distribution, deployment +keywords: registry, on-prem, images, tags, repository, distribution, deployment title: Deploying a registry server --- @@ -228,4 +227,4 @@ You will find more specific and advanced informations in the following sections: - [Advanced "recipes"](recipes/index.md) - [Registry API](spec/api.md) - [Storage driver model](storage-drivers/index.md) - - [Token authentication](spec/auth/token.md) + - [Token authentication](spec/auth/token.md) \ No newline at end of file diff --git a/docs/deprecated.md b/docs/deprecated.md index be971ce6..d3242b25 100644 --- a/docs/deprecated.md +++ b/docs/deprecated.md @@ -1,7 +1,6 @@ --- description: describes deprecated functionality -keywords: -- registry, manifest, images, signatures, repository, distribution, digest +keywords: registry, manifest, images, signatures, repository, distribution, digest title: Docker Registry deprecation --- @@ -18,4 +17,4 @@ not stored in the registry. This does not alter the functional behavior of the registry. Old signatures blobs can be removed from the registry storage by running the -garbage-collect subcommand. +garbage-collect subcommand. \ No newline at end of file diff --git a/docs/garbage-collection.md b/docs/garbage-collection.md index 4d0467b2..447a3d29 100644 --- a/docs/garbage-collection.md +++ b/docs/garbage-collection.md @@ -1,7 +1,6 @@ --- description: High level discussion of garbage collection -keywords: -- registry, garbage, images, tags, repository, distribution +keywords: registry, garbage, images, tags, repository, distribution title: Garbage collection --- @@ -127,4 +126,4 @@ blob eligible for deletion: sha256:7e15ce58ccb2181a8fced7709e9893206f0937cc9543b blob eligible for deletion: sha256:87192bdbe00f8f2a62527f36bb4c7c7f4eaf9307e4b87e8334fb6abec1765bcb blob eligible for deletion: sha256:b549a9959a664038fc35c155a95742cf12297672ca0ae35735ec027d55bf4e97 blob eligible for deletion: sha256:f251d679a7c61455f06d793e43c06786d7766c88b8c24edf242b2c08e3c3f599 -``` +``` \ No newline at end of file diff --git a/docs/help.md b/docs/help.md index d73c76d8..ea00fb53 100644 --- a/docs/help.md +++ b/docs/help.md @@ -1,7 +1,6 @@ --- description: Getting help with the Registry -keywords: -- registry, on-prem, images, tags, repository, distribution, help, 101, TL;DR +keywords: registry, on-prem, images, tags, repository, distribution, help, 101, TL;DR title: Get help --- @@ -15,4 +14,4 @@ If you want to report a bug: - be sure to first read about [how to contribute](https://github.com/docker/distribution/blob/master/CONTRIBUTING.md) - you can then do so on the [GitHub project bugtracker](https://github.com/docker/distribution/issues) -You can also find out more about the Docker's project [Getting Help resources](/opensource/get-help.md). +You can also find out more about the Docker's project [Getting Help resources](/opensource/get-help.md). \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 12d97809..b83ba55b 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,9 +1,8 @@ --- +description: High-level overview of the Registry +keywords: registry, on-prem, images, tags, repository, distribution redirect_from: - /registry/overview/ -description: High-level overview of the Registry -keywords: -- registry, on-prem, images, tags, repository, distribution title: Docker Registry --- @@ -67,4 +66,4 @@ Now stop your registry and remove all data You should now read the [detailed introduction about the registry](introduction.md), or jump directly to [deployment -instructions](deploying.md). +instructions](deploying.md). \ No newline at end of file diff --git a/docs/insecure.md b/docs/insecure.md index d7d1ba8c..f3c50d64 100644 --- a/docs/insecure.md +++ b/docs/insecure.md @@ -1,7 +1,6 @@ --- description: Deploying a Registry in an insecure fashion -keywords: -- registry, on-prem, images, tags, repository, distribution, insecure +keywords: registry, on-prem, images, tags, repository, distribution, insecure title: Test an insecure registry --- @@ -105,4 +104,4 @@ update-ca-trust $ update-ca-trust enable ``` -Now restart docker (`service docker stop && service docker start`, or any other way you use to restart docker). +Now restart docker (`service docker stop && service docker start`, or any other way you use to restart docker). \ No newline at end of file diff --git a/docs/introduction.md b/docs/introduction.md index 6b7e46e0..8a15e2e7 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -1,7 +1,6 @@ --- description: Explains what the Registry is, basic use cases and requirements -keywords: -- registry, on-prem, images, tags, repository, distribution, use cases, requirements +keywords: registry, on-prem, images, tags, repository, distribution, use cases, requirements title: About Registry --- @@ -73,4 +72,4 @@ golang are certainly useful as well for advanced operations or hacking. ## Next -Dive into [deploying your registry](deploying.md) +Dive into [deploying your registry](deploying.md) \ No newline at end of file diff --git a/docs/notifications.md b/docs/notifications.md index 7f503e1b..0646da0b 100644 --- a/docs/notifications.md +++ b/docs/notifications.md @@ -1,7 +1,6 @@ --- description: Explains how to work with registry notifications -keywords: -- registry, on-prem, images, tags, repository, distribution, notifications, advanced +keywords: registry, on-prem, images, tags, repository, distribution, notifications, advanced title: Work with notifications --- @@ -341,4 +340,4 @@ provide acceptable guarantees, adding a transactional `Sink` to the registry is a possibility, although it may have an effect on request service time. Please see the [godoc](http://godoc.org/github.com/docker/distribution/notifications#Sink) -for more information. +for more information. \ No newline at end of file diff --git a/docs/recipes/apache.md b/docs/recipes/apache.md index e74aa198..c60c64f9 100644 --- a/docs/recipes/apache.md +++ b/docs/recipes/apache.md @@ -1,7 +1,6 @@ --- description: Restricting access to your registry using an apache proxy -keywords: -- registry, on-prem, images, tags, repository, distribution, authentication, proxy, apache, httpd, TLS, recipe, advanced +keywords: registry, on-prem, images, tags, repository, distribution, authentication, proxy, apache, httpd, TLS, recipe, advanced title: Authenticate proxy with apache --- @@ -207,4 +206,4 @@ Now, login with a "pull-only" user (using `testuser` and `testpassword`), then p Verify that the "pull-only" can NOT push: - docker push myregistrydomain.com:5043/test + docker push myregistrydomain.com:5043/test \ No newline at end of file diff --git a/docs/recipes/index.md b/docs/recipes/index.md index ab6986a6..12af3d29 100644 --- a/docs/recipes/index.md +++ b/docs/recipes/index.md @@ -1,7 +1,6 @@ --- description: Fun stuff to do with your registry -keywords: -- registry, on-prem, images, tags, repository, distribution, recipes, advanced +keywords: registry, on-prem, images, tags, repository, distribution, recipes, advanced title: Recipes Overview --- @@ -28,4 +27,4 @@ At this point, it's assumed that: * [using Apache as an authenticating proxy](apache.md) * [using Nginx as an authenticating proxy](nginx.md) * [running a Registry on macOS](osx-setup-guide.md) - * [mirror the Docker Hub](mirror.md) + * [mirror the Docker Hub](mirror.md) \ No newline at end of file diff --git a/docs/recipes/mirror.md b/docs/recipes/mirror.md index cc40ae74..f6680449 100644 --- a/docs/recipes/mirror.md +++ b/docs/recipes/mirror.md @@ -1,7 +1,6 @@ --- description: Setting-up a local mirror for Docker Hub images -keywords: -- registry, on-prem, images, tags, repository, distribution, mirror, Hub, recipe, advanced +keywords: registry, on-prem, images, tags, repository, distribution, mirror, Hub, recipe, advanced title: Registry as a pull through cache --- @@ -94,4 +93,4 @@ For example, if your mirror is serving on `http://10.0.0.2:5000`, you would run: > NOTE: Depending on your local host setup, you may be able to add the `--registry-mirror` option to the `DOCKER_OPTS` variable in -`/etc/default/docker`. +`/etc/default/docker`. \ No newline at end of file diff --git a/docs/recipes/nginx.md b/docs/recipes/nginx.md index c1873943..59f2fabf 100644 --- a/docs/recipes/nginx.md +++ b/docs/recipes/nginx.md @@ -1,7 +1,6 @@ --- description: Restricting access to your registry using a nginx proxy -keywords: -- registry, on-prem, images, tags, repository, distribution, nginx, proxy, authentication, TLS, recipe, advanced +keywords: registry, on-prem, images, tags, repository, distribution, nginx, proxy, authentication, TLS, recipe, advanced title: Authenticate proxy with nginx --- @@ -200,4 +199,4 @@ tag and push your first image: docker login -u=testuser -p=testpassword -e=root@example.ch myregistrydomain.com:5043 docker tag ubuntu myregistrydomain.com:5043/test docker push myregistrydomain.com:5043/test - docker pull myregistrydomain.com:5043/test + docker pull myregistrydomain.com:5043/test \ No newline at end of file diff --git a/docs/recipes/osx-setup-guide.md b/docs/recipes/osx-setup-guide.md index 375f4408..73f9ad19 100644 --- a/docs/recipes/osx-setup-guide.md +++ b/docs/recipes/osx-setup-guide.md @@ -1,7 +1,6 @@ --- description: Explains how to run a registry on macOS -keywords: -- registry, on-prem, images, tags, repository, distribution, macOS, recipe, advanced +keywords: registry, on-prem, images, tags, repository, distribution, macOS, recipe, advanced title: macOS Setup Guide --- @@ -73,4 +72,4 @@ Start the Docker registry: ### Unloading the docker registry service - launchctl unload ~/Library/LaunchAgents/com.docker.registry.plist + launchctl unload ~/Library/LaunchAgents/com.docker.registry.plist \ No newline at end of file diff --git a/docs/spec/api.md b/docs/spec/api.md index 4e99944f..d9b3d30c 100644 --- a/docs/spec/api.md +++ b/docs/spec/api.md @@ -1,7 +1,6 @@ --- description: Specification for the Registry API. -keywords: -- registry, on-prem, images, tags, repository, distribution, api, advanced +keywords: registry, on-prem, images, tags, repository, distribution, api, advanced title: Docker Registry HTTP API V2 --- @@ -5476,4 +5475,4 @@ The following headers will be returned with the response: |Name|Description| |----|-----------| |`Content-Length`|Length of the JSON response body.| -|`Link`|RFC5988 compliant rel='next' with URL to next result set, if available| +|`Link`|RFC5988 compliant rel='next' with URL to next result set, if available| \ No newline at end of file diff --git a/docs/spec/auth/index.md b/docs/spec/auth/index.md index 324c4bce..469f3b3e 100644 --- a/docs/spec/auth/index.md +++ b/docs/spec/auth/index.md @@ -1,11 +1,10 @@ --- description: Docker Registry v2 authentication schema -keywords: -- registry, on-prem, images, tags, repository, distribution, authentication, advanced +keywords: registry, on-prem, images, tags, repository, distribution, authentication, advanced title: Docker Registry v2 authentication --- See the [Token Authentication Specification](token.md), [Token Authentication Implementation](jwt.md), [Token Scope Documentation](scope.md), -[OAuth2 Token Authentication](oauth.md) for more information. +[OAuth2 Token Authentication](oauth.md) for more information. \ No newline at end of file diff --git a/docs/spec/auth/jwt.md b/docs/spec/auth/jwt.md index eb0d6fa5..eaf05882 100644 --- a/docs/spec/auth/jwt.md +++ b/docs/spec/auth/jwt.md @@ -1,7 +1,6 @@ --- description: Describe the reference implementation of the Docker Registry v2 authentication schema -keywords: -- registry, on-prem, images, tags, repository, distribution, JWT authentication, advanced +keywords: registry, on-prem, images, tags, repository, distribution, JWT authentication, advanced title: Docker Registry v2 Bearer token specification --- @@ -325,4 +324,4 @@ authorization then the registry will return the appropriate error. At no point in this process should the registry need to call back to the authorization server. The registry only needs to be supplied with the trusted -public keys to verify the token signatures. +public keys to verify the token signatures. \ No newline at end of file diff --git a/docs/spec/auth/oauth.md b/docs/spec/auth/oauth.md index 388a4144..02d9a138 100644 --- a/docs/spec/auth/oauth.md +++ b/docs/spec/auth/oauth.md @@ -1,7 +1,6 @@ --- description: Specifies the Docker Registry v2 authentication -keywords: -- registry, on-prem, images, tags, repository, distribution, oauth2, advanced +keywords: registry, on-prem, images, tags, repository, distribution, oauth2, advanced title: Docker Registry v2 authentication using OAuth2 --- @@ -181,4 +180,4 @@ HTTP/1.1 200 OK Content-Type: application/json {"refresh_token":"kas9Da81Dfa8","access_token":"eyJhbGciOiJFUzI1NiIsInR5":"expires_in":900,"scope":"repository:samalba/my-app:pull,repository:samalba/my-app:push"} -``` +``` \ No newline at end of file diff --git a/docs/spec/auth/scope.md b/docs/spec/auth/scope.md index aa4bebf1..b0e1f3ce 100644 --- a/docs/spec/auth/scope.md +++ b/docs/spec/auth/scope.md @@ -1,7 +1,6 @@ --- description: Describes the scope and access fields used for registry authorization tokens -keywords: -- registry, on-prem, images, tags, repository, distribution, advanced, access, scope +keywords: registry, on-prem, images, tags, repository, distribution, advanced, access, scope title: Docker Registry token scope and access --- @@ -133,4 +132,4 @@ restricting scope to specific type, name, and actions combinations should be done by fetching an access token using the refresh token. Since the refresh token is not scoped to specific resources for an audience, extra care should be taken to only use the refresh token to negotiate new access tokens directly -with the authorization server, and never with a resource provider. +with the authorization server, and never with a resource provider. \ No newline at end of file diff --git a/docs/spec/auth/token.md b/docs/spec/auth/token.md index ed3f382f..a33867f3 100644 --- a/docs/spec/auth/token.md +++ b/docs/spec/auth/token.md @@ -1,7 +1,6 @@ --- description: Specifies the Docker Registry v2 authentication -keywords: -- registry, on-prem, images, tags, repository, distribution, Bearer authentication, advanced +keywords: registry, on-prem, images, tags, repository, distribution, Bearer authentication, advanced title: Docker Registry v2 authentication via central service --- @@ -248,4 +247,4 @@ Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NiIsImtpZCI6IkJWM0Q6MkFWWj ``` This is also described in [Section 2.1 of RFC 6750: The OAuth 2.0 Authorization -Framework: Bearer Token Usage](https://tools.ietf.org/html/rfc6750#section-2.1) +Framework: Bearer Token Usage](https://tools.ietf.org/html/rfc6750#section-2.1) \ No newline at end of file diff --git a/docs/spec/index.md b/docs/spec/index.md index 74b13149..23d47252 100644 --- a/docs/spec/index.md +++ b/docs/spec/index.md @@ -1,11 +1,10 @@ --- description: Explains registry JSON objects -keywords: -- registry, service, images, repository, json +keywords: registry, service, images, repository, json title: Docker Registry Reference --- * [HTTP API V2](api.md) * [Storage Driver](../storage-drivers/index.md) * [Token Authentication Specification](auth/token.md) -* [Token Authentication Implementation](auth/jwt.md) +* [Token Authentication Implementation](auth/jwt.md) \ No newline at end of file diff --git a/docs/spec/json.md b/docs/spec/json.md index 69cb4498..46703903 100644 --- a/docs/spec/json.md +++ b/docs/spec/json.md @@ -1,8 +1,7 @@ --- description: Explains registry JSON objects +keywords: registry, service, images, repository, json published: false -keywords: -- registry, service, images, repository, json title: Docker Distribution JSON canonicalization --- @@ -84,4 +83,4 @@ var canonical bytes.Buffer if err := json.Indent(&canonical, incoming, "", ""); err != nil { // ... handle error } -``` +``` \ No newline at end of file diff --git a/docs/spec/manifest-v2-1.md b/docs/spec/manifest-v2-1.md index 63db46e3..bcdf86c5 100644 --- a/docs/spec/manifest-v2-1.md +++ b/docs/spec/manifest-v2-1.md @@ -1,7 +1,6 @@ --- description: image manifest for the Registry. -keywords: -- registry, on-prem, images, tags, repository, distribution, api, advanced, manifest +keywords: registry, on-prem, images, tags, repository, distribution, api, advanced, manifest title: Image manifest V2, schema 1 --- @@ -159,4 +158,4 @@ by *libtrust*. A signature consists of the following fields: ] } -``` +``` \ No newline at end of file diff --git a/docs/spec/manifest-v2-2.md b/docs/spec/manifest-v2-2.md index 4c28e9ac..628fac0d 100644 --- a/docs/spec/manifest-v2-2.md +++ b/docs/spec/manifest-v2-2.md @@ -1,7 +1,6 @@ --- description: image manifest for the Registry. -keywords: -- registry, on-prem, images, tags, repository, distribution, api, advanced, manifest +keywords: registry, on-prem, images, tags, repository, distribution, api, advanced, manifest title: Image manifest V2, schema 2 --- @@ -290,4 +289,4 @@ their own, but only serve to fill in the parent chain in a compatible way. The IDs in these synthetic configurations will be derived from hashes of their respective blobs. The registry will create these configurations and their IDs using the same scheme as Docker 1.10 when it creates a legacy manifest to push -to a registry which doesn't support the new format. +to a registry which doesn't support the new format. \ No newline at end of file diff --git a/docs/storage-drivers/azure.md b/docs/storage-drivers/azure.md index 899418ce..ed87fb4c 100644 --- a/docs/storage-drivers/azure.md +++ b/docs/storage-drivers/azure.md @@ -1,7 +1,6 @@ --- description: Explains how to use the Azure storage drivers -keywords: -- registry, service, driver, images, storage, azure +keywords: registry, service, driver, images, storage, azure title: Microsoft Azure storage driver --- @@ -69,4 +68,4 @@ An implementation of the `storagedriver.StorageDriver` interface which uses [Mic * To get information about [azure-blob-storage](http://azure.microsoft.com/en-us/services/storage/) visit the Microsoft website. -* You can use Microsoft's [Blob Service REST API](https://msdn.microsoft.com/en-us/library/azure/dd135733.aspx) to [create a container] (https://msdn.microsoft.com/en-us/library/azure/dd179468.aspx). +* You can use Microsoft's [Blob Service REST API](https://msdn.microsoft.com/en-us/library/azure/dd135733.aspx) to [create a container] (https://msdn.microsoft.com/en-us/library/azure/dd179468.aspx). \ No newline at end of file diff --git a/docs/storage-drivers/filesystem.md b/docs/storage-drivers/filesystem.md index 2a1f7e1c..39361622 100644 --- a/docs/storage-drivers/filesystem.md +++ b/docs/storage-drivers/filesystem.md @@ -1,7 +1,6 @@ --- description: Explains how to use the filesystem storage drivers -keywords: -- registry, service, driver, images, storage, filesystem +keywords: registry, service, driver, images, storage, filesystem title: Filesystem storage driver --- @@ -15,4 +14,4 @@ there is adequate space available. Defaults to `/var/lib/registry`. `maxthreads`: (optional) The maximum number of simultaneous blocking filesystem operations permitted within the registry. Each operation spawns a new thread and may cause thread exhaustion issues if many are done in parallel. Defaults to -`100`, and can be no lower than `25`. +`100`, and can be no lower than `25`. \ No newline at end of file diff --git a/docs/storage-drivers/gcs.md b/docs/storage-drivers/gcs.md index 4ecc4962..d256f354 100644 --- a/docs/storage-drivers/gcs.md +++ b/docs/storage-drivers/gcs.md @@ -1,7 +1,6 @@ --- description: Explains how to use the Google Cloud Storage drivers -keywords: -- registry, service, driver, images, storage, gcs, google, cloud +keywords: registry, service, driver, images, storage, gcs, google, cloud title: Google Cloud Storage driver --- @@ -69,4 +68,4 @@ An implementation of the `storagedriver.StorageDriver` interface which uses Goog **Note** Instead of a key file you can use [Google Application Default Credentials](https://developers.google.com/identity/protocols/application-default-credentials). -`rootdirectory`: (optional) The root directory tree in which all registry files will be stored. Defaults to the empty string (bucket root). +`rootdirectory`: (optional) The root directory tree in which all registry files will be stored. Defaults to the empty string (bucket root). \ No newline at end of file diff --git a/docs/storage-drivers/index.md b/docs/storage-drivers/index.md index a5828add..b0b88e4b 100644 --- a/docs/storage-drivers/index.md +++ b/docs/storage-drivers/index.md @@ -1,9 +1,8 @@ --- +description: Explains how to use storage drivers +keywords: registry, on-prem, images, tags, repository, distribution, storage drivers, advanced redirect_from: - /registry/storagedrivers/ -description: Explains how to use storage drivers -keywords: -- registry, on-prem, images, tags, repository, distribution, storage drivers, advanced title: Docker Registry storage driver --- @@ -56,4 +55,4 @@ Storage drivers should call `factory.Register` with their driver name in an `ini Storage driver test suites are provided in `storagedriver/testsuites/testsuites.go` and may be used for any storage driver written in Go. Tests can be registered using the `RegisterSuite` -function, which run the same set of tests for any registered drivers. +function, which run the same set of tests for any registered drivers. \ No newline at end of file diff --git a/docs/storage-drivers/inmemory.md b/docs/storage-drivers/inmemory.md index e4b40426..cc92b5c2 100644 --- a/docs/storage-drivers/inmemory.md +++ b/docs/storage-drivers/inmemory.md @@ -1,7 +1,6 @@ --- description: Explains how to use the in-memory storage drivers -keywords: -- registry, service, driver, images, storage, in-memory +keywords: registry, service, driver, images, storage, in-memory title: In-memory storage driver (testing only) --- @@ -14,4 +13,4 @@ volatile memory, use the [`filesystem` driver](filesystem.md) on a ramdisk. ## Parameters -None +None \ No newline at end of file diff --git a/docs/storage-drivers/oss.md b/docs/storage-drivers/oss.md index 95054943..2e49c803 100644 --- a/docs/storage-drivers/oss.md +++ b/docs/storage-drivers/oss.md @@ -1,7 +1,6 @@ --- description: Explains how to use the Aliyun OSS storage driver -keywords: -- registry, service, driver, images, storage, OSS, aliyun +keywords: registry, service, driver, images, storage, OSS, aliyun title: Aliyun OSS storage driver --- @@ -119,4 +118,4 @@ no