Network Performance Monitor

    datastore-s3
    TypeScript icon, indicating that this package has built-in type declarations

    10.0.0 • Public • Published

    datastore-s3

    ipfs.io IRC Discord codecov CI

    IPFS datastore implementation backed by s3

    Table of contents

    Install

    $ npm i 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.

    import S3 from 'aws-sdk/clients/s3.js'
    import { S3Datastore } from 'datastore-s3'
    
    const s3Instance = new S3({ params: { Bucket: 'my-ipfs-bucket' } })
    const store = new S3Datastore('.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

    Licensed under either of

    Contribute

    Feel free to join in. All welcome. Open an issue!

    This repository falls under the IPFS Code of Conduct.

    Install

    npm i datastore-s3

    DownloadsWeekly Downloads

    193

    Version

    10.0.0

    License

    Apache-2.0 OR MIT

    Unpacked Size

    72.9 kB

    Total Files

    8

    Last publish

    Collaborators

    • jacobheun
    • daviddias
    • achingbrain
    • npm-service-account-ipfs