Introduction

Uptime Kuma is a self-hosted monitoring tool that allows you to keep track of your websites and services. It provides an intuitive user interface and features such as status pages, alerting, and more. This guide will walk you through setting up Uptime Kuma on an Ubuntu system.

Prerequisites

  • A server running Ubuntu 20.04 or newer.
  • Docker and Docker Compose installed on your server.
  • A non-root user with sudo privileges.

Step 1: Install Docker and Docker Compose

If you haven't installed Docker and Docker Compose yet, you can install them by running the following commands:

sudo apt update sudo apt install docker.io docker-compose sudo systemctl enable docker --now sudo usermod -aG docker $USER

Log out and log back in to apply the group changes.

Step 2: Create a Docker Compose File

Create a directory for Uptime Kuma and navigate into it:

mkdir uptime-kuma && cd uptime-kuma

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

version: '3.3' services: uptime-kuma: image: louislam/uptime-kuma:1 container_name: uptime-kuma volumes: - ./data:/app/data ports: - 3001:3001 restart: unless-stopped

This configuration sets up Uptime Kuma to run on port 3001 and store its data in a local directory named data.

Step 3: Start Uptime Kuma

Start the Uptime Kuma container using Docker Compose:

docker-compose up -d

Step 4: Access Uptime Kuma

Once the container is running, you can access Uptime Kuma by opening your web browser and navigating to:

http://your_server_ip:3001

Follow the on-screen instructions to complete the setup, including creating an admin user.

Step 5: Configure Uptime Kuma

After setup, you can begin adding monitors for your websites or services by clicking on "Add New Monitor" and following the prompts to set the type of monitor, intervals, and alert conditions.

Conclusion

You now have Uptime Kuma running on your Ubuntu server. This tool will help you monitor the uptime and status of your various websites and services. For further customization and advanced features, check out the official Uptime Kuma GitHub repository or their documentation.