Local Development

Prerequisites

Node.js
pnpm
FFmpeg
Optional

Node.js: Version 18.0.0 or higher

node --version  # Should be >= 18.0.0

pnpm: Version 9.0.0 or higher

# Install pnpm if not already installed
npm install -g pnpm@9.0.0

# Verify installation
pnpm --version

FFmpeg: Required for video processing

brew install ffmpeg

Cloud Storage Credentials: Only required if using cloud storage mode (AWS S3 or Cloudflare R2)
- For local development, files can be placed in apps/api/public/
- See Storage configuration for cloud setup

Clone the repository

Clone Openinary and move into the project directory:

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

Installation

Install all dependencies:

pnpm install

Start Everything

Start both the API and frontend:

pnpm dev

This will start both the API and frontend simultaneously.

Start Separately

Run the API and frontend separately:

pnpm dev:api
pnpm dev:web

Using Docker

You can also run Openinary using Docker Compose. This is useful if you want to avoid installing dependencies locally or need isolated environments.

Start Full Stack

Start both the API and frontend with Docker:

docker compose --profile full up --build

Start API Only

Start only the API service:

docker compose --profile api up --build

Getting Started

Configuration

Media Transformations

Guides

Resources

Prerequisites

Clone the repository

Installation

Start Everything

Start Separately

Using Docker

Start Full Stack

Start API Only

Getting Started

Configuration

Media Transformations

Guides

Resources

​Prerequisites

​Clone the repository

​Installation

​Start Everything

​Start Separately

​Using Docker

​Start Full Stack

​Start API Only

Prerequisites

Clone the repository

Installation

Start Everything

Start Separately

Using Docker

Start Full Stack

Start API Only