{"id":15152891,"url":"https://github.com/ipfs/js-datastore-s3","last_synced_at":"2025-09-30T01:31:22.202Z","repository":{"id":31538533,"uuid":"128084145","full_name":"ipfs/js-datastore-s3","owner":"ipfs","description":"Datastore implementation with S3 backend","archived":true,"fork":false,"pushed_at":"2023-03-23T17:10:25.000Z","size":1367,"stargazers_count":71,"open_issues_count":0,"forks_count":33,"subscribers_count":25,"default_branch":"master","last_synced_at":"2024-10-29T12:11:39.923Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ipfs.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-04-04T15:40:33.000Z","updated_at":"2024-06-26T17:12:07.000Z","dependencies_parsed_at":"2024-08-05T16:11:35.244Z","dependency_job_id":null,"html_url":"https://github.com/ipfs/js-datastore-s3","commit_stats":{"total_commits":111,"total_committers":13,"mean_commits":8.538461538461538,"dds":0.5585585585585586,"last_synced_commit":"488898ebd7f66670aecdd21533728e4b71447637"},"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ipfs%2Fjs-datastore-s3","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ipfs%2Fjs-datastore-s3/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ipfs%2Fjs-datastore-s3/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ipfs%2Fjs-datastore-s3/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ipfs","download_url":"https://codeload.github.com/ipfs/js-datastore-s3/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":222073999,"owners_count":16926423,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-09-26T16:41:09.569Z","updated_at":"2025-09-30T01:31:21.873Z","avatar_url":"https://github.com/ipfs.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# ⛔️ This module is now part of https://github.com/ipfs/js-stores\n\n# datastore-s3 \u003c!-- omit in toc --\u003e\n\n[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)\n[![Discuss](https://img.shields.io/discourse/https/discuss.ipfs.tech/posts.svg?style=flat-square)](https://discuss.ipfs.tech)\n[![codecov](https://img.shields.io/codecov/c/github/ipfs/js-datastore-s3.svg?style=flat-square)](https://codecov.io/gh/ipfs/js-datastore-s3)\n[![CI](https://img.shields.io/github/actions/workflow/status/ipfs/js-datastore-s3/js-test-and-release.yml?branch=master\\\u0026style=flat-square)](https://github.com/ipfs/js-datastore-s3/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)\n\n\u003e IPFS datastore implementation backed by s3\n\n## Table of contents \u003c!-- omit in toc --\u003e\n\n- [Install](#install)\n  - [Browser `\u003cscript\u003e` tag](#browser-script-tag)\n- [Usage](#usage)\n  - [Create a Repo](#create-a-repo)\n  - [Examples](#examples)\n- [License](#license)\n- [Contribute](#contribute)\n\n## Install\n\n```console\n$ npm i datastore-s3\n```\n\n### Browser `\u003cscript\u003e` tag\n\nLoading this module through a script tag will make it's exports available as `DatastoreS3` in the global namespace.\n\n```html\n\u003cscript src=\"https://unpkg.com/datastore-s3/dist/index.min.js\"\u003e\u003c/script\u003e\n```\n\n## Usage\n\nIf 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.\n\n```js\nimport S3 from 'aws-sdk/clients/s3.js'\nimport { S3Datastore } from 'datastore-s3'\n\nconst s3Instance = new S3({ params: { Bucket: 'my-ipfs-bucket' } })\nconst store = new S3Datastore('.ipfs/datastore', {\n  s3: s3Instance\n  createIfMissing: false\n})\n```\n\n### Create a Repo\n\nSee [examples/full-s3-repo](./examples/full-s3-repo) for how to quickly create an S3 backed repo using the `createRepo` convenience function.\n\n### Examples\n\nYou can see examples of S3 backed ipfs in the [examples folder](examples/)\n\n## License\n\nLicensed under either of\n\n- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / \u003chttp://www.apache.org/licenses/LICENSE-2.0\u003e)\n- MIT ([LICENSE-MIT](LICENSE-MIT) / \u003chttp://opensource.org/licenses/MIT\u003e)\n\n## Contribute\n\nContributions welcome! Please check out [the issues](https://github.com/ipfs/js-datastore-s3/issues).\n\nAlso see our [contributing document](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md) for more information on how we work, and about contributing in general.\n\nPlease be aware that all interactions related to this repo are subject to the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\nUnless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.\n\n[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fipfs%2Fjs-datastore-s3","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fipfs%2Fjs-datastore-s3","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fipfs%2Fjs-datastore-s3/lists"}