Getting Started with Cluster Uptime in 5 Minutes: From Zero to Monitored

You have 5 minutes. You want a professional monitoring dashboard. You don’t want to enter your credit card.

Let’s go.

Minute 1: The Prerequisites

You need Docker installed.

• Mac/Windows: Install Docker Desktop.
• Linux: curl -fsSL https://get.docker.com | sh

Minute 2: The Command

Open your terminal. Paste this.

# Clone the repo
git clone https://github.com/ClusterUptime/clusteruptime.git

# Enter directory
cd clusteruptime

# Start the stack (Detached mode)
docker compose up -d

You will see Docker pulling layers. Pulling database... done Pulling backend... done Pulling dashboard... done

Minute 3: The Login

Open your browser to: http://localhost:3000

(Or http://YOUR_VPS_IP:3000 if on a server).

Create your admin account. The first user created becomes the Super Admin.

Minute 4: Your First Monitor

1. Click the big green + New Monitor button.
2. Name: Google
3. URL: https://google.com
4. Interval: 60 seconds.
5. Type: HTTP.
6. Click Save.

Minute 5: Seeing Green

Wait a few seconds. The grey bar turns Green. You will see the Response Time (e.g., 140ms). You will see the “Uptime: 100%” badge.

Bonus: Dark Mode

Go to Settings -> Appearance. Toggle Dark Mode. Ah. Much better.

Troubleshooting

• Port 3000 busy? Edit docker-compose.yml and change "3000:3000" to "4000:3000".
• No Emails? You need to configure SMTP settings in .env to send alerts.

Congratulations. You are now a Self-Hoster.