Local Development

Clone, install, run:

git clone https://github.com/openinary/openinary.git
cd openinary
pnpm install
pnpm dev

pnpm dev starts both services in parallel.

Service	URL
API	http://localhost:3000
Web dashboard	http://localhost:3001

Run them one at a time with pnpm dev:api (:3000) or pnpm dev:web (:3001).

First run

Visit http://localhost:3001 and you are redirected to /setup to create your admin account. Once logged in, open API Keys from the bottom-left profile menu to generate your first key.

Prerequisites

Tool	Version	Notes
Node.js	≥ 20.0.0	`node --version` to check
pnpm	≥ 9.0.0	`npm install -g pnpm` to install
FFmpeg	any recent	Required for video processing

macOS
Linux (Ubuntu/Debian)
Linux (Fedora)
Windows

brew install ffmpeg

sudo apt-get install ffmpeg

sudo dnf install ffmpeg

Download a build from ffmpeg.org/download.html and add it to your PATH.

Run with Docker Compose

Prefer containers? Use the compose profiles instead:

# Full stack (API + dashboard)
docker compose --profile full up --build

# API only
docker compose --profile api up --build

Storage

Uploaded files land in apps/api/public/ by default. For cloud storage, set the STORAGE_* variables in apps/api/.env.

Get started

Transformations

Upload & storage

Cloud

Self-hosting

Resources

First run

Prerequisites

Run with Docker Compose

Storage

Next steps

Image Transformations

Project Structure

​First run

​Prerequisites

​Run with Docker Compose

​Storage

​Next steps

Image Transformations

Project Structure

First run

Prerequisites

Run with Docker Compose

Storage

Next steps