From 5880dcfdba634ce613ba4c6e7a7aa0f30a644ff3 Mon Sep 17 00:00:00 2001 From: Brian Bland Date: Mon, 29 Dec 2014 13:59:40 -0800 Subject: [PATCH] Adds basic READMEs to inmemory and filesystem storage drivers --- storagedriver/filesystem/README.md | 8 ++++++++ storagedriver/inmemory/README.md | 10 ++++++++++ 2 files changed, 18 insertions(+) create mode 100644 storagedriver/filesystem/README.md create mode 100644 storagedriver/inmemory/README.md diff --git a/storagedriver/filesystem/README.md b/storagedriver/filesystem/README.md new file mode 100644 index 000000000..ba3ea5642 --- /dev/null +++ b/storagedriver/filesystem/README.md @@ -0,0 +1,8 @@ +Docker-Registry Filesystem Storage Driver +========================================= + +An implementation of the `storagedriver.StorageDriver` interface which uses the local filesystem. + +## Parameters + +`rootdirectory`: (optional) The root directory tree in which all registry files will be stored. Defaults to `/tmp/registry/storage`. diff --git a/storagedriver/inmemory/README.md b/storagedriver/inmemory/README.md new file mode 100644 index 000000000..2447e2cad --- /dev/null +++ b/storagedriver/inmemory/README.md @@ -0,0 +1,10 @@ +Docker-Registry In-Memory Storage Driver +========================================= + +An implementation of the `storagedriver.StorageDriver` interface which uses local memory for object storage. + +**IMPORTANT**: This storage driver *does not* persist data across runs, and primarily exists for testing. + +## Parameters + +None