Skip to content

Open-source status page, incident response and uptime monitoring

lightweight deploy (#1824)

Thibault Le Ouay9e944d902868
diff --git a/.env.docker-lightweight.example b/.env.docker-lightweight.example
new file mode 100644
index 000000000..532a76d51
--- /dev/null
+++ b/.env.docker-lightweight.example
@@ -0,0 +1,92 @@
+# ============================================================================
+# Docker Environment Configuration (Example)
+# ============================================================================
+# Copy this file to .env.docker and replace with your actual values
+#
+# NOTE: Build-time placeholders are set in each service's dofigen.yml file.
+# Values in this file override those placeholders at runtime via docker compose.
+# Required values are marked with [REQUIRED]
+
+# DATABASE
+# ============================================================================
+# LibSQL database connection - points to the libsql container
+DATABASE_URL=http://libsql:8080
+DATABASE_AUTH_TOKEN=
+
+# EMAIL
+# ============================================================================
+# [REQUIRED] Resend API key for sending magic link emails
+# Get from: https://resend.com
+RESEND_API_KEY=re_your_resend_api_key_here
+
+# AUTHENTICATION
+# ============================================================================
+# [REQUIRED] NextAuth secret - generate with: openssl rand -base64 32
+AUTH_SECRET=your-random-secret-here-min-32-chars
+
+# [REQUIRED] Self-hosted mode - enables magic link authentication
+# Set to "true" to allow email login without OAuth
+SELF_HOST="true"
+
+# GitHub OAuth (optional)
+# Get from: https://github.com/settings/developers
+AUTH_GITHUB_ID=
+AUTH_GITHUB_SECRET=
+
+# Google OAuth (optional)
+# Get from: https://console.cloud.google.com
+AUTH_GOOGLE_ID=
+AUTH_GOOGLE_SECRET=
+
+
+
+# Super admin token for privileged operations
+SUPER_ADMIN_TOKEN=
+
+# Server region identifier
+FLY_REGION=self-hosted
+
+# STRIPE
+# ============================================================================
+# Stripe (optional - for payments)
+# Get from: https://stripe.com/docs/keys
+STRIPE_SECRET_KEY=
+STRIPE_WEBHOOK_SECRET_KEY=
+NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY=
+
+# VERCEL
+# ============================================================================
+# Vercel (optional - for custom domains)
+# Get from: https://vercel.com
+PROJECT_ID_VERCEL=
+TEAM_ID_VERCEL=
+VERCEL_AUTH_BEARER_TOKEN=
+
+# Vercel Blob storage (optional)
+BLOB_READ_WRITE_TOKEN=
+
+# OBSERVABILITY
+# ============================================================================
+# Sentry (optional - error tracking)
+# Get from: https://sentry.io
+NEXT_PUBLIC_SENTRY_DSN=
+SENTRY_AUTH_TOKEN=
+
+
+
+# SERVICE CONFIGURATION
+# ============================================================================
+NODE_ENV=production
+
+# [REQUIRED] Public URL for the application
+NEXT_PUBLIC_URL=http://localhost:3002
+
+
+
+# DEVELOPMENT & TESTING
+# ============================================================================
+# Turbo build mode
+TURBO_ENV_MODE=loose
+
+
+WORKSPACES_HIDE_URL=
diff --git a/.env.docker.example b/.env.docker.example
index c5d671ad7..9dc891d85 100644
--- a/.env.docker.example
+++ b/.env.docker.example
@@ -13,10 +13,6 @@
DATABASE_URL=http://libsql:8080
DATABASE_AUTH_TOKEN=
-# ClickHouse (optional - for advanced analytics)
-CLICKHOUSE_URL=
-CLICKHOUSE_USERNAME=
-CLICKHOUSE_PASSWORD=
# REDIS & QUEUE
# ============================================================================
diff --git a/apps/docs/astro.config.mjs b/apps/docs/astro.config.mjs
index 9f32b0f7d..f9262fbb6 100644
--- a/apps/docs/astro.config.mjs
+++ b/apps/docs/astro.config.mjs
@@ -142,6 +142,10 @@ export default defineConfig({
label: "How to self-host openstatus",
slug: "guides/self-hosting-openstatus",
},
+ {
+ label: "Self host Status Page only",
+ slug: "guides/self-host-status-page-only",
+ },
],
},
{
diff --git a/apps/docs/src/content/docs/guides/self-host-status-page-only.mdx b/apps/docs/src/content/docs/guides/self-host-status-page-only.mdx
new file mode 100644
index 000000000..73962e56a
--- /dev/null
+++ b/apps/docs/src/content/docs/guides/self-host-status-page-only.mdx
@@ -0,0 +1,59 @@
+---
+title: Only deploy the openstatus status page (self-hosting)
+description: Complete guide to deploying openstatus status page on your own infrastructure
+---
+
+
+Openstatus is a status page platform with monitoring capabilities. If you only want to self-host the status page component of openstatus, this guide will walk you through the process.
+
+
+## Prerequisites
+
+- Docker and Docker Compose installed
+- Basic understanding of Docker and containerization
+- Command line experience
+- Git installed
+- Node.js and pnpm (for database migrations)
+
+
+### Part 1: Initial Setup and Service Launch
+
+1. **Clone the Repository**
+
+ Get the latest version of openstatus:
+ ```bash
+ git clone https://github.com/openstatushq/openstatus
+ cd openstatus
+ ```
+
+2. **Configure Your Environment**
+
+ Copy the example environment file. This file will hold all your configuration variables.
+ ```bash
+ cp .env.docker-lightweight .env.docker
+ ```
+ Open `.env.docker` in a text editor. At a minimum, you **must** set a value for `AUTH_SECRET` for authentication to work. For a complete setup, review the file for other variables like OAuth providers or email services.
+
+
+3. **Build and Start Services**
+
+ Use Docker Compose to build and run all openstatus services in the background.
+ ```bash
+ export DOCKER_BUILDKIT=1
+ docker compose -f docker-compose.lightweight.yml up -d
+ ```
+
+### Part 2: Application Configuration
+
+Now that the services are running, you can access the dashboard and perform the final setup steps.
+
+- **Dashboard:** `http://localhost:3000`
+- **Status Pages:** `http://localhost:3001`
+
+
+You can now log in to the dashboard using email authentication. If you want to set up OAuth providers, refer to the environment variable configuration in the `.env.docker` file.
+
+
+## Next Steps
+
+Create your first status page and start adding static components to monitor your services. For more advanced configurations and monitoring setups, refer to the [full self-hosting guide](/guides/self-hosting-openstatus).
diff --git a/apps/docs/src/content/docs/guides/self-hosting-openstatus.mdx b/apps/docs/src/content/docs/guides/self-hosting-openstatus.mdx
index fa6606c02..bb6f49e05 100644
--- a/apps/docs/src/content/docs/guides/self-hosting-openstatus.mdx
+++ b/apps/docs/src/content/docs/guides/self-hosting-openstatus.mdx
@@ -21,7 +21,6 @@ openstatus provides a Docker Compose setup that makes self-hosting straightforwa
- Basic understanding of Docker and containerization
- Command line experience
- Git installed
-- Node.js and pnpm (for database migrations)
## Known limitations
diff --git a/apps/web/public/assets/changelog/grafana-oncall.png b/apps/web/public/assets/changelog/grafana-oncall.png
deleted file mode 100644
index bc79f05c9..000000000
Binary files a/apps/web/public/assets/changelog/grafana-oncall.png and /dev/null differ
diff --git a/docker-compose-lightweight.yaml b/docker-compose-lightweight.yaml
new file mode 100644
index 000000000..a31d7e37d
--- /dev/null
+++ b/docker-compose-lightweight.yaml
@@ -0,0 +1,113 @@
+networks:
+ openstatus:
+ driver: bridge
+ name: openstatus
+
+volumes:
+ libsql-data:
+ name: openstatus-libsql-data
+
+services:
+ # External services
+ libsql:
+ container_name: openstatus-libsql
+ image: ghcr.io/tursodatabase/libsql-server:latest
+ networks:
+ - openstatus
+ ports:
+ - "8080:8080"
+ - "5001:5001"
+ volumes:
+ - libsql-data:/var/lib/sqld
+ environment:
+ - SQLD_NODE=primary
+ healthcheck:
+ test:
+ [
+ "CMD-SHELL",
+ 'perl -e ''use IO::Socket::INET; exit(IO::Socket::INET->new(PeerAddr=>"127.0.0.1:8080",Timeout=>1) ? 0 : 1);''',
+ ]
+ interval: 10s
+ timeout: 5s
+ retries: 5
+ start_period: 10s
+ restart: unless-stopped
+
+ db-migrate:
+ container_name: openstatus-db-migrate
+ image: oven/bun:1.3.6
+ networks:
+ - openstatus
+ working_dir: /app/packages/db
+ volumes:
+ - .:/app
+ env_file:
+ - .env.docker
+ environment:
+ - DATABASE_URL=http://libsql:8080
+ command: ["sh", "-c", "bun install && bun run migrate"]
+ depends_on:
+ libsql:
+ condition: service_healthy
+ restart: "no"
+
+
+ dashboard:
+ container_name: openstatus-dashboard
+ build:
+ context: .
+ dockerfile: apps/dashboard/Dockerfile
+ image: openstatus/dashboard:latest
+ networks:
+ - openstatus
+ ports:
+ - "3000:3000"
+ env_file:
+ - .env.docker
+ environment:
+ - DATABASE_URL=http://libsql:8080
+ - PORT=3000
+ - HOSTNAME=0.0.0.0
+ - AUTH_TRUST_HOST=true
+ depends_on:
+ db-migrate:
+ condition: service_completed_successfully
+ libsql:
+ condition: service_healthy
+ healthcheck:
+ test: ["CMD-SHELL", "curl -f http://localhost:3000/ || exit 1"]
+ interval: 15s
+ timeout: 10s
+ retries: 3
+ start_period: 45s
+ restart: unless-stopped
+
+ status-page:
+ container_name: openstatus-status-page
+ build:
+ context: .
+ dockerfile: apps/status-page/Dockerfile
+ image: openstatus/status-page:latest
+ networks:
+ - openstatus
+ ports:
+ - "3001:3000"
+ env_file:
+ - .env.docker
+ environment:
+ - DATABASE_URL=http://libsql:8080
+ - PORT=3000
+ - HOSTNAME=0.0.0.0
+ - AUTH_TRUST_HOST=true
+ depends_on:
+ db-migrate:
+ condition: service_completed_successfully
+ libsql:
+ condition: service_healthy
+ healthcheck:
+ test: ["CMD-SHELL", "curl -f http://localhost:3000/ || exit 1"]
+ interval: 15s
+ timeout: 10s
+ retries: 3
+ start_period: 45s
+ restart: unless-stopped