From 488d535aac7a6d4cfacc584edab3f6ad4b99f9f6 Mon Sep 17 00:00:00 2001 From: LouisLam Date: Sun, 11 Jul 2021 16:02:06 +0800 Subject: [PATCH] update readme --- README.md | 28 +++++++++++++++++++++++++--- package.json | 4 +++- 2 files changed, 28 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 71c226f60..3bb7919a5 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/package.json b/package.json index 5a8fdc03c..b451688ea 100644 --- a/package.json +++ b/package.json @@ -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",