From e5bba7fef03b094c1a5fd52ef6d38c064f652251 Mon Sep 17 00:00:00 2001 From: Ian Babrou Date: Mon, 20 Apr 2015 10:41:32 +0300 Subject: [PATCH] docs: fixed links for storage drivers Signed-off-by: Ian Babrou (cherry picked from commit 824e7e8ae25299b5953e38088c085198774f945f) Pushing fix for mkdocs.yml introduced Signed-off-by: Mary Anthony (cherry picked from commit d5c0300986cb589d6e1618546a4bf46ed4ddac7e) Updating configuration with required header Signed-off-by: Mary Anthony (cherry picked from commit 8ae13b4725b466bca256fa51cd2b7a141b0473ab) Add environment variable override instructions Signed-off-by: Richard Scothern (cherry picked from commit 937c3565856344e85ee93ba282916f76bccbb21b) --- contrib/compose/nginx/registry.conf | 3 +++ docs/configuration.md | 12 ++++++++++++ docs/mkdocs.yml | 3 --- docs/storagedrivers.md | 8 ++++---- 4 files changed, 19 insertions(+), 7 deletions(-) diff --git a/contrib/compose/nginx/registry.conf b/contrib/compose/nginx/registry.conf index 28542a47c..3c5549213 100644 --- a/contrib/compose/nginx/registry.conf +++ b/contrib/compose/nginx/registry.conf @@ -25,6 +25,9 @@ server { if ($http_user_agent ~ "^(docker\/1\.(3|4|5(?!\.[0-9]-dev))|Go ).*$" ) { return 404; } + + # The docker client expects this header from the /v2/ endpoint. + more_set_headers 'Docker-Distribution-Api-Version: registry/2.0'; include docker-registry-v2.conf; } diff --git a/docs/configuration.md b/docs/configuration.md index 0b59f41b9..2607f3daf 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -9,6 +9,18 @@ You configure a registry server using a YAML file. This page explains the configuration options and the values they can take. You'll also find examples of middleware and development environment configurations. +## Overriding configuration options +Environment variables may be used to override configuration parameters other than +version. To override a configuration option, create an environment variable named +REGISTRY\_variable_ where *variable* is the name of the configuration option. + +e.g +``` +REGISTRY_STORAGE_FILESYSTEM_ROOTDIRECTORY=/tmp/registry/test +``` + +will set the storage root directory to `/tmp/registry/test` + ## List of configuration options This section lists all the registry configuration options. Some options in diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 73eefec41..844658206 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -7,10 +7,7 @@ - ['registry/spec/json.md', 'Reference', '    ▪  JSON format' ] - ['registry/spec/auth/token.md', 'Reference', '    ▪  Authenticate via central service' ] -<<<<<<< HEAD -======= - ['registry/storage-drivers/azure.md', '**HIDDEN**' ] - ['registry/storage-drivers/filesystem.md', '**HIDDEN**' ] - ['registry/storage-drivers/inmemory.md', '**HIDDEN**' ] - ['registry/storage-drivers/s3.md','**HIDDEN**' ] ->>>>>>> d5c0300... Pushing fix for mkdocs.yml introduced diff --git a/docs/storagedrivers.md b/docs/storagedrivers.md index 788bdd0d7..2db67e282 100644 --- a/docs/storagedrivers.md +++ b/docs/storagedrivers.md @@ -8,10 +8,10 @@ Provided Drivers This storage driver package comes bundled with several drivers: -- [inmemory](storage-drivers/inmemory): A temporary storage driver using a local inmemory map. This exists solely for reference and testing. -- [filesystem](storage-drivers/filesystem): A local storage driver configured to use a directory tree in the local filesystem. -- [s3](storage-drivers/s3): A driver storing objects in an Amazon Simple Storage Solution (S3) bucket. -- [azure](storage-drivers/azure): A driver storing objects in [Microsoft Azure Blob Storage](http://azure.microsoft.com/en-us/services/storage/). +- [inmemory](storage-drivers/inmemory.md): A temporary storage driver using a local inmemory map. This exists solely for reference and testing. +- [filesystem](storage-drivers/filesystem.md): A local storage driver configured to use a directory tree in the local filesystem. +- [s3](storage-drivers/s3.md): A driver storing objects in an Amazon Simple Storage Solution (S3) bucket. +- [azure](storage-drivers/azure.md): A driver storing objects in [Microsoft Azure Blob Storage](http://azure.microsoft.com/en-us/services/storage/). Storage Driver API ==================