Quickstart

Get ReliaPulse running in 5 minutes with Docker.

Prerequisites

• Docker (opens in a new tab) installed
• Docker Compose (opens in a new tab) v2.0+

Step 1: Clone the Repository

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

Step 2: Start the Services

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

This starts all required services:

• app - Next.js application (port 3000)
• db - PostgreSQL database (port 5432)
• redis - Redis for background jobs (port 6379)
• worker - Notification and monitoring processor
• adminer - Database admin interface (port 8080)

Step 3: Wait for Startup

Wait about 30 seconds for all services to initialize, then check the logs:

docker compose -f docker/docker-compose.yml logs app

Look for Ready on http://localhost:3000 to confirm the app is running.

Step 4: Create Your Account

1. Open http://localhost:3000 (opens in a new tab) in your browser
2. Click "Register" to create a new account
3. Enter your email and password
4. You'll be automatically logged in and redirected to the dashboard

Step 5: Explore the Dashboard

You now have access to the full ReliaPulse dashboard:

• Dashboard - Overview of your status page health
• Components - Define your services and infrastructure
• Incidents - Report and track outages
• Monitors - Set up HTTP health checks
• Status Pages - Build your public status page

Key URLs

Useful Docker Commands

# View logs for all services
docker compose -f docker/docker-compose.yml logs
 
# View logs for a specific service
docker compose -f docker/docker-compose.yml logs app
 
# Stop all services
docker compose -f docker/docker-compose.yml down
 
# Stop and remove all data (fresh start)
docker compose -f docker/docker-compose.yml down -v
 
# Restart a specific service
docker compose -f docker/docker-compose.yml restart app

Troubleshooting

Port Already in Use

If port 3000 is already in use, edit docker/docker-compose.yml and change the port mapping:

ports:
  - "3001:3000"  # Change 3000 to an available port

Database Connection Issues

If the app can't connect to the database, ensure the db service is healthy:

docker compose -f docker/docker-compose.yml ps

All services should show healthy or running status.

Need to Reinstall Packages

docker compose -f docker/docker-compose.yml exec app npm install <package-name>

Next Steps

Now that you have ReliaPulse running:

1. Create your first status page - Build a public page for your users
2. Create your first incident - Learn incident management
3. Learn core concepts - Understand the data model

For production deployments, see our Deployment Guide.