Local Development

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.

Setup

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

Run

pnpm dev

This starts both services in parallel:

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

To run them independently:

pnpm dev:api   # API only  → :3000
pnpm dev:web   # Web only  → :3001

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

First run

On first start, visit http://localhost:3001, you’ll be redirected to /setup to create your admin account. Once logged in, go to API Keys (bottom-left profile menu) to generate your first key.

Storage

By default, uploaded files are stored in apps/api/public/. To use cloud storage (AWS S3, Cloudflare R2, etc.) during local development, configure the STORAGE_* variables in apps/api/.env.

Getting Started

Configuration

Media Transformations

Resources

Prerequisites

Setup

Run

Run with Docker Compose

First run

Storage

Next steps

Image Transformations

Project Structure

​Prerequisites

​Setup

​Run

​Run with Docker Compose

​First run

​Storage

​Next steps

Image Transformations

Project Structure

Prerequisites

Setup

Run

Run with Docker Compose

First run

Storage

Next steps