Skip to main content

README Highlight Issue #39, 2023: Uptime Kuma

In this week’s issue (#39, 2023) of README Highlight, we are taking a look at the following project: Uptime Kuma.

Uptime Kuma is an easy-to-use self-hosted monitoring tool. It allows users to monitor the uptime of various services, including HTTP(s), TCP, HTTP(s) Keyword, HTTP(s) Json Query, Ping, DNS Record, Push, Steam Game Server, and Docker Containers.

Some of the key features of Uptime Kuma include:

  • Fancy, Reactive, Fast UI/UX
  • Notifications via Telegram, Discord, Gotify, Slack, Pushover, Email (SMTP), and over 90 other notification services
  • 20-second intervals for monitoring
  • Multi-language support
  • Multiple status pages
  • Ping chart
  • Certificate info
  • Proxy support
  • 2FA support

Uptime Kuma can be installed using Docker or on a non-Docker environment. For Docker installation, users can run the following command:

docker run -d --restart=always -p 3001:3001 -v uptime-kuma:/app/data --name uptime-kuma louislam/uptime-kuma:1

For non-Docker installation, users need to have node, npm, git, and pm2 installed. They can then clone the Uptime Kuma repository and run the necessary setup commands. Uptime Kuma also provides a Windows Portable (x64) version for easy installation on Windows systems. For more advanced installation options, users can refer to the project’s documentation. To keep Uptime Kuma up to date, users can follow the instructions provided in the project’s documentation.

The Uptime Kuma project has a roadmap and milestones for future development, which can be found on its GitHub page.

The project is sponsored by GitHub Sponsors and OpenCollective sponsors. Users can contribute to the project by testing pull requests, testing beta versions, reporting bugs or requesting features, translating the project into different languages, and creating pull requests.

For more information and to try out Uptime Kuma, visit the Uptime Kuma GitHub repository.

Source: Uptime Kuma README.