Home
Softono

S4

Open source MIT Shell
GitHub
107
Stars
8
Forks
2
Issues
2
Watchers
5 years
Last Commit
Object Storage

 About S4

S4 is 100% S3 compatible storage, accessed through Tor and distributed using IPFS.

Platforms

Web Self-hosted Docker

Languages

Shell

Links

Source Code

Need Help Installing S4?

We provide expert installation service for this software. Our team will install, configure, and secure S4 on your server. plans start at just $30.

Hire an Expert

Alternatives to S4

View All

Rustfs

🚀2.3x faster than MinIO for 4KB object payloads. RustFS is an open-source, S3-compatible high-performance object storage system supporting migration and coexistence with other S3-compatible platforms

28.6K
Published by
anthonybudd
Visit View Profile

S4

View on GitHub

S4

S4

S4 is 100% compatible AWS S3 storage, accessed through Tor and distributed using IPFS.

Tor acts as a DNS and hides the physical location of the S4 server. IPFS acts as a CDN and will make your data permanently accessible and is impossible to take offline once it has been published. A sidecar docker container is provided to seamlessly proxy requests from your existing S3 code over Tor to S4.

S4 Video Tutorial

Create S4 server

You can set-up your own local S4 server with just 4 commands.

$ git clone [email protected]:anthonybudd/S4.git && cd S4/

$ cp .env.example .env

$ docker run -it --rm -v $(pwd)/data/tor:/web anthonybudd/s4-tor-proxy generate ^s4

$ docker-compose up

Node.js AWS-SDK Example

Once you have created your local S4 server, you can test it using the included example. This demo shows the current Node.js AWS-SDK working with the sidecar docker container to proxy the AWS S3 requests over Tor back to your local S4 server.

$ cd example/

$ nano .env

$ docker-compose up -d

$ docker exec -ti my-app node src/index.js

Architecture

S4

Tor does not just provide anonymity, Tor acts as a DNS. S4 uses Tor hidden services, data is uploaded into an S4 bucket over Tor. This also means you can create a free .onion domain name without needing any 3rd-parties. A sidecar container is provided to seamlessly proxy requests from your existing S3 code over Tor to S4.

IPFS acts as a CDN. Each S4 bucket is published to IPFS under a separate key allowing you to address your files using any existing IPFS HTTP gateway like this https://ipfs.io/ipns/[BUCKET-KEY]/image.jpg. This link will never change or go offline, the more people who request it, the faster the data will be returned to the user.

Build a Node

S4 node

S4 is designed to democratise object-storage technology so anyone can have S3-like data storage without needing to depend on giant cloud tech providers. It was specifically built to run on a Raspberry Pi in production. A full blog post has been provided with in-depth instructions on how to build your own S4 node. A basic overview is provided below.

  • Install Ubuntu 20.04

  • $ git clone [email protected]:anthonybudd/S4.git

  • $ cd S4

  • $ ./install

  • $ sudo mount /dev/XXX /mnt/ssd

  • $ sed -i "" "s#S4_ROOT=.*#S4_ROOT=/mnt/ssd#" .env

  • $ sed -i "" "s#ACCESS_KEY=.*#ACCESS_KEY=$(openssl rand -hex 10)#" .env

  • $ sed -i "" "s#SECRET_KEY=.*#SECRET_KEY=$(openssl rand -hex 20)#" .env

  • $ sudo reboot

  • $ docker run -it --rm -v /mnt/ssd/tor:/web anthonybudd/s4-tor-proxy:arm64v8 generate ^s4

  • $ docker-compose up