A fancy self-hosted monitoring tool
Go to file
Matthew Nickson 2170229031
Improve JSDoc for some components
Apply suggestions from code review

Co-authored-by: Nelson Chan <chakflying@hotmail.com>
2022-06-02 10:42:37 +01:00
.github Update PULL_REQUEST_TEMPLATE.md 2022-06-01 14:20:49 +08:00
config No more opening browser 2022-04-27 15:29:54 +08:00
data init 2021-06-25 21:55:49 +08:00
db Change mqtt_topic from VARCHAR to TEXT 2022-04-17 19:56:47 +08:00
docker Update docker-compose.yml 2022-05-09 13:47:19 +08:00
extra Update package-lock.json during release process 2022-04-22 00:47:04 +08:00
public clone master branch 2022-05-09 21:02:29 +02:00
server [Status Page] Preload data 2022-06-01 13:05:12 +08:00
src Improve JSDoc for some components 2022-06-02 10:42:37 +01:00
test Merge branch 'master' into fix-1448-discord-service-url 2022-05-10 22:53:55 +10:00
.dockerignore Update .dockerignore 2022-04-05 16:44:55 +08:00
.editorconfig Confirm Dialog: allow changing the button text 2021-07-31 18:58:12 +08:00
.eslintrc.js Update linters 2022-04-26 01:26:57 +02:00
.gitignore ignore .env 2021-10-07 14:34:30 +08:00
.npmrc Fix setup issue when using npm 8.6.0 2022-04-06 22:50:21 +08:00
.stylelintrc Fix styleline, fix css format issues globally 2022-04-14 01:20:54 +08:00
babel.config.js Standardize array bracket spacing 2022-04-17 15:27:35 +08:00
CNAME eslint fixes too much 2022-05-09 21:05:10 +02:00
CODE_OF_CONDUCT.md update email 2021-10-18 23:55:00 +08:00
CONTRIBUTING.md Update CONTRIBUTING.md 2022-06-01 14:08:10 +08:00
ecosystem.config.js Enforce semicolon, fix format globally 2022-04-14 01:20:54 +08:00
index.html fix manifest.json path 2021-10-31 13:17:34 +08:00
install.sh Limit the pm2 log size 2022-03-23 11:17:23 +08:00
LICENSE Create LICENSE 2021-07-11 16:02:45 +08:00
package-lock.json [Status Page] SSR 2022-05-30 15:45:44 +08:00
package.json Merge remote-tracking branch 'origin/master' into status-page-inject-html 2022-05-30 14:00:39 +08:00
README.md Fix typo in README 2022-04-27 21:10:47 +03:00
SECURITY.md Update SECURITY.md 2022-04-24 22:54:06 +08:00
tsconfig.json set newLine to LF for ts compiler 2021-10-13 22:31:36 +08:00

Uptime Kuma

GitHub Sponsors

It is a self-hosted monitoring tool like "Uptime Robot".

🥔 Live Demo

Try it!

https://demo.uptime.kuma.pet

It is a temporary live demo, all data will be deleted after 10 minutes. The server is located in Tokyo, so if you live far from there, it may affect your experience. I suggest that you should install and try it out for the best demo experience.

VPS is sponsored by Uptime Kuma sponsors on Open Collective! Thank you so much!

Features

  • Monitoring uptime for HTTP(s) / TCP / HTTP(s) Keyword / Ping / DNS Record / Push / Steam Game Server.
  • Fancy, Reactive, Fast UI/UX.
  • Notifications via Telegram, Discord, Gotify, Slack, Pushover, Email (SMTP), and 90+ notification services, click here for the full list.
  • 20 second intervals.
  • Multi Languages
  • Multiple Status Pages
  • Map Status Page to Domain
  • Ping Chart
  • Certificate Info
  • Proxy Support
  • 2FA available

🔧 How to Install

🐳 Docker

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

⚠️ Please use a local volume only. Other types such as NFS are not supported.

Browse to http://localhost:3001 after starting.

💪🏻 Non-Docker

Required Tools:

# Update your npm to the latest version
npm install npm -g

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 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


Browse to http://localhost:3001 after starting.

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

Advanced Installation

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 mark requests/issues to the next milestone.

https://github.com/louislam/uptime-kuma/milestones

Project Plan:

https://github.com/louislam/uptime-kuma/projects/1

❤️ 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

  • I was looking for a self-hosted monitoring tool like "Uptime Robot", but it is hard to find a suitable one. One of the close ones is statping. Unfortunately, it is not stable and no longer maintained.
  • Want 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 REST API.
  • Deploy my first Docker image to Docker Hub.

If you love this project, please consider giving me a .

🗣️ Discussion

Issues Page

You can discuss or ask for help in issues.

Subreddit

My Reddit account: louislamlam You can mention me if you ask a question on Reddit. https://www.reddit.com/r/UptimeKuma/

Contribute

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 read: https://github.com/louislam/uptime-kuma/tree/master/src/languages

Feel free to correct my grammar in this README, source code, or wiki, as my mother language is not English and my grammar is not that great.

Pull Requests

If you want to modify Uptime Kuma, this guideline may be useful for you: https://github.com/louislam/uptime-kuma/blob/master/CONTRIBUTING.md