Self-Hosted
/
uptime-kuma
mirror of https://github.com/louislam/uptime-kuma
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
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.
148 Commits
31 Branches
117 Tags
52 MiB
 
 
 
 
 
 
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'd94894b7e0'
${ noResults }
Go to file
Adam Stachowicz d94894b7e0
Fix `require-v-for-key`, remove unused declarations and double spaces 		3 years ago
.do the docker image to DO is not working at all, try git method 4 years ago
data init 4 years ago
db reset auto increment for new users 4 years ago
extra add nightly to version number 3 years ago
public Add files via upload 4 years ago
server Fix `require-v-for-key`, remove unused declarations and double spaces 3 years ago
src Fix `require-v-for-key`, remove unused declarations and double spaces 3 years ago
.dockerignore dockerfile: change the base image to node:14-alpine3.12; add apprise cli, prepare for implementing notification 4 years ago
.editorconfig update .editorconfig 4 years ago
.gitignore init 4 years ago
LICENSE Create LICENSE 4 years ago
README.md update to 1.0.5 3 years ago
docker-compose.yml add some comments and remove traefik-network from docker-composer.yml 4 years ago
dockerfile add nightly to version number 3 years ago
index.html Apple icon 4 years ago
package-lock.json add graceful shutdown 3 years ago
package.json update to 1.0.5 3 years ago
vite.config.js drop ie support when build the frontend 4 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 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

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

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.5 --force
npm install
npm run build
pm2 restart uptime-kuma

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