# HG changeset patch
# User Alain Mazy
# Date 1593783800 -7200
# Node ID 4e326cea533eac307d31fc378e4812a80f538165
# Parent  55ce49bf32b38960a67753bc16f07c1effd8a2d8
readme

diff -r 55ce49bf32b3 -r 4e326cea533e README.md
--- a/README.md	Fri Jul 03 14:40:07 2020 +0200
+++ b/README.md	Fri Jul 03 15:43:20 2020 +0200
@@ -4,3 +4,102 @@
 
 Check the [Orthanc book](https://book.orthanc-server.com/plugins/object-storage.html) for complete documentation.
 
+## info for developers ##
+
+Here's a sample configuration file of the `StorageEncryption` section of the plugins:
+
+```
+{
+    "StorageEncryption" : {
+        "Enable": true,
+        "MasterKey": [3, "/path/to/master.key"], // key id - path to the base64 encoded key
+        "PreviousMasterKeys" : [
+            [ 1, "/path/to/previous1.key"],
+            [ 2, "/path/to/previous2.key"]
+        ],
+        "MaxConcurrentInputSize" : 1024   // size in MB 
+    }
+}
+```
+
+### Compile Google plugin ###
+
+* `./vcpkg install google-cloud-cpp`
+* `./vcpkg install cryptopp`
+* `hg clone ...`
+* `mkdir -p build/google`
+* `cd build/google` 
+* `cmake -DCMAKE_TOOLCHAIN_FILE=[vcpkg root]\scripts\buildsystems\vcpkg.cmake ../../orthanc-object-storage/google`
+
+### Google plugin configuration ###
+
+```
+    "GoogleCloudStorage" : {
+        "ServiceAccountFile": "/.../googleServiceAccountFile.json",
+        "BucketName": "test-orthanc-storage-plugin"
+    }
+
+```
+
+## Azure Blob Storage plugin ##
+
+### Prerequisites ###
+
+* Install [vcpkg](https://github.com/Microsoft/vcpkg) 
+
+### Compile Azure plugin ###
+
+* `./vcpkg install cpprestsdk`
+* `hg clone ...`
+* `mkdir -p build/azure`
+* `cd build/azure` 
+* `cmake -DCMAKE_TOOLCHAIN_FILE=[vcpkg root]\scripts\buildsystems\vcpkg.cmake ../../orthanc-object-storage/Azure`
+
+### Azure plugin configuration ###
+
+```
+    "AzureBlobStorage" : {
+    	"ConnectionString": "DefaultEndpointsProtocol=https;AccountName=xxxxxxxxx;AccountKey=yyyyyyyy===;EndpointSuffix=core.windows.net",
+    	"ContainerName" : "test-orthanc-storage-plugin"
+    }
+```
+
+## AWS S3 Storage plugin ##
+
+### Prerequisites ###
+
+* Install [vcpkg](https://github.com/Microsoft/vcpkg) 
+
+* compile the AWS C++ SDK
+
+```
+
+mkdir ~/aws
+cd ~/aws
+git clone https://github.com/aws/aws-sdk-cpp.git
+
+mkdir -p ~/aws/builds/aws-sdk-cpp
+cd ~/aws/builds/aws-sdk-cpp
+cmake -DBUILD_ONLY="s3;transfer" ~/aws/aws-sdk-cpp 
+make -j 4 
+make install
+```
+
+### Compile AWS S3 plugin ###
+
+* `./vcpkg install cryptopp`
+* `hg clone ...`
+* `mkdir -p build/aws`
+* `cd build/aws` 
+* `cmake -DCMAKE_TOOLCHAIN_FILE=[vcpkg root]\scripts\buildsystems\vcpkg.cmake ../../orthanc-object-storage/Aws`
+
+### Azure plugin configuration ###
+
+```
+    "AwsS3Storage" : {
+    	"BucketName": "test-orthanc-s3-plugin",
+        "Region" : "eu-central-1",
+        "AccessKey" : "AKXXX",
+        "SecretKey" : "RhYYYY"
+    }
+```
\ No newline at end of file