Skip to content

Uptime Kuma: Uptime Monitoring System

Uptime Kuma

Uptime Kuma is a self-hosted, open source, fancy uptime monitoring and alerting system. It can monitor HTTP, HTTP(s) with keyword, TCP, Ping, and DNS systems. It is similar to a monitoring tool like UptimeRobot.

Features of Uptime Kuma

  • Monitoring uptime for HTTP(s) / TCP / Ping / DNS Record / Push.
  • Fancy, Reactive, Fast UI/UX.
  • Notifications via Telegram, Discord, Gotify, Slack, Pushover, Email (SMTP), and more.
  • 20 second intervals.
  • Multi Languages
  • Simple Status Page
  • Ping Chart
  • Certificate Info

Uptime-Kuma Setup

1. Pulling image from Docker Hub

Usage: 

$ docker pull image:tag
Example: 
$ docker pull louislam/uptime-kuma

2. Starting uptime-kuma container

Usage: 

$ docker run -d -p external-port:internal-port -v local-volume-path:app-volume-path --name container-name image:tag

Example: 

$ docker run -d -p 3001:3001 -v uptime-kuma/:/app/data --name uptime-kuma louislam/uptime-kuma
Uptime Kuma will be available at http://localhost:3001/. The port -p 3001:3001 can be changed to any port. For example, if we want to view the uptime-kuma over port 4040 then you would do -p 4040:3001.

3. Starting uptime-kuma using docker-compose

version: "3.1"
 services:
      uptime-kuma:
        image: louislam/uptime-kuma
        container_name: uptime-kuma
       volumes:
             - /data:/app/data
        ports:
              - 3001:3001
        restart: always

Using Uptime-kuma

1. Login

Creating an admin account for the first time usage 1

2. Dashboard

2

3. Adding new a new monitor

a. Monitor type: Ping

3

Monitor type ping is used to ping servers. We can change heartbeat intervals and retires. Default is 60 sec for heartbeat intervals and 0 for retry.

b. Monitor type: HTTP(s)

4

Monitor type HTTP(s) can be used to ping the health check of our apps.

4. Detailed view of a monitor

5

5. Status page

6

6. Editing status page

7

7. Settings page

8

Settings can be changed in the settings page. Notifications can be setup which will send alert messages to our desired platforms like: slack, telegram, discord etc.

8. Notifications settings

9

For Notification setting, telegram bot should already be setup. For reference click here.

9. Notification Test

10

  1. Contributors: Ujan Man Shakya ↩