Uptime Kuma
A local monitoring setup with persistent data and a worksheet for your first check.
Files generated locally. No credentials needed to download.
Before you start
Docker Compose on your own workstation. No Docker access is provided by the Botkeep preview.
Dependencies
- Uptime Kuma 2 (official image)
- Docker Compose (local only)
Guided setup
- 1
Review compose.yaml, then run docker compose up -d on your own computer. For reproducibility, pin a verified image digest before production use.
- 2
Open http://127.0.0.1:3001 and create the administrator account before exposing the service. Enable 2FA.
- 3
Use monitor-plan.json as a worksheet: add an HTTP(s) monitor in the UI, configure notifications and send a test notification. The file is not importable.
Environment checklist
No required environment variables. Credentials and notifications are configured in Kuma’s own interface.
What is not included
Keep /app/data on persistent local storage, not NFS. Monitor only endpoints you own or may check. A monitor on the same node can fail with the service: use an external monitor for independent alerts.
The configurator prepares files and settings. Confirm deployment, add your credentials in Environment and check Console to verify startup.
Official documentation
README.md
# Uptime Kuma
A local monitoring setup with persistent data and a worksheet for your first check.
## Requirements
Docker Compose on your own workstation. No Docker access is provided by the Botkeep preview.
## Setup
1. Review compose.yaml, then run docker compose up -d on your own computer. For reproducibility, pin a verified image digest before production use.
2. Open http://127.0.0.1:3001 and create the administrator account before exposing the service. Enable 2FA.
3. Use monitor-plan.json as a worksheet: add an HTTP(s) monitor in the UI, configure notifications and send a test notification. The file is not importable.
## Variables
—
## Boundaries
Keep /app/data on persistent local storage, not NFS. Monitor only endpoints you own or may check. A monitor on the same node can fail with the service: use an external monitor for independent alerts.
Downloading does not deploy anything. The Botkeep preview stores files in your browser but does not execute processes, install packages or activate networking. Do not enter real credentials in the demo. Direct dependencies are versioned: keep generated lockfiles and review updates and vulnerabilities before production.
## Sources
- Uptime Kuma · official installation: https://github.com/louislam/uptime-kuma#how-to-install