From 14c8e2b5f0ea80f16eb3c4d815e15238c4fb4fe2 Mon Sep 17 00:00:00 2001 From: Brian Bland Date: Tue, 13 Jan 2015 11:38:19 -0800 Subject: [PATCH] Clarifies s3 driver "secure" flag documentation Signed-off-by: Brian Bland --- storagedriver/s3/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/storagedriver/s3/README.md b/storagedriver/s3/README.md index 58f01da2..c53b4947 100644 --- a/storagedriver/s3/README.md +++ b/storagedriver/s3/README.md @@ -17,8 +17,8 @@ An implementation of the `storagedriver.StorageDriver` interface which uses Amaz `encrypt`: (optional) Whether you would like your data encrypted on the server side (defaults to false if not specified). -`secure`: (optional) Whether you would like to transfer data over ssl or not. Defaults to true (meaning transfering over ssl) if not specified. Note that while setting this to false will improve performance, it is not recommended due to security concerns. +`secure`: (optional) Whether you would like to transfer data to the bucket over ssl or not. Defaults to true (meaning transfering over ssl) if not specified. Note that while setting this to false will improve performance, it is not recommended due to security concerns. `v4auth`: (optional) Whether you would like to use aws signature version 4 with your requests. This defaults to true if not specified (note that the eu-central-1 region does not work with version 2 signatures, so the driver will error out if initialized with this region and v4auth set to false) -`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 +`rootdirectory`: (optional) The root directory tree in which all registry files will be stored. Defaults to the empty string (bucket root).