Documentation Index
Fetch the complete documentation index at: https://docs.openinary.dev/llms.txt
Use this file to discover all available pages before exploring further.
Prerequisites
Run
docker pull openinary/openinary:latest
Full stack
With S3 storage
API only
Starts the API and web dashboard together.docker run --platform linux/amd64 -d -p 3000:3000 \
-v openinary-cache:/app/apps/api/cache \
-v openinary-public:/app/apps/api/public \
-v openinary-db:/app/data \
openinary/openinary:latest
Replaces local file storage with a cloud bucket.docker run --platform linux/amd64 -d -p 3000:3000 \
-v openinary-db:/app/data \
-e STORAGE_REGION=us-east-1 \
-e STORAGE_ACCESS_KEY_ID=XXXXXXXXXXXXXXXXXXXX \
-e STORAGE_SECRET_ACCESS_KEY=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx \
-e STORAGE_BUCKET_NAME=your-bucket \
-e STORAGE_ENDPOINT=https://s3.filebase.com/ \
openinary/openinary:latest
Headless mode — no web dashboard. An API key is auto-generated on first run.docker pull openinary/openinary-api:latest
docker run --platform linux/amd64 -d -p 3000:3000 \
-v openinary-cache:/app/apps/api/cache \
-v openinary-public:/app/apps/api/public \
-v openinary-db:/app/data \
-e MODE=api \
openinary/openinary-api:latest
The API key appears once in the container logs. Retrieve it immediately:docker logs <container-id>
Initial setup (full stack)
- Open http://localhost:3000 — you’ll be redirected to
/setup.
- Create your admin account.
- Click your profile in the bottom-left of the dashboard → API Keys → create your first key.
Your Openinary instance is ready.
Sample files
The container ships with two files for testing, available at /app/apps/api/public/:
example-loan.jpg — for image transformation testsexample-rahime-gul.mp4 — for video transformation tests
Try a transformation immediately:
GET http://localhost:3000/t/w_400,h_400,c_fill/example-loan.jpg
Without Docker
Prefer running from source? See Local Development.
Volume persistence — in production, always mount all three volumes to durable storage. Losing a volume means losing that data.| Volume | Path in container | Contains |
|---|
openinary-db | /app/data | Database (accounts, API keys) |
openinary-public | /app/apps/api/public | Uploaded files |
openinary-cache | /app/apps/api/cache | Cached transformations |
Next steps
Image Transformations
Resize, crop, convert format, and optimize images via URL.
Video Transformations
Resize, trim, and extract thumbnails from videos.
Storage
Connect AWS S3, Cloudflare R2, or any S3-compatible provider.
Security
API key management, rate limiting, and best practices.
