mirror of
https://github.com/louislam/uptime-kuma.git
synced 2024-12-16 11:14:38 -05:00
Fix few markdown lint warnings
This commit is contained in:
parent
519add4fab
commit
9c17f59fe8
30
README.md
30
README.md
@ -2,7 +2,6 @@
|
||||
|
||||
<a target="_blank" href="https://github.com/louislam/uptime-kuma"><img src="https://img.shields.io/github/stars/louislam/uptime-kuma" /></a> <a target="_blank" href="https://hub.docker.com/r/louislam/uptime-kuma"><img src="https://img.shields.io/docker/pulls/louislam/uptime-kuma" /></a> <a target="_blank" href="https://hub.docker.com/r/louislam/uptime-kuma"><img src="https://img.shields.io/docker/v/louislam/uptime-kuma/latest?label=docker%20image%20ver." /></a> <a target="_blank" href="https://github.com/louislam/uptime-kuma"><img src="https://img.shields.io/github/last-commit/louislam/uptime-kuma" /></a>
|
||||
|
||||
|
||||
<div align="center" width="100%">
|
||||
<img src="./public/icon.svg" width="128" alt="" />
|
||||
</div>
|
||||
@ -11,16 +10,16 @@ It is a self-hosted monitoring tool like "Uptime Robot".
|
||||
|
||||
<img src="https://louislam.net/uptimekuma/1.jpg" width="512" alt="" />
|
||||
|
||||
# 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 <YOUR_PORT>:3001 -v <YOUR_DIR OR VOLUME>:/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
|
||||
|
||||
<!---
|
||||
Abort. Heroku instance killed the server.js if idle, stupid.
|
||||
@ -89,13 +87,14 @@ Abort. Heroku instance killed the server.js if idle, stupid.
|
||||
|
||||
[![Deploy to DO](https://www.deploytodo.com/do-btn-blue.svg)](https://cloud.digitalocean.com/apps/new?repo=https://github.com/louislam/uptime-kuma/tree/master&refcode=e2c7eb658434)
|
||||
|
||||
# How to Update
|
||||
## How to Update
|
||||
|
||||
### Docker
|
||||
|
||||
Re-pull the latest docker image and create another container with the same volume.
|
||||
|
||||
For someone who used my "How-to-use" commands to install Uptime Kuma, you can update by this:
|
||||
|
||||
```bash
|
||||
docker pull uptime-kuma:1
|
||||
docker stop uptime-kuma
|
||||
@ -115,12 +114,12 @@ npm run build
|
||||
pm2 restart uptime-kuma
|
||||
```
|
||||
|
||||
# What's Next?
|
||||
## What's Next?
|
||||
|
||||
I will mark requests/issues to the next milestone.
|
||||
https://github.com/louislam/uptime-kuma/milestones
|
||||
|
||||
# More Screenshots
|
||||
## More Screenshots
|
||||
|
||||
Settings Page:
|
||||
|
||||
@ -130,8 +129,7 @@ Telegram Notification Sample:
|
||||
|
||||
<img src="https://louislam.net/uptimekuma/3.jpg" width="400" alt="" />
|
||||
|
||||
|
||||
# Motivation
|
||||
## 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.
|
||||
@ -140,11 +138,9 @@ Telegram Notification Sample:
|
||||
* 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
|
||||
## Contribute
|
||||
|
||||
If you want to report a bug or request a new feature. Free feel to open a new issue.
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user