A fancy self-hosted monitoring tool
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Louis Lam 28d13e198c
Merge pull request #2350 from MrEddX/bulgarian
2 days ago
.github Update stale-bot.yml 2 months ago
config Drop Jest e2e testing (#2174) 2 months ago
data init 1 year ago
db fix: resolve conflict 1 month ago
docker Update Apprise from 1.0 to 1.2 1 week ago
extra Make update-language-files command more useful (#2198) 2 months ago
public Clean up logo svg file 5 months ago
server Merge pull request #2339 from jbrunner/fix-2296 4 days ago
src Update bg-BG.js 3 days ago
test Init dayjs for backend.spec.js 2 months ago
.dockerignore Ignore /cypress in .dockerignore 3 months ago
.editorconfig Confirm Dialog: allow changing the button text 1 year ago
.eslintrc.js Update linters 7 months ago
.gitignore added cypress framework and tests for setup page 4 months ago
.npmrc Fix setup issue when using npm 8.6.0 8 months ago
.stylelintrc [stylelint] Turn off color-hex-length 5 months ago
CNAME eslint fixes too much 7 months ago
CODE_OF_CONDUCT.md update email 1 year ago
CONTRIBUTING.md fix typos 2 months ago
LICENSE Create LICENSE 1 year ago
README.md Update README.md 2 months ago
SECURITY.md Remove template comment 6 months ago
babel.config.js Standardize array bracket spacing 8 months ago
ecosystem.config.js Enforce semicolon, fix format globally 8 months ago
index.html fix manifest.json path 1 year ago
install.sh Limit the pm2 log size 8 months ago
package-lock.json Pin dependency of axios-ntlm to 1.3.0. As 1.3.1 causes error 4 days ago
package.json Pin dependency of axios-ntlm to 1.3.0. As 1.3.1 causes error 4 days ago
tsconfig.json Move Cypress directory and convert it to JavaScript (#2170) 2 months ago

README.md

Uptime Kuma

GitHub Sponsors

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

🥔 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

  • Monitoring uptime for HTTP(s) / TCP / HTTP(s) Keyword / 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, 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/users/louislam/projects/4/views/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: u/louislamlam.
You can mention me if you ask a question on Reddit. r/Uptime kuma

Contribute

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

Create Pull Requests

If you want to modify Uptime Kuma, please read this guide and follow the rules here: https://github.com/louislam/uptime-kuma/blob/master/CONTRIBUTING.md