Uptime Kuma (GitHub Repo)
Uptime Kuma is a widely-used, self-hosted monitoring tool that provides a reactive dashboard for tracking HTTP, TCP, and Docker container health.
Deep dive
- Supports multiple monitoring types including HTTP(s), TCP, DNS, and Docker containers.
- Uses Vue 3 and WebSockets for a high-performance, real-time UI.
- Allows for custom status pages mapped to specific domains.
- Features a reactive design that simplifies adding new services and managing incident alerts.
Original article
Uptime Kuma
Uptime Kuma is an easy-to-use self-hosted monitoring tool.
Live Demo
Try it!
Demo Server (Location: Frankfurt - Germany): https://demo.kuma.pet/start-demo
It is a temporary live demo, all data will be deleted after 10 minutes.
Warning: Be careful - the top result in Google, uptimekuma.co, is not our official website, we don't control the website. I recommend following the installation guide in this GitHub repo.
Features
- Monitoring uptime for HTTP(s) / TCP / HTTP(s) Keyword / HTTP(s) Json Query / Websocket / Ping / DNS Record / Push / Steam Game Server / Docker Containers
- Fancy, Reactive, Fast UI/UX
- Notifications via Telegram, Discord, Gotify, Slack, Pushover, Email (SMTP), and 90+ notification services.
- 20-second intervals
- Multi Languages
- Multiple status pages
- Map status pages to specific domains
- Ping chart
- Certificate info
- Proxy support
- 2FA support
How to Install
Docker Compose
mkdir uptime-kuma
cd uptime-kuma
curl -o compose.yaml https://raw.githubusercontent.com/louislam/uptime-kuma/master/compose.yaml
docker compose up -d
Uptime Kuma is now running on all network interfaces (e.g. http://localhost:3001 or http://your-ip:3001).
Warning: File Systems like NFS (Network File System) are NOT supported. Please map to a local directory or volume.
Docker Command
docker run -d --restart=always -p 3001:3001 -v uptime-kuma:/app/data --name uptime-kuma louislam/uptime-kuma:2
Uptime Kuma is now running on all network interfaces (e.g. http://localhost:3001 or http://your-ip:3001).
Non-Docker
Requirements:
- Platform: Major Linux distros, Windows 10 (x64) or higher.
- Node.js >= 20.4
- Git
- pm2 - For running Uptime Kuma in the background
git clone https://github.com/louislam/uptime-kuma.git
cd uptime-kuma
npm run setup
# Recommended: Run in the background using PM2
npm install pm2 -g && pm2 install pm2-logrotate
pm2 start server/server.js --name uptime-kuma
Motivation
- I was looking for a self-hosted monitoring tool like "Uptime Robot", but it is hard to find a suitable one.
- Wanted to build a fancy UI.
- Learn Vue 3 and vite.js.
- Show the power of Bootstrap 5.
- Try to use WebSocket with SPA instead of a REST API.
- Deploy my first Docker image to Docker Hub.
Discussion / Ask for Help
Warning: For any general or technical questions, please don't send me an email, as I am unable to provide support in that manner.
I recommend using Google, GitHub Issues, or Uptime Kuma's subreddit for finding answers to your question.
Fresh dev news, AI-digested daily. Never miss a trend at devoured.fyi