Upstream docs: https://github.com/louislam/uptime-kuma/wiki

Everything not listed in this document should behave the same as upstream Uptime Kuma. If a feature, setting, or behavior is not mentioned here, the upstream documentation is accurate and fully applicable.

Uptime Kuma is an easy-to-use self-hosted monitoring tool. It allows you to monitor the uptime of your websites, servers, and applications with real-time notifications and detailed reports.

• Image and Container Runtime
• Volume and Data Layout
• Installation and First-Run Flow
• Configuration Management
• Network Access and Interfaces
• Actions (StartOS UI)
• Backups and Restore
• Health Checks
• Dependencies
• Limitations and Differences
• What Is Unchanged from Upstream
• Contributing
• Quick Reference for AI Consumers

The main volume contains the SQLite database, configuration, and all monitoring data.

First-run steps:

1. Install Uptime Kuma from the StartOS marketplace
2. Access the web UI
3. Create your admin account (first-time setup wizard)
4. Start adding monitors

Uptime Kuma on StartOS uses the default upstream configuration. All settings are managed through the web UI, just as with a standard installation.

No StartOS-specific configuration is applied. The service runs with upstream defaults.

Included in backup:

• main volume — SQLite database, configuration, all monitoring data

Restore behavior:

• All monitors, history, and settings restored
• No reconfiguration needed

None.

1. No environment variable configuration — runtime settings cannot be changed via StartOS; use the web UI
2. Standard image — uses the standard (Debian-based) upstream image

• All monitoring types (HTTP, TCP, Ping, DNS, Docker, etc.)
• Status pages
• Notification integrations (Slack, Telegram, Discord, email, etc.)
• Multi-user support
• Two-factor authentication
• API access
• Maintenance windows
• Certificate monitoring
• All web UI features
• SQLite database

See CONTRIBUTING.md for build instructions and development workflow.

package_id: uptime-kuma
image: louislam/uptime-kuma
architectures: [x86_64, aarch64]
volumes:
  main: /app/data
ports:
  ui: 3001
dependencies: none
startos_managed_env_vars: []
actions:
  - reset-password