Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.mirage.strukto.ai/llms.txt

Use this file to discover all available pages before exploring further.

Credentials

Supabase Storage exposes an S3-compatible API at https://<project-ref>.storage.supabase.co/storage/v1/s3, signed with S3 Access Keys scoped to a Supabase project (not your anon or service_role JWT).

1. Create an S3 access key

  1. Open the Supabase dashboard and pick your project.
  2. Storage -> Settings -> S3 Access Keys.
  3. New access key -> scope to the bucket(s) you want Mirage to mount.
  4. Copy the Access key ID and Secret access key, the secret is shown once.

2. Note the project reference and region

  • Project reference is in the dashboard URL: https://supabase.com/dashboard/project/<project-ref>.
  • Region is the region you selected when creating the project. Supabase requires a region string for SigV4 signing even though it is metadata only.

3. Set Environment Variables

# .env.development
SUPABASE_BUCKET=my-bucket
SUPABASE_REGION=us-east-1
SUPABASE_PROJECT_REF=abcdefghijklmnop
SUPABASE_ACCESS_KEY_ID=...
SUPABASE_SECRET_ACCESS_KEY=...
Supabase requires path-style S3 URLs. The Mirage resource sets forcePathStyle: true automatically when you pass project_ref.
For Python configuration, see the Python Supabase Resource guide. For Node and browser wiring, see the TypeScript Supabase Setup guide.