datastore-s3

    6.0.0 • Public • Published

    js-datastore-s3

    Build Status codecov Dependency Status js-standard-style

    Datastore implementation backed by s3.

    Lead Maintainer

    Jacob Heun

    Table of Contents

    Install

    $ npm install datastore-s3
    

    Usage

    If the flag createIfMissing is not set or is false, then the bucket must be created prior to using datastore-s3. Please see the AWS docs for information on how to configure the S3 instance. A bucket name is required to be set at the s3 instance level, see the below example.

    const S3 = require('aws-sdk').S3
    const s3Instance = new S3({ params: { Bucket: 'my-ipfs-bucket' } })
    const S3Store = require('datastore-s3')
    const store = new S3Store('.ipfs/datastore', {
      s3: s3Instance
      createIfMissing: false
    })

    Create a Repo

    See examples/full-s3-repo for how to quickly create an S3 backed repo using the createRepo convenience function.

    Examples

    You can see examples of S3 backed ipfs in the examples folder

    Contribute

    PRs accepted.

    Small note: If editing the Readme, please conform to the standard-readme specification.

    License

    MIT 2018 © IPFS

    Install

    npm i datastore-s3

    DownloadsWeekly Downloads

    339

    Version

    6.0.0

    License

    MIT

    Unpacked Size

    59.4 kB

    Total Files

    6

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar