node-red-contrib-storage-s3/README.md

implementation of the node-red storage API for AWS-S3

# node-red-contrib-storage-s3

Node-Red module to support storage of node-red configuration data in AWS S3
<p>
requires the following configuration:

credentials: Should be available in a credentials file - ~/.aws/credentials on Mac/Linux or C:\Users\USERNAME\.aws\credentials on Windows
</p>
<p>
settings.js: the following parameters can be added
<ul>
<li>awsRegion: optional region such as eu-west-1</li>
<li>awsS3Appname: optional name of application</li>
<li>awsS3Bucket: optional name of S3 bucket to use</li>
<li>storageModule: require('node-red-contrib-storage-s3'),</li>
</ul>
</p>

default settings for optional configuration:
<ul>
<li>awsRegion: 'eu-west-1'</li>
<li>awsS3Bucket: user display name + '-node-red'</li>
<li>awsS3Appname: aws instance name</li>
</ul>
Author
-------
Kieran Dolan (@kierandol)  


Copyright and license
----------------------
Copyright 2014, 2016 IBM Corp. under the [Apache 2.0 license](http://www.apache.org/licenses/LICENSE-2.0).