GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Openinary Docs home page
  • Cloud Quickstart
  • Quick Start
  • Migrate from Cloudinary
  • How Transformations Work
  • Image Transformations
  • Video Transformations
  • Overlays & Watermarks
  • Automatic Format Selection
  • Upload & Cache Warming
  • Signed URLs
  • File uploader
  • File uploader on Cloud
  • Integrate with Next.js

This view

  • Original page
  • New address

GeezerVison is showing docs.openinary.dev — Quick Start - Openinary Docs

One command scaffolds a project, writes its config, and starts the containers. You need Docker 20.x or higher, and Node 20+ to run the CLI. 
npx create-openinary
Answer the prompts (full stack or API-only, and optionally S3-compatible storage). It writes an openinary/ directory with a docker-compose.yml and a .env carrying a generated BETTER_AUTH_SECRET, then starts the containers on http://localhost:3000. The container ships with sample media, so you can transform something straight away: 
GET http://localhost:3000/t/w_400,h_400,c_fill/example-loan.jpg
Running the hosted version instead? See the Cloud Quickstart.

​
Create your admin account

In full stack mode, open http://localhost:3000 and you land on /setup. Create the account, then open your profile in the bottom-left of the dashboard and go to API Keys to create your first key. In API-only mode a key is generated on first boot and printed to the container logs once. Grab it with docker logs <container-id>. You can also pre-seed the account and key from the environment, see admin bootstrap.

​
Sample media

Four files ship in the image at /app/apps/api/public/: example-loan.jpg, example-grant-ritchie.jpg, example-kristopher-villa.jpg and example-rahime-gul.mp4.

​
CLI commands

npx create-openinary scaffolds. To manage the project afterwards, install the CLI globally: 
npm i -g create-openinary
CommandDescription
createScaffold a new Openinary project
startStart services
stopStop services, data preserved
restartRestart services
upgradeUpdate to the latest compatible version, syncing env vars and showing the changelog
resetDelete local data and recreate the instance. Destructive, asks for confirmation
Every command also works without the global install: npx create-openinary start, or pnpm create openinary start.

​
Volumes

Three volumes hold everything that matters. Mount all three to durable storage in production, or use S3-compatible storage instead of local volumes.
VolumePath in containerContains
openinary-db/app/dataDatabase (accounts, API keys)
openinary-public/app/apps/api/publicUploaded files
openinary-cache/app/apps/api/cacheCached transformations

​
Manual setup

Run with raw Docker commands (no CLI)

  • Full stack
  • With S3 storage
  • API only
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, no dashboard. An API key is auto-generated on first run and printed to the logs once.
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

Run from source

See Local Development.

​
Next steps

Transform Media

Every parameter for images and video, in one page.

Storage

Connect AWS S3, Cloudflare R2, or any S3-compatible provider.

File Uploader

Drop a React uploader into your app, no API key in the browser.

Server Configuration

Secrets, CORS, upload limits, and the admin bootstrap.

Was this page helpful?

⌘I
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.