Setting Up Uptime Monitoring

= Setting Up Uptime Monitoring = This guide details how to set up a self-hosted uptime monitoring solution using Uptime Kuma, a popular and user-friendly alternative to services like Pingdom. We will cover installation, configuration, and basic usage, along with considerations for setting up public status pages.

Introduction

Ensuring your servers and services are consistently available is crucial for any system administrator. Downtime can lead to lost revenue, damaged reputation, and frustrated users. While commercial services offer robust monitoring, self-hosting provides greater control, privacy, and cost-effectiveness. Uptime Kuma is an excellent open-source tool that allows you to monitor various services, receive notifications, and display their status on a public page.

Prerequisites

Before you begin, ensure you have the following:

A Linux server with root or sudo privileges. A VPS from providers like PowerVPS (https://powervps.net/?from=32) is a good option for hosting monitoring tools.
Docker and Docker Compose installed on your server. If not, follow the official Docker installation guide for your distribution.
Basic familiarity with the Linux command line.
(Optional) A domain name or subdomain for accessing your Uptime Kuma instance and its status page.

Installing Uptime Kuma with Docker Compose

Step 1: Create a Docker Compose File

mkdir uptime-kuma
cd uptime-kuma

Create a file named docker-compose.yml with the following content:

version: '3.8'

services: uptime-kuma: image: louislam/uptime-kuma:1 container_name: uptime-kuma restart: unless-stopped ports: - "3001:3001" volumes: - ./data:/app/data - /etc/localtime:/etc/localtime:ro environment: - NODE_ENV=production

image: louislam/uptime-kuma:1: Specifies the Uptime Kuma Docker image.
container_name: uptime-kuma: Assigns a friendly name to the container.
restart: unless-stopped: Ensures the container restarts automatically if it crashes or the server reboots.
ports: - "3001:3001": Maps port 3001 on your host machine to port 3001 inside the container, which is Uptime Kuma's default port.
volumes: - ./data:/app/data: This is crucial for data persistence. It maps a local directory named data within your uptime-kuma folder to the container's data directory, ensuring your monitoring configurations are saved even if the container is removed and recreated.
volumes: - /etc/localtime:/etc/localtime:ro: Syncs the container's time with your host system's time.
environment: - NODE_ENV=production: Sets the environment to production for optimal performance.

Step 2: Start Uptime Kuma

docker-compose.yml

docker-compose up -d

-d

Step 3: Access Uptime Kuma

http://your_server_ip:3001

Step 4: Initial Setup

Adding Monitors

Step 1: Click "Add New Monitor"

Step 2: Configure Monitor Type

**HTTP(s):** Checks if a web server is responding with a 2xx status code.
**TCP:** Checks if a specific port is open and listening.
**Ping:** Sends ICMP echo requests to an IP address or hostname.
**Keyword:** Checks if a specific keyword exists on a web page.
**Docker:** Monitors the status of Docker containers.
** and many more...**

For example, to monitor a website:

Select "HTTP(s)".
Enter the URL (e.g., https://yourwebsite.com).
Give it a name (e.g., "My Website").
Set the interval (e.g., every 1 minute).
Configure advanced settings like expected status code (e.g., 200) or response time thresholds if needed.

For example, to monitor a database on a specific port:

Select "TCP".
Enter the hostname or IP address (e.g., db.yourdomain.com or 192.168.1.10).
Enter the port number (e.g., 5432 for PostgreSQL, 3306 for MySQL).
Give it a name (e.g., "Database Server").
Set the interval.

Step 3: Save the Monitor

Setting Up Notifications

Step 1: Navigate to "Settings"

Step 2: Go to "Notification Services"

Step 3: Add a Notification Service

Step 4: Configure the Service

Step 5: Assign Monitors to Notifications

Public Status Page

Step 1: Enable Status Page

Step 2: Configure Status Page Appearance

Step 3: Add Monitors to Status Page

Step 4: Access Your Status Page

http://your_server_ip:3001/status

Advanced Configurations

Reverse Proxy with Nginx

status.yourdomain.com

First, ensure you have Nginx installed and running. Then, create an Nginx configuration file (e.g., /etc/nginx/sites-available/uptime-kuma):

server {
    listen 80;
    server_name status.yourdomain.com;
    location / {
        proxy_pass http://127.0.0.1:3001;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
    }
}

sudo ln -s /etc/nginx/sites-available/uptime-kuma /etc/nginx/sites-enabled/
sudo systemctl restart nginx