diff --git a/README.md b/README.md index aac4fad5b..f729a71e9 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,6 @@ -
@@ -11,16 +10,16 @@ It is a self-hosted monitoring tool like "Uptime Robot". -# Features +## 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 +## How to Use -## Docker +### Docker ```bash # Create a volume @@ -38,7 +37,7 @@ Change Port and Volume docker run -d --restart=always -p :3001 -v :/app/data --name uptime-kuma louislam/uptime-kuma:1 ``` -## Without Docker +### Without Docker Required Tools: Node.js >= 14, git and pm2. @@ -50,7 +49,7 @@ npm run setup # Option 1. Try it npm run start-server -# (Recommended) +# (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 @@ -70,8 +69,7 @@ pm2 stop uptime-kuma Browse to http://localhost:3001 after started. - -## (Optional) One more step for Reverse Proxy +### (Optional) One more step for Reverse Proxy This is optional for someone who want to do reverse proxy. @@ -80,7 +78,7 @@ Unlikely other web apps, Uptime Kuma is based on WebSocket. You need two more he Please read wiki for more info: https://github.com/louislam/uptime-kuma/wiki/Reverse-Proxy -## One-click Deploy +### One-click Deploy