https://github.com/textileio/basin-s3
https://github.com/textileio/basin-s3
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/textileio/basin-s3
- Owner: textileio
- License: mit
- Created: 2024-07-19T17:09:31.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-21T14:59:44.000Z (almost 2 years ago)
- Last Synced: 2025-06-15T05:41:19.686Z (about 1 year ago)
- Language: Rust
- Size: 109 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Basin S3
[](./LICENSE)
[](https://github.com/RichardLitt/standard-readme)
> An S3 adapter for Basin
# Table of Contents
- [Basin S3](#basin-s3)
- [Table of Contents](#table-of-contents)
- [Background](#background)
- [Usage](#usage)
- [Development](#development)
- [Contributing](#contributing)
- [License](#license)
# Background
**Basin S3** is a S3 adapter for Basin. It provides a S3 compatible API that translates S3 requests into Basin transactions or requests. With that we're able to leverage any S3 client or tooling to make use of the Basin features.
The Basin S3 implementation is built on top of the [s3s](https://github.com/Nugine/s3s) project. `s3s` provides a [trait](https://github.com/Nugine/s3s/blob/main/crates/s3s/src/s3_trait.rs#L10), generated from [aws-sdk-rust](https://github.com/awslabs/aws-sdk-rust) repository. By providing an implementation of that trait we can provide an HTTP service that "speaks S3".
# Usage
You can start the server by running
```bash
cargo run --features binary -- --private-key [PRIVATE_KEY] --access-key AKEXAMPLES3S --secret-key SKEXAMPLES3S
```
In read-only mode, just omit the private key.
You can point the adapter to a specific Basin network by providing the `--network` flag. By default, it points to `testnet`. For development, you can use `localnet` or `devnet`.
# Development
Right now, for lack of a better option, the tests rely on a running 3-node `localnet` network. So, make sure you have one running locally to run them.
# Deployment
Building the Docker image:
```bash
docker build -t basin-s3 .
```
Running it
```bash
docker run -dt \
-e HOST=0.0.0.0 \
-e ACCESS_KEY=S3EXAMPLEAK \
-e SECRET_KEY=S3EXAMPLESK \
-e PRIVATE_KEY=PRIVATE_KEY \
--name basin-s3 \
--network host \
basin-s3
```
note: `--network=host` does not work on MacOS.
# Contributing
PRs accepted.
Small note: If editing the README, please conform to the
[standard-readme](https://github.com/RichardLitt/standard-readme) specification.
# License
MIT AND Apache-2.0, © 2021-2024 Basin Network Contributors