A fancy self-hosted monitoring tool
Go to file
2021-07-22 15:02:33 +01:00
.do the docker image to DO is not working at all, try git method 2021-07-11 22:12:14 +08:00
.github/ISSUE_TEMPLATE Update --please-go-to--discussion--tab-if-you-want-to-ask-or-share-something.md 2021-07-21 16:29:15 +08:00
data init 2021-06-25 21:55:49 +08:00
db Update patch1.sql 2021-07-22 10:45:22 +08:00
extra Fix Docker build 2021-07-18 13:51:44 +02:00
public Merge pull request #66 from Saibamen/resize_apple_icon 2021-07-18 13:47:50 +08:00
server Move common labels into dedicated const 2021-07-22 14:58:22 +01:00
src Merge branch 'master' into something 2021-07-22 11:12:52 +08:00
.dockerignore Update .dockerignore 2021-07-17 23:31:44 +02:00
.editorconfig update .editorconfig 2021-07-13 10:31:31 +08:00
.gitignore init 2021-06-24 21:42:23 +08:00
docker-compose.yml add some comments and remove traefik-network from docker-composer.yml 2021-07-13 10:28:07 +08:00
dockerfile add apprise support 2021-07-18 18:51:58 +08:00
index.html Add description 2021-07-17 22:53:32 +02:00
LICENSE Create LICENSE 2021-07-11 16:02:45 +08:00
package-lock.json Remove bcryptjs and node-gyp, they should not be here... 2021-07-22 09:01:51 +01:00
package.json Remove bcryptjs and node-gyp, they should not be here... 2021-07-22 09:01:51 +01:00
README.md Update README to include examples for Prometheus 2021-07-22 15:02:33 +01:00
vite.config.js drop ie support when build the frontend 2021-07-13 18:34:09 +08:00

Uptime Kuma

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

Features

  • Monitoring uptime for HTTP(s) / TCP / Ping.
  • Fancy, Reactive, Fast UI/UX.
  • Notifications via Webhook, Telegram, Discord and email (SMTP).
  • 20 seconds interval.

How to Use

Docker

# Create a volume
docker volume create uptime-kuma

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

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

Change Port and Volume

docker run -d --restart=always -p <YOUR_PORT>:3001 -v <YOUR_DIR OR VOLUME>:/app/data --name uptime-kuma louislam/uptime-kuma:1

Without Docker

Required Tools: Node.js >= 14, git and pm2.

git clone https://github.com/louislam/uptime-kuma.git
cd uptime-kuma
npm run setup

# Option 1. Try it
npm run start-server

# (Recommended) 
# Option 2. Run in background using PM2
# Install PM2 if you don't have: npm install pm2 -g
pm2 start npm --name uptime-kuma -- run start-server

# Listen to different port or hostname
pm2 start npm --name uptime-kuma -- run start-server -- --port=80 --hostname=0.0.0.0

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

One-click Deploy to DigitalOcean

Deploy to DO

Choose Cheapest Plan is enough. (US$ 5)

How to Update

Docker

Re-pull the latest docker image and create another container with the same volume.

PS: For every new release, it takes some time to build the docker image, please be patient if it is not available yet.

Without Docker

git fetch --all
git checkout 1.0.6 --force
npm install
npm run build
pm2 restart uptime-kuma

Passing metrics to other platforms

If you already use Prometheus.io or a platform that supports Prometheus exporter format, you can get the metrics about each monitoring target from http://<your.installation>:<your_port>/metrics.

Labels to filter by include:

| Label Name | Description | +------------+-------------+ |monitor_name| The "Friendly Name" of the monitor | |monitor_type| The type (http, keyword, tcp) of monitoring check | |monitor_url | The URL to be monitored (http, keyword) |monitor_hostname | The Hostname to be monitored (tcp) | |monitor_port | The port to be monitored (tcp) |

Example PromQL queries

Assuming we have http monitors in place for bbc.co.uk and google.com:

# Show all response rates gouped by site
sum(monitor_response_time) by (monitor_name)

# Show only the response time for BBC.co.uk
sum(monitor_reponse_time{monitor_url="https://www.bbc.co.uk/"})

# Show the current status of Google.com
monitor_status{monitor_name="Google"}

What's Next?

I will mark requests/issues to the next milestone. https://github.com/louislam/uptime-kuma/milestones

More Screenshots

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 one is statping. Unfortunately, it is not stable and unmaintained.
  • 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 .

Contribute

If you want to report a bug or request a new feature. Free feel to open a new issue.

If you want to modify Uptime Kuma, this guideline maybe useful for you: https://github.com/louislam/uptime-kuma/wiki/%5BDev%5D-Setup-Development-Environment

English proofreading is needed too, because my grammar is not that great sadly. Feel free to correct my grammar in this Readme, source code or wiki.