Infra-Mirrors/uptime-kuma
1
0
Fork 0
mirror of https://github.com/louislam/uptime-kuma.git synced 2024-12-21 05:34:42 -05:00
Code Issues Packages Projects Releases Wiki Activity
A fancy self-hosted monitoring tool
248 Commits 31 Branches 117 Tags 103 MiB
JavaScript 55.1%
Vue 41.8%
TypeScript 1.4%
SCSS 0.9%
Dockerfile 0.3%
Other 0.3%
0dbecca10f
Go to file
Louis Lam 0dbecca10f
Merge pull request #102 from NiNiyas/pushover-enhancements 
Pushover enhancements
2021-07-23 12:32:36 +08: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 add patch3.sql and fix duplicate id in EditMonitor.vue 2021-07-22 17:44:59 +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 Merge pull request #102 from NiNiyas/pushover-enhancements 2021-07-23 12:32:36 +08:00
src Merge pull request #102 from NiNiyas/pushover-enhancements 2021-07-23 12:32:36 +08:00
.dockerignore add .vscode directory to dockerignore 2021-07-20 17:39:21 +02:00
.editorconfig update .editorconfig 2021-07-13 10:31:31 +08:00
.gitignore add retries for pinging function 2021-07-19 18:23:06 +02: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 update package-lock.json 2021-07-22 10:55:55 +08:00
package.json Merge branch 'master' into simple_pagination 2021-07-22 10:42:30 +08:00
README.md Update README.md 2021-07-20 20:27:34 +08:00
vite.config.js drop ie support when build the frontend 2021-07-13 18:34:09 +08:00

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

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.