一款极简的 uptime 监控工具。该项目可以用来监控服务正常运行时间,它界面美观、支持 Docker 一键部署,提供了中文界面、通知、多状态页面等实用功能。
jmolnar-comparative 237a6e8da9 chore: fixed a typo for internal, unused part of the file upload icon for status page (#4750) | 6 天之前 | |
---|---|---|
.devcontainer | 7 月之前 | |
.github | 1 月之前 | |
config | 2 月之前 | |
db | 3 周之前 | |
docker | 4 月之前 | |
extra | 2 月之前 | |
public | 5 月之前 | |
server | 6 天之前 | |
src | 2 周之前 | |
test | 4 月之前 | |
.dockerignore | 7 月之前 | |
.editorconfig | 1 年之前 | |
.eslintrc.js | 5 月之前 | |
.gitignore | 5 月之前 | |
.npmrc | 2 年之前 | |
.stylelintrc | 9 月之前 | |
CNAME | 2 年之前 | |
CODE_OF_CONDUCT.md | 2 年之前 | |
CONTRIBUTING.md | 3 周之前 | |
LICENSE | 2 年之前 | |
README.md | 2 周之前 | |
SECURITY.md | 6 月之前 | |
compose.yaml | 4 月之前 | |
ecosystem.config.js | 2 年之前 | |
index.html | 9 月之前 | |
package-lock.json | 3 周之前 | |
package.json | 3 周之前 | |
tsconfig.json | 7 月之前 |
Uptime Kuma is an easy-to-use self-hosted monitoring tool.
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. Sponsored by Uptime Kuma Sponsors.
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://0.0.0.0:3001.
[!WARNING] File Systems like NFS (Network File System) are NOT supported. Please map to a local directory or volume.
[!NOTE] If you want to limit exposure to localhost (without exposing port for other users or to use a reverse proxy), you can expose the port like this:
> docker run -d --restart=always -p 127.0.0.1:3001:3001 -v uptime-kuma:/app/data --name uptime-kuma louislam/uptime-kuma:1 > ``` ### 💪🏻 Non-Docker Requirements: - Platform - ✅ Major Linux distros such as Debian, Ubuntu, CentOS, Fedora and ArchLinux etc. - ✅ Windows 10 (x64), Windows Server 2012 R2 (x64) or higher - ❌ Replit / Heroku - [Node.js](https://nodejs.org/en/download/) 18 / 20.4 - [npm](https://docs.npmjs.com/cli/) 9 - [Git](https://git-scm.com/downloads) - [pm2](https://pm2.keymetrics.io/) - For running Uptime Kuma in the background ```bash git 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 monit
# If 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
Please read:
https://github.com/louislam/uptime-kuma/wiki/%F0%9F%86%99-How-to-Update
I will assign requests/issues to the next milestone.
https://github.com/louislam/uptime-kuma/milestones
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)
Light Mode:
Status Page:
Settings Page:
Telegram Notification Sample:
If you love this project, please consider giving it a ⭐.
⚠️ 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.
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
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
Check out the latest beta release here: https://github.com/louislam/uptime-kuma/releases
If you want to report a bug or request a new feature, feel free to open a new issue.
If you want to translate Uptime Kuma into your language, please visit Weblate Readme.
Feel free to correct the grammar in the documentation or code. My mother language is not English and my grammar is not that great.