vbatts/registry
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Merge pull request #869 from mssola/delete-documentation

Browse source 
docs: added the "delete" subsection in the configuration.md file
This commit is contained in:
Richard Scothern 2015-08-13 11:22:15 -07:00
commit 77c6d9deb9
1 changed files with 15 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
docs/configuration.md
View file

@ -76,7 +76,7 @@ information about each option that appears later in this page.
password: password password: password
insecure: true insecure: true
from: sender@example.com from: sender@example.com
to: to:
- errors@example.com - errors@example.com
loglevel: debug # deprecated: use "log" loglevel: debug # deprecated: use "log"
storage: storage:
@ -112,6 +112,8 @@ information about each option that appears later in this page.
region: fr region: fr
container: containername container: containername
rootdirectory: /swift/object/name/prefix rootdirectory: /swift/object/name/prefix
delete:
enabled: false
redirect: redirect:
disable: false disable: false
cache: cache:
@ -330,6 +332,8 @@ Permitted values are `error`, `warn`, `info` and `debug`. The default is
region: fr region: fr
container: containername container: containername
rootdirectory: /swift/object/name/prefix rootdirectory: /swift/object/name/prefix
delete:
enabled: false
cache: cache:
blobdescriptor: inmemory blobdescriptor: inmemory
maintenance: 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. 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. 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. 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 ### cache
Use the `cache` subsection to enable caching of data accessed in the storage Use the `cache` subsection to enable caching of data accessed in the storage