docker self-hosted selfhosted monitoring hacktoberfest webapp single-page-app uptime-monitoring responsive uptime websocket socket-io

Go to file

LouisLam 435e4faef3 test heroku deployment		3 years ago
.do	the docker image to DO is not working at all, try git method	3 years ago
.github	Create codeql-analysis.yml	3 years ago
data	init	3 years ago
db	update database schema, add upside_down and ignore_tls	3 years ago
extra	Fix Docker build	3 years ago
public	Apple touch icon 192px with preserved transparency	3 years ago
server	cache index.html and fix basic auth applied to all routes	3 years ago
src	fix resize problem	3 years ago
.dockerignore	add .vscode directory to dockerignore	3 years ago
.editorconfig	update .editorconfig	3 years ago
.eslintrc.js	change no-unused-vars from error to warn	3 years ago
.gitignore	add retries for pinging function	3 years ago
.stylelintrc	Add ESLint and StyleLint	3 years ago
LICENSE	Create LICENSE	3 years ago
README.md	Move all Prometheus guides to wiki	3 years ago
app.json	test heroku deployment	3 years ago
docker-compose.yml	add some comments and remove traefik-network from docker-composer.yml	3 years ago
dockerfile	add apprise support	3 years ago
index.html	Add description	3 years ago
package-lock.json	cleanup code	3 years ago
package.json	test heroku deployment	3 years ago
vite.config.js	drop ie support when build the frontend	3 years ago

README.md

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

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

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.