A fancy self-hosted monitoring tool
Go to file
2021-08-17 13:41:36 +02:00
.github/ISSUE_TEMPLATE Update ask-for-help.md 2021-08-17 01:32:42 +08:00
data init 2021-06-25 21:55:49 +08:00
db Feat: Implement MaxRedirects & StatusCodes 2021-08-05 19:04:38 +08:00
extra add batsh 2021-08-11 14:52:25 +08:00
public control search engine visibility 2021-08-09 18:16:27 +08:00
server Added Line Messenger Notification Service 2021-08-17 13:41:36 +02:00
src Added Line Messenger Notification Service 2021-08-17 13:41:36 +02:00
.dockerignore update .dockerignore 2021-08-03 20:42:32 +08:00
.editorconfig Confirm Dialog: allow changing the button text 2021-07-31 18:58:12 +08:00
.eslintrc.js improve space-before-function-paren 2021-08-10 21:59:15 +08:00
.gitignore add retries for pinging function 2021-07-19 18:23:06 +02:00
.stylelintrc minor 2021-08-16 20:40:16 +08:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2021-08-01 00:35:47 +08:00
CONTRIBUTING.md Create CONTRIBUTING.md 2021-08-01 00:29:30 +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 update to 1.1.0 2021-08-09 21:03:30 +08:00
index.html also change meta tag theme-color 2021-08-13 00:23:40 +08:00
LICENSE Create LICENSE 2021-07-11 16:02:45 +08:00
package-lock.json update all dependencies 2021-08-16 01:42:39 +08:00
package.json update to 1.2.0 2021-08-16 20:40:28 +08:00
README.md Update README.md 2021-08-16 21:31:05 +08:00
tsconfig.json code re-use and eslint 2021-08-09 13:49:37 +08:00
vite.config.js ESLint vite.config.js 2021-08-08 18:24:05 +02: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, Gotify, Slack, Pushover, Email (SMTP) and more by Apprise.
  • 20 seconds interval.

🔧 How to Install

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

If you want to change port and volume, or need to browse via a reserve proxy, please read wiki.

💪🏻 Without Docker (Recommanded for x86/x64 only)

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

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

If you want to change port and hostname, or need to browse via a reserve proxy, please read wiki.

🆙 How to Update

🆙🐳 Docker

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

For someone who used my "How-to-use" commands to install Uptime Kuma, you can update by this:

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

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

cd <uptime-kuma-directory>
git fetch --all
git checkout 1.2.0 --force
npm install
npm run build
pm2 restart uptime-kuma

🆕 What's Next?

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

🖼 More Screenshots

Dark Mode:

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/blob/master/CONTRIBUTING.md

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.

🐻