Fair Warning
This module supersedes ceph-s3
, as I haven't been able to get my last
contribution merged in (dropFile
method).
If you don't know what you're doing here, you probably just want to use knox
or ceph-s3
.
S3 compatible client wrapper based on ceph-s3/knox
npm install peerio-s3 -S
Usage
You could use a users.json
file to your library's root directory, as the
author suggests.
Or you could define a few environment variables starting your processes. Here's an exhaustive list, and their defaults:
export S3_STORE_PORT=6788export S3_STORE_BUCKET_NAME=changemeexport S3_STORE_STYLE=pathexport S3_STORE_HOST=127.0.0.1export S3_STORE_PROTO=http
Otherwise just user ./lib/users or init function to pass your user configuration:
var S3Client = ; // pass users that you will use with this clients3Client; // can use anything that is supported by knox - https://github.com/Automattic/knoxvar usernameClient = bucket: 'mrusername' 'myusername' { if err // failed to auth / connect / etc throw err; console;}; // any errors during init will be suppressed in _.noop// // access knox directly with mrwondeful.s3 if need bevar mrwondeful = ; // the only useful abstraction besides adding simple user managementvar opts = buffer: 'Contents of the file' 'utf-8' filename: 'useless.txt' headers: {} // optional; mrwondeful; var opts = filename: 'useless.txt' ; mrwondeful;