synaps3

SynapS3

SynapS3 lets S3 clients use Filecoin storage.

SynapS3 is a developer preview and is not ready for production use. Test with Filecoin Calibration first, and feedback is welcome.

Why SynapS3

• Use existing S3 clients, SDKs, and tools.
• Store object data through Filecoin providers.
• Manage buckets, objects, settings, tasks, and health from one dashboard.

Core Features

Quick Start

This Quick Start uses docker run for quick evaluation. For Docker Compose deployment, use the Docker deployment guide. To compile locally, use the source build guide.

Prerequisites:

• Docker Engine or Docker Desktop
• Host networking enabled for Docker Desktop

The commands use Docker host networking so the admin server can stay bound to 127.0.0.1.

cp .env.example .env
docker run --rm ghcr.io/strahe/synaps3:edge synaps3 wallet generate

Copy the generated private key into .env, then fund the generated address on Calibration:

docker run --rm --env-file .env ghcr.io/strahe/synaps3:edge synaps3 wallet fund-testnet 0x...

If it fails, claim manually from ChainSafe or Plumbline.

Start a temporary service:

docker volume create synaps3-test-data
docker run -d --name synaps3-test \
  --network host \
  --env-file .env \
  -v synaps3-test-data:/var/lib/synaps3 \
  ghcr.io/strahe/synaps3:edge

Check health and deposit USDFC:

curl http://127.0.0.1:9090/healthz
docker exec synaps3-test synaps3 --config /var/lib/synaps3/config.toml wallet deposit 2

Open the dashboard at http://127.0.0.1:9090 and upload a file. If the host is remote, use an SSH tunnel:

ssh -L 9090:127.0.0.1:9090 user@server

Clean up the testing container when done:

docker rm -f synaps3-test
docker volume rm synaps3-test-data

Documentation

• Docker deployment
• Build from source
• Configuration
• Operations

Core S3 Compatibility

License

See LICENSE.