A fancy self-hosted monitoring tool
 
 
 
 
 
 
Go to file
Frank Elsinga fbf7b77ceb
improved zoho-cliq message format (#4848)
2024-06-13 17:10:46 +02:00
.devcontainer Fix few markdownlint warnings (#3825) 2023-10-03 05:48:21 +08:00
.github fix(ci): Prevent ARM runner from running in Forks (#4803) 2024-05-30 14:46:04 +08:00
config removed the last reminents of cypress 2024-06-04 03:02:34 +02:00
db Make auto refresh interval customizable (#4260) 2024-05-19 21:56:55 +02:00
docker Update to respect docker compose v2 (#4289) 2023-12-27 22:39:04 +08:00
extra reset-password-issue-4518 2024-02-23 18:10:09 +05:00
public Re-export the icon on vectr.com, so it can be editable again. The current icon.svg was reduced size by a contributor previously, but the border is detached after that, which cannot edit by any svg editor anymore. 2023-12-09 04:24:19 +08:00
server fixed formatting mistakes 2024-06-13 17:04:38 +02:00
src Fixed `smspartner` not having fully working translations 2024-06-04 01:10:20 +02:00
test Update dependencies and remove an empty file 2024-04-25 15:46:18 +08:00
.dockerignore removed the last reminents of cypress 2024-06-04 03:02:34 +02:00
.editorconfig Fix healthcheck do not check https 2022-12-10 23:30:32 +08:00
.eslintrc.js removed the last reminents of cypress 2024-06-04 03:02:34 +02:00
.gitignore Playwright + Native Node Test Runner (#3893) 2023-12-17 19:02:22 +08:00
.npmrc Fix setup issue when using npm 8.6.0 2022-04-06 22:50:21 +08:00
.stylelintrc Added ability to bulk select, pause & resume (#1886) 2023-07-31 16:24:00 +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 made sure that the `Set up a Docker Builder` section in the contribution guide is layouted like the rest 2024-05-29 11:03:37 +02:00
LICENSE Create LICENSE 2021-07-11 16:02:45 +08:00
README.md Fixed a typo introduced in #3836 (#4729) 2024-05-02 12:11:49 +08:00
SECURITY.md feat: grammar fixes (#4042) 2023-11-16 20:31:20 +08:00
compose.yaml Update to respect docker compose v2 (#4289) 2023-12-27 22:39:04 +08:00
ecosystem.config.js Enforce semicolon, fix format globally 2022-04-14 01:20:54 +08:00
index.html Add noscript tag as stand in for #3553 (#3555) 2023-08-10 19:35:13 +08:00
package-lock.json Switch back to `TryGhost/node-sqlite3` from `louislam/node-sqlite3` (#4773) 2024-05-20 10:42:37 +08:00
package.json Switch back to `TryGhost/node-sqlite3` from `louislam/node-sqlite3` (#4773) 2024-05-20 10:42:37 +08:00
tsconfig.json Enable eslint for util.ts (#3887) 2023-10-13 22:42:45 +08:00

README.md

Uptime Kuma

Uptime Kuma is an easy-to-use self-hosted monitoring tool.

GitHub Sponsors Translation status

🥔 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. Sponsored by Uptime Kuma Sponsors.

Features

  • Monitoring uptime for HTTP(s) / TCP / HTTP(s) Keyword / HTTP(s) Json Query / 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 pages to specific domains
  • Ping chart
  • Certificate info
  • Proxy support
  • 2FA support

🔧 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://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 18 / 20.4
  • npm 9
  • Git
  • pm2 - For running Uptime Kuma in the background
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

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

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

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.