Sign inSign up

essayoub/drime-s3

By essayoub

•Updated 23 days ago

S3-compatible gateway for Drime Cloud

Image
Databases & storage
0

5.0K

essayoub/drime-s3 repository overview

⁠drime-s3

S3-compatible gateway for Drime Cloud⁠ — expose your Drime workspace through the S3 API so AWS CLI, SDKs, Duplicati, restic, and other S3 tools can back up and sync to Drime using a custom endpoint.

⁠What this image provides

  • S3 API on port 8081 — root folders in your Drime workspace map to buckets; list, upload, download, and delete objects like S3.
  • AWS Signature Version 4 — use access key / secret you configure (not your Drime token).
  • Web admin UI at /_ui/ — workspace setup, buckets, object browser, uploads.
  • Region drime — set this on S3 clients (path-style URLs).

⁠Quick start

docker run -d --name drime-s3 \
  -p 8081:8081 \
  -e DRIME_API_KEY="YOUR_DRIME_API_TOKEN" \
  -e DRIME_API_BASE_URL="https://app.drime.cloud/api/v1" \
  -e DRIME_GATEWAY_WORKSPACE_NAME="drime-s3" \
  -e S3_ACCESS_KEY="YOUR_S3_ACCESS_KEY" \
  -e S3_SECRET_KEY="YOUR_S3_SECRET_KEY" \
  -e WEB_UI_PASSWORD="changeme" \
  -e WEB_UI_SESSION_SECRET="00112233445566778899aabbccddeeff00112233445566778899aabbccddeeff" \
  essayoub/drime-s3:latest
  1. Open http://127.0.0.1:8081/_ui/⁠ and sign in with WEB_UI_PASSWORD.
  2. Complete workspace onboarding if prompted (creates/links the Drime workspace).
  3. Point S3 clients at http://127.0.0.1:8081⁠ with region drime.

⁠Docker Compose

services:
  drime-s3:
    image: essayoub/drime-s3:latest
    restart: unless-stopped
    ports:
      - "8081:8081"
    environment:
      DRIME_API_KEY: "YOUR_DRIME_API_TOKEN"
      DRIME_API_BASE_URL: "https://app.drime.cloud/api/v1"
      DRIME_GATEWAY_WORKSPACE_NAME: "drime-s3"
      S3_ACCESS_KEY: "YOUR_S3_ACCESS_KEY"
      S3_SECRET_KEY: "YOUR_S3_SECRET_KEY"
      WEB_UI_PASSWORD: "changeme"
      WEB_UI_SESSION_SECRET: "00112233445566778899aabbccddeeff00112233445566778899aabbccddeeff"

docker compose up -d

⁠AWS CLI example

export AWS_ACCESS_KEY_ID="YOUR_S3_ACCESS_KEY"
export AWS_SECRET_ACCESS_KEY="YOUR_S3_SECRET_KEY"
export AWS_DEFAULT_REGION=drime
export AWS_EC2_METADATA_DISABLED=true
export AWS_USE_PATH_STYLE_ENDPOINT=true
export AWS_ENDPOINT_URL_S3="http://127.0.0.1:8081"

aws s3 ls
aws s3 mb s3://my-bucket
aws s3 cp ./file.txt s3://my-bucket/file.txt

⁠Environment variables

VariableRequiredDescription
DRIME_API_KEYYesDrime API token
DRIME_API_BASE_URLNoDefault: https://app.drime.cloud/api/v1
DRIME_GATEWAY_WORKSPACE_NAMENoDrime workspace name for buckets (default: drime-s3)
S3_ACCESS_KEY / S3_SECRET_KEYYes*Credentials for S3 clients (*required unless using insecure mode)
WEB_UI_PASSWORDRecommendedPassword for /_ui/ admin login
WEB_UI_SESSION_SECRETRecommended64 hex chars (32 bytes) for session cookies

Change default passwords and secrets before production. Do not expose the gateway on the public internet without TLS and proper authentication.

⁠Tags

  • latest, 1.5.2, v1.5.2 — stable releases
  • main, sha-<commit> — rolling builds from the default branch

Also published on GHCR: ghcr.io/essare/drime-s3

⁠Links

Tag summary

Content type

Image

Digest

sha256:3c11cbaa3…

Size

41.6 MB

Last updated

about 2 months ago

docker pull essayoub/drime-s3