diff --git a/README.md b/README.md index 7b7e71bf..bf41e9b9 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,13 @@ # Uptime Kuma +
+ +
+ It is a self-hosted monitoring tool like "Uptime Robot". + + # Features * Monitoring uptime for HTTP(s) / TCP / Ping. @@ -12,22 +18,26 @@ It is a self-hosted monitoring tool like "Uptime Robot". # How to Use ### Docker -``` +```bash docker run -d --restart=always -p 3001:3001 louislam/uptime-kuma ``` Browse to http://localhost:3001 after started. -### Node.js >= 14 + GIT -``` -git clone git@github.com:louislam/uptime-kuma.git +### Without Docker + +Required Tools: Node.js >= 14, git and pm2. + +```bash +git clone https://github.com/louislam/uptime-kuma.git cd uptime-kuma npm run setup -# 1. Try it +# Option 1. Try it npm run start-server -# 2. Run in background using PM2 +# (Recommanded) +# Option 2. Run in background using PM2 # Install PM2 if you don't have: npm install pm2 -g pm2 start npm -- run start-server @@ -39,6 +49,12 @@ Browse to http://localhost:3001 after started. Coming Soon + +# More Screenshots + + + + # 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.