Skip to content

Latest commit

 

History

History
64 lines (44 loc) · 2.65 KB

uptime-kuma.md

File metadata and controls

64 lines (44 loc) · 2.65 KB

Uptime Kuma

Uptime Kuma is a fancy self-hosted monitoring tool similar to Uptime Robot. It has functions such as below:

  • Monitoring uptime for HTTP(s) / TCP / HTTP(s) Keyword / HTTP(s) Json Query / Ping / DNS Record / Push / Steam Game Server / Docker Containers
  • Fancy, Reactive, Fast UI/UX
  • Notifications via Matrix, Telegram, Discord, Gotify, Slack, Pushover, Email (SMTP), and 90+ notification services
  • 20-second intervals
  • Multi-Language
  • Multiple status pages
  • Map status pages to specific domains
  • Ping chart
  • Certificate info
  • Proxy support
  • 2FA support

✨ Kuma (くま/熊) means bear 🐻 in Japanese.

Dependencies

This service requires the following other services:

Configuration

To enable this service, add the following configuration to your vars.yml file and re-run the installation process:

########################################################################
#                                                                      #
# uptime-kuma                                                          #
#                                                                      #
########################################################################

uptime_kuma_enabled: true

uptime_kuma_hostname: mash.example.com

# For now, hosting Uptime Kuma under a path is not supported.
# See: https://github.com/louislam/uptime-kuma/issues/147
# uptime_kuma_path_prefix: /uptime-kuma

########################################################################
#                                                                      #
# /uptime-kuma                                                         #
#                                                                      #
########################################################################

Usage

When you open the Uptime Kuma's web UI for the first time, it starts a setup wizard where you'll create your admin credentials. You can then add monitors for web services as many as you like.

If you have enabled a self-hosted ntfy server, it is possible to set up the Uptime Kuma instance to have it send notifications to a ntfy's "topic" (channel) when the monitored web service is down, without relaying them through servers owned and controlled by third parties.