A fancy self-hosted monitoring tool
<a href="https://github.com/louislam/uptime-kuma/blob/master/./public/icon.svg" rel="nofollow"></a>
Uptime Kuma
Uptime Kuma is an easy-to-use self-hosted monitoring tool.
π₯ Live Demo
Try it!
It is a temporary live demo, all data will be deleted after 10 minutes. Use the one that is closer to you, but I suggest that you should install and try it out for the best demo experience.
β Features
π§ How to Install π³ Docker
docker run -d --restart=always -p 3001:3001 -v uptime-kuma:/app/data --name uptime-kuma louislam/uptime-kuma:1
Uptime Kuma is now running on http://localhost:3001
Warning
File Systems like NFS (Network File System) are NOT supported. Please map to a local directory or volume.
πͺπ» Non-Docker
Requirements:
# Update your npm npm install npm@9 -ggit clone https://github.com/louislam/uptime-kuma.git cd uptime-kuma npm run setup
Option 1. Try it
node server/server.js
(Recommended) Option 2. Run in the background using PM2
Install PM2 if you don't have it:
npm install pm2 -g && pm2 install pm2-logrotate
Start Server
pm2 start server/server.js --name uptime-kuma
Uptime Kuma is now running on http://localhost:3001
More useful PM2 Commands
# If you want to see the current console output pm2 monitAdvanced InstallationIf you want to add it to startup
pm2 save && pm2 startup
If you need more options or need to browse via a reverse proxy, please read:
https://github.com/louislam/uptime-kuma/wiki/%F0%9F%94%A7-How-to-Install
π How to Update
Please read:
https://github.com/louislam/uptime-kuma/wiki/%F0%9F%86%99-How-to-Update
π What's Next?
I will assign requests/issues to the next milestone.
https://github.com/louislam/uptime-kuma/milestones
β€οΈ Sponsors
Thank you so much! (GitHub Sponsors will be updated manually. OpenCollective sponsors will be updated automatically, the list will be cached by GitHub though. It may need some time to be updated)
πΌ More Screenshots
Light Mode:
Status Page:
Settings Page:
Telegram Notification Sample:
Motivation
If you love this project, please consider giving it a β.
π£οΈ Discussion / Ask for Help
β οΈ For any general or technical questions, please don't send me an email, as I am unable to provide support in that manner. I will not respond if you ask questions there.
I recommend using Google, GitHub Issues, or Uptime Kuma's subreddit for finding answers to your question. If you cannot find the information you need, feel free to ask:
My Reddit account: u/louislamlam You can mention me if you ask a question on the subreddit.
Contributions Create Pull Requests
We DO NOT accept all types of pull requests and do not want to waste your time. Please be sure that you have read and follow pull request rules: CONTRIBUTING.md#can-i-create-a-pull-request-for-uptime-kuma
Test Pull Requests
There are a lot of pull requests right now, but I don't have time to test them all.
If you want to help, you can check this: https://github.com/louislam/uptime-kuma/wiki/Test-Pull-Requests
Test Beta Version
Check out the latest beta release here: https://github.com/louislam/uptime-kuma/releases
Bug Reports / Feature Requests
If you want to report a bug or request a new feature, feel free to open a new issue.
Translations
If you want to translate Uptime Kuma into your language, please visit Weblate Readme.
Spelling & Grammar
Feel free to correct the grammar in the documentation or code. My mother language is not English and my grammar is not that great.
Twice a month we will interview people behind open source businesses. We will talk about how they are building a business on top of open source projects.
We'll never share your email with anyone else.