Uptime Kuma

Overview

Uptime Kuma is a self-hosted monitoring service that you can use to keep track of the heath of your applications, websites, and APIs. You can configure it to watch services with different types of health checks and set up email notifications for when there are problems. Uptime Kuma also lets you design custom status pages that you can use to share public information about your service health statuses and to manage incidents.

Uptime Kuma uses a local SQLite database to store metrics and other data. This configuration uses Litestream to stream the SQLite database to an S3-compatible object storage provider for persistence across deployments.

Requirements

• An S3-compatible object storage provider to store and stream Uptime Kuma's SQLite database using Litestream.

Configuration

When deploying Uptime Kuma on Koyeb, the following environment variables will be provided. Take care to set the required variables with the appropriate values if not set.

Variable	Description	Required	Default value
UPTIME_KUMA_PORT	The port that Uptime Kuma runs on.	Yes	8000
LITESTREAM_ACCESS_KEY_ID	The object storage provider's API key ID.	Yes
LITESTREAM_SECRET_ACCESS_KEY	The object storage provider's API key.	Yes
LITESTREAM_BUCKET	The object storage bucket name.	Yes
LITESTREAM_PATH	The directory to store your Uptime Kuma database information. All Litestream objects will be placed in this directory within the bucket.	Yes	uptime-kuma
LITESTREAM_URL	The URL to access your object storage endpoint. Must start with https://.	Yes
LITESTREAM_REGION	The region of your object storage bucket.	Yes

Other resources related to Uptime Kuma

• Official Uptime Kuma documentation
• Official Litestream documentation
• Tutorial on setting up Uptime Kuma on Koyeb