Service: Uptime Kuma - EyevinnOSC/community GitHub Wiki
Uptime Kuma (serviceId louislam-uptime-kuma) is a self-hosted monitoring tool that tracks the availability of websites, APIs and services. In Eyevinn Open Source Cloud (OSC) it is a long-running service instance. License: MIT. Source: louislam/uptime-kuma.
- Monitor HTTP/HTTPS, TCP, DNS, ping and more.
- Send alerts through Slack, Discord, Telegram, email (SMTP), PagerDuty and many other channels.
- Show a real-time status dashboard.
Create the database first and confirm it is running: a MariaDB instance (serviceId linuxserver-docker-mariadb) with a database and user, for example:
{ "name": "kumadb", "RootPassword": "{{secrets.mariadbroot}}", "Database": "uptimekuma", "User": "kuma", "Password": "{{secrets.mariadbpwd}}" }Use describe-service-instance on it to get its address and port; the connection URL is mysql://<user>:<password>@<IP>:<PORT>/<database>. Store it as a service secret: create-service-secret with serviceId: "louislam-uptime-kuma", name dburl. Then call create-service-instance with serviceId: "louislam-uptime-kuma":
{ "name": "mymonitoring", "DatabaseUrl": "{{secrets.dburl}}" }Verify with wait-for-service-ready or get-instance-status; describe-service-instance returns the instance URL.
| Option | Required | Type | Meaning |
|---|---|---|---|
| name | Yes | string | Name of the instance. Alphanumeric/underscore only (^\w+$), at most 20 characters. |
| DatabaseUrl | Yes (marked mandatory in the catalog) | string, sensitive | MariaDB connection URL in the form mysql://user:password@hostname:port/dbname (mariadb:// is also accepted; the port defaults to 3306). When set, the OSC wrapper writes it to Uptime Kuma's db-config.json as an external MariaDB. When empty, the built-in SQLite database in /app/data is used. The catalog associates it with a MariaDB instance (linuxserver-docker-mariadb, TCP, credentials and path included). Store as a secret and pass {{secrets.NAME}}. |
{{secrets.NAME}} only works as the entire field value. Overwriting a secret does not restart a running instance.
- Open the instance URL. On the first visit you are prompted to create an admin username and password.
- Click Add New Monitor and set the Monitor Type (HTTP/HTTPS for web endpoints, TCP for raw port checks), a Friendly Name, the URL (for example
https://api.example.com/health) and the Heartbeat Interval (default 60 seconds). Save, and checking starts immediately. - Configure alert channels in Settings, Notifications, then assign a channel to a monitor in the monitor settings.
OSC CLI equivalent:
osc create louislam-uptime-kuma mymonitoring \
-o DatabaseUrl="mysql://kuma:<password>@<IP>:<PORT>/uptimekuma"