Installation

This guide covers different installation methods for ReliaPulse.

Installation Methods

Docker Installation

The easiest way to run ReliaPulse is with Docker Compose.

Prerequisites

Docker 24.0+
Docker Compose v2.0+
2GB RAM minimum (4GB recommended)
10GB disk space

1. Clone the Repository

git clone https://github.com/reliapulse/reliapulse.git
cd status-page

2. Configure Environment

Copy the example environment file:

cp docker/.env.example docker/.env

Edit docker/.env with your settings:

# Required
DATABASE_URL="postgresql://postgres:postgres@db:5432/reliapulse"
NEXTAUTH_SECRET="your-super-secret-key-change-this"
NEXTAUTH_URL="http://localhost:3000"

# Optional: Email (for notifications)
SMTP_HOST="smtp.example.com"
SMTP_PORT="587"
SMTP_USER="your-email@example.com"
SMTP_PASSWORD="your-password"
SMTP_FROM="noreply@example.com"

# Optional: OAuth providers
GITHUB_CLIENT_ID=""
GITHUB_CLIENT_SECRET=""
GOOGLE_CLIENT_ID=""
GOOGLE_CLIENT_SECRET=""

⚠️

Always change NEXTAUTH_SECRET to a random string in production. Generate one with:

openssl rand -base64 32

3. Start Services

docker compose -f docker/docker-compose.yml up -d

4. Verify Installation

# Check all services are running
docker compose -f docker/docker-compose.yml ps
 
# Check application logs
docker compose -f docker/docker-compose.yml logs app

Open http://localhost:3000 (opens in a new tab) to access the application.

Post-Installation

After installation, complete these steps:

1. Create Your Account

Visit the application and register the first user account. This user becomes the organization owner.

2. Configure Organization

Go to Settings > Organization to:

Set your organization name
Upload logo (light and dark mode)
Configure uptime display thresholds

3. Create Components

Navigate to Components to define your services:

Add SERVICE components for logical groupings
Add ENDPOINT components for monitored services
Organize with component groups

4. Build Your Status Page

Go to Status Pages to:

Create a new status page
Choose a template
Customize with widgets
Set your page slug (URL)

Upgrading

Docker

cd status-page
git pull
docker compose -f docker/docker-compose.yml down
docker compose -f docker/docker-compose.yml build
docker compose -f docker/docker-compose.yml up -d

Manual

cd status-page
git pull
npm install
npx prisma migrate deploy
npm run build
# Restart application and worker

Uninstalling

Docker (Complete Removal)

# Stop and remove containers, networks, and volumes
docker compose -f docker/docker-compose.yml down -v
 
# Remove images
docker rmi status-page-app status-page-worker

Manual

Stop the application and worker processes
Drop the PostgreSQL database
Remove the project directory

Next Steps

Quickstart Core Concepts