Getting Started

Uptime Kuma is a self-hosted monitoring tool that tracks the availability of your websites, APIs, and services. It supports HTTP/HTTPS, TCP, DNS, ping, and more, and sends alerts via Slack, email, Telegram, and dozens of other channels. Available as an open web service in Eyevinn Open Source Cloud, Uptime Kuma gives your team a clear, real-time status dashboard with no external dependencies.

Prerequisites

Step 1: Create a MariaDB database

Uptime Kuma uses MariaDB to store monitor configuration, status history, and alert settings. Navigate to the MariaDB service in the OSC web console. Click Create mariadb, enter a name, a root password, a database name (e.g. uptimekuma), and a user and password for that database, then click Create.

Once the instance is running, note the IP address and port. The connection URL will be:

mysql://<user>:<password>@<IP>:<PORT>/<database>

For example:

mysql://kuma:mypassword@172.232.131.169:10520/uptimekuma

Step 2: Store the connection URL as a secret

Navigate to the Uptime Kuma service page, go to the Service Secrets tab, and click New Secret. Enter a name such as dburl and paste the full MariaDB connection URL as the value.

Step 3: Create an Uptime Kuma instance

Go to the My uptime-kumas tab and click Create uptime-kuma. Fill in:

  • Name: a unique name for your instance (alphanumeric only, e.g. mymonitoring)
  • DatabaseUrl: {{secrets.dburl}} (references the secret created in Step 2)

Click Create and wait for the status indicator to turn green.

Step 4: Set up your admin account

Click the instance URL to open Uptime Kuma in your browser. On the first visit, you will be prompted to create an admin username and password. Choose your credentials and click Create.

You are now logged in to the Uptime Kuma dashboard.

Step 5: Add your first monitor

Click Add New Monitor and configure:

  • Monitor Type: HTTP/HTTPS for web endpoints, TCP for raw port checks
  • Friendly Name: a label for this monitor (e.g. My API)
  • URL: the endpoint to monitor (e.g. https://api.example.com/health)
  • Heartbeat Interval: how often to check (default: 60 seconds)

Click Save. Uptime Kuma immediately begins checking the endpoint and displays the status on the dashboard.

Setting up notifications

Go to Settings > Notifications to configure alert channels. Uptime Kuma supports Slack, Discord, Telegram, email (SMTP), PagerDuty, and many more. Add a notification channel, then assign it to any monitor via the monitor settings panel.

CLI usage

osc create louislam-uptime-kuma mymonitoring \
  -o DatabaseUrl="mysql://kuma:mypassword@172.232.131.169:10520/uptimekuma"

Resources