chore: add an example s3 backed ipfs setup

License: MIT
Signed-off-by: Jacob Heun <[email protected]>

Author: jacobheun

README.md

@@ -30,13 +30,16 @@ A bucket must be created prior to using datastore-s3. Please see the AWS docs fo
 
 ```js
 const S3 = require('aws-sdk').S3
-const s3Instance = new S3({ params: { Bucket: 'my-ipfs-bucket' } }) 
+const s3Instance = new S3({ params: { Bucket: 'my-ipfs-bucket' } })
 const S3Store = require('datastore-s3')
-const store = new S3Store('.ipfs/datastore', { 
-  s3: s3Instance 
-})     
+const store = new S3Store('.ipfs/datastore', {
+  s3: s3Instance
+})
 ```
 
+### Examples
+You can see examples of S3 backed ipfs in the [examples folder](examples/)
+
 ## Contribute
 
 PRs accepted.

examples/full-s3-repo/README.md

@@ -0,0 +1,23 @@
+Full S3 Repo
+======
+
+This example leverages the code from https://github.com/ipfs/js-ipfs/tree/master/examples/ipfs-101,
+but uses an instantiated S3 instance to serve as the entire backend for ipfs.
+
+## Running
+The S3 parameters must be updated with an existing Bucket and credentials with access to it:
+```js
+const s3 = new S3({
+  params: {
+    Bucket: 'my-bucket'
+  },
+  accessKeyId: 'myaccesskey',
+  secretAccessKey: 'mysecretkey'
+})
+```
+
+Once the S3 instance has its needed data, you can run the example:
+```
+npm install
+node index.js
+```

examples/full-s3-repo/index.js

@@ -0,0 +1,60 @@
+'use strict'
+
+const series = require('async/series')
+const IPFS = require('ipfs')
+const Repo = require('ipfs-repo')
+const S3 = require('aws-sdk').S3
+const S3Store = require('../../src')
+
+let fileMultihash
+const s3 = new S3({
+  params: {
+    Bucket: 'my-bucket'
+  },
+  accessKeyId: 'myaccesskey',
+  secretAccessKey: 'mysecretkey'
+})
+
+const repo = new Repo('/tmp/test/.ipfs', {
+  storageBackends: {
+    root: S3Store,
+    blocks: S3Store,
+    keys: S3Store,
+    datastore: S3Store
+  },
+  storageBackendOptions: {
+    root: { s3 },
+    blocks: { s3 },
+    keys: { s3 },
+    datastore: { s3 }
+  }
+})
+
+let node = new IPFS({
+  repo: repo
+})
+
+series([
+  (cb) => node.on('ready', cb),
+  (cb) => node.version((err, version) => {
+    if (err) { return cb(err) }
+    console.log('Version:', version.version)
+    cb()
+  }),
+  (cb) => node.files.add({
+    path: 'hello.txt',
+    content: Buffer.from('Hello World 101')
+  }, (err, filesAdded) => {
+    if (err) { return cb(err) }
+
+    console.log('\nAdded file:', filesAdded[0].path, filesAdded[0].hash)
+    fileMultihash = filesAdded[0].hash
+    cb()
+  }),
+  (cb) => node.files.cat(fileMultihash, (err, data) => {
+    if (err) { return cb(err) }
+
+    console.log('\nFile content:')
+    process.stdout.write(data)
+  })
+])

examples/full-s3-repo/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "full-s3-repo",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "async": "^2.6.0",
+    "aws-sdk": "^2.220.1",
+    "ipfs": "^0.28.2",
+    "ipfs-repo": "^0.18.7"
+  }
+}