Getting Started

Get Oopsie running in minutes with Docker Compose.

Prerequisites

Docker and Docker Compose installed
A domain name pointing to your server (for production with HTTPS)

Quick Start (local)

curl -fsSL https://raw.githubusercontent.com/yoanbernabeu/oopsie/main/compose.yml -o compose.yml
curl -fsSL https://raw.githubusercontent.com/yoanbernabeu/oopsie/main/Caddyfile -o Caddyfile
docker compose up -d

This starts four services behind a Caddy reverse proxy:

Caddy — reverse proxy with automatic HTTPS
Server (API) — http://api.localhost
Dashboard — http://app.localhost
PostgreSQL — internal database

Production deployment

Create a .env file with your domain configuration:

API_DOMAIN=https://api.oopsie.example.com
DASHBOARD_DOMAIN=https://app.oopsie.example.com
NEXT_PUBLIC_API_URL=https://api.oopsie.example.com/api/v1
CORS_ALLOW_ORIGIN='^https://app\.oopsie\.example\.com$'
APP_SECRET=your-random-secret
POSTGRES_PASSWORD=your-db-password
JWT_PASSPHRASE=your-jwt-passphrase

Then run docker compose up -d. Caddy will automatically obtain and renew TLS certificates via Let's Encrypt.

Complete the setup wizard

Open the dashboard URL in your browser. On first launch, you'll be guided through:

Creating your admin account
Naming your instance
Creating your first project
Getting the SDK integration snippet

Add the SDK to your app

Copy the snippet from the setup wizard and add it to your application. See the SDK Installation guide for details.

Submit a test report

Click the floating "Report a bug" button in your app, fill in the form, and verify it appears in the dashboard.

Next steps

SDK Configuration — Customize the widget, sanitization rules, and more
Server Configuration — Environment variables reference
Webhooks — Get notified on new reports