Get started

These commands run the standalone service on your own machine. You need Docker with Compose.

1. Clone the ObjectStore repository at v0.0.8 and enter it.
2. Copy .env.example to .env. Set unique S3_ACCESS_KEY and S3_SECRET_KEY values. The access key needs at least 16 alphanumeric characters; the secret needs at least 32 characters.
3. Start the service and check its health:

cp .env.example .env
docker compose up -d --build
curl http://127.0.0.1:9000/health

The S3 endpoint binds to localhost on port 9000. Object data stays in the object-data Docker volume. Do not run docker compose down -v unless you intend to delete that volume.

The defaults are 128 MiB per object and 2 GiB total. Change MAX_OBJECT_BYTES and MAX_TOTAL_BYTES in .env if needed. Incomplete multipart uploads consume space until aborted.

To inspect the running container:

docker compose exec objectstore objectstore status
docker compose exec objectstore objectstore verify
docker compose exec objectstore objectstore version

The v0.0.8 README covers optional encrypted mounts, credentials, and the local cluster prototype. Use the Java client if you want a JDK-only client library.