update readme

This commit is contained in:
LouisLam 2021-07-11 16:02:06 +08:00
parent f9800a087e
commit 488d535aac
2 changed files with 28 additions and 4 deletions

View file

@ -11,11 +11,33 @@ It is a self-hosted monitoring tool like "Uptime Robot".
# How to Use
npm
### Docker
```
docker run -d --restart=always -p 3001:3001 louislam/uptime-kuma
```
Docker
Browse to http://localhost:3001 after started.
One-click Deploy to DigitalOcean
### Node.js >= 14 + GIT
```
git clone git@github.com:louislam/uptime-kuma.git
cd uptime-kuma
npm run install
# 1. Try it
npm run start-server
# 2. Run in background using PM2
# Install PM2 if you don't have: npm install pm2 -g
pm2 start npm -- run start-server
```
Browse to http://localhost:3001 after started.
### One-click Deploy to DigitalOcean
Coming Soon
# Motivation

View file

@ -6,7 +6,9 @@
"start-server": "node server/server.js",
"update": "",
"build": "vite build",
"vite-preview-dist": "vite preview --host"
"vite-preview-dist": "vite preview --host",
"build-docker": "docker buildx build --platform linux/amd64,linux/arm64,linux/arm/v7 -t louislam/uptime-kuma . --push",
"install": "git checkout 1.0.0 && npm install && npm run build"
},
"dependencies": {
"@popperjs/core": "^2.9.2",