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.
694 Commits
31 Branches
117 Tags
52 MiB
 
 
 
 
 
 
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '3e7bb355fd'
${ noResults }
Go to file
LouisLam 3e7bb355fd
update to 1.5.0 		3 years ago
.github Create FUNDING.yml 3 years ago
data init 4 years ago
db Update patch7.sql 3 years ago
extra Merge pull request #238 from Ponkhy/dns-monitor 3 years ago
kubernetes changed domain names to example.com 3 years ago
public control search engine visibility 3 years ago
server fix discord notification appended port unexpectedly 3 years ago
src Merge branch 'MichelBaie_master' 3 years ago
test/test_install_script wip: implementing install script 3 years ago
.dockerignore update .dockerignore 3 years ago
.editorconfig Confirm Dialog: allow changing the button text 3 years ago
.eslintrc.js no declare vars with comma, one line only one statement 3 years ago
.gitignore add retries for pinging function 3 years ago
.stylelintrc manual fix stylelint 3 years ago
CNAME Create CNAME 3 years ago
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 3 years ago
CONTRIBUTING.md fix npm7 broken dependencies 3 years ago
LICENSE Create LICENSE 4 years ago
README.md Update README.md 3 years ago
SECURITY.md Create SECURITY.md 3 years ago
docker-compose.yml add some comments and remove traefik-network from docker-composer.yml 4 years ago
dockerfile fix npm7 broken dependencies 3 years ago
index.html also change meta tag theme-color 3 years ago
install.sh change to pm2 start server/server.js directly due to (#273) 3 years ago
package-lock.json fix npm7 broken dependencies 3 years ago
package.json update to 1.5.0 3 years ago
tsconfig.json Fix: fix typescript errors 3 years ago
vite.config.js ESLint `vite.config.js` 3 years ago

README.md

Uptime Kuma

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

⭐ Features

🔧 How to Install

🐳 Docker

docker volume create uptime-kuma
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.

💪🏻 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
node server/server.js

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

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

Advanced Installation

If you need more options or need to browse via a reserve proxy, please read:

https://github.com/louislam/uptime-kuma/wiki/%F0%9F%94%A7-How-to-Install

🆙 How to Update

Please read:

https://github.com/louislam/uptime-kuma/wiki/%F0%9F%86%99-How-to-Update

🆕 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 ones 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 may be 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.