From d07ae75f904f7adc6eec322d903bf47ead0bb8e7 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Miquel=20Sabat=C3=A9?= <msabate@suse.com>
Date: Thu, 13 Aug 2015 20:18:35 +0200
Subject: [PATCH] docs: added the "delete" subsection in the configuration.md
file
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Signed-off-by: Miquel Sabaté <msabate@suse.com>
---
docs/configuration.md | 17 +++++++++++++++--
1 file changed, 15 insertions(+), 2 deletions(-)
diff --git a/docs/configuration.md b/docs/configuration.md
index eb21b06c..eb93b01d 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -76,7 +76,7 @@ information about each option that appears later in this page.
password: password
insecure: true
from: sender@example.com
- to:
+ to:
- errors@example.com
loglevel: debug # deprecated: use "log"
storage:
@@ -112,6 +112,8 @@ information about each option that appears later in this page.
region: fr
container: containername
rootdirectory: /swift/object/name/prefix
+ delete:
+ enabled: false
redirect:
disable: false
cache:
@@ -330,6 +332,8 @@ Permitted values are `error`, `warn`, `info` and `debug`. The default is
region: fr
container: containername
rootdirectory: /swift/object/name/prefix
+ delete:
+ enabled: false
cache:
blobdescriptor: inmemory
maintenance:
@@ -344,10 +348,19 @@ Permitted values are `error`, `warn`, `info` and `debug`. The default is
The storage option is **required** and defines which storage backend is in use.
You must configure one backend; if you configure more, the registry returns an error.
-If you are deploying a registry on Windows, be aware that a Windows volume mounted from the host is not recommended. Instead, you can use a S3, or Azure, backing data-store. If you do use a Windows volume, you must ensure that the `PATH` to the mount point is within Windows' `MAX_PATH` limits (typically 255 characters). Failure to do so can result in the following error message:
+If you are deploying a registry on Windows, be aware that a Windows volume mounted from the host is not recommended. Instead, you can use a S3, or Azure, backing data-store. If you do use a Windows volume, you must ensure that the `PATH` to the mount point is within Windows' `MAX_PATH` limits (typically 255 characters). Failure to do so can result in the following error message:
mkdir /XXX protocol error and your registry will not function properly.
+### delete
+
+Use the `delete` subsection to enable the deletion of image blobs and manifests
+by digest. It defaults to false, but it can be enabled by writing the following
+on the configuration file:
+
+ delete:
+ enabled: true
+
### cache
Use the `cache` subsection to enable caching of data accessed in the storage