From 2ce8d2a723ce4547808e75fe8f9654f4c1d65f0b Mon Sep 17 00:00:00 2001 From: Louis Lam Date: Mon, 6 Jun 2022 23:13:59 +0800 Subject: [PATCH 1/4] =?UTF-8?q?Updated=20=F0=9F=94=A7=20How=20to=20Install?= =?UTF-8?q?=20(markdown)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- 🔧-How-to-Install.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/🔧-How-to-Install.md b/🔧-How-to-Install.md index b22182a..4794e31 100644 --- a/🔧-How-to-Install.md +++ b/🔧-How-to-Install.md @@ -51,9 +51,15 @@ docker run -d --restart=always -p :3001 -v :/app/ ### 💪🏻 Without Docker (Recommended for x86/x64 only) -Required Tools: Node.js >= 14, git and pm2. +It should supports Linux/Windows/MacOS. + +Required Tools: +- [Node.js](https://nodejs.org/en/) >= 14 +- [Git](https://git-scm.com/downloads) +- [PM2](https://pm2.keymetrics.io/) +- (Optional) [cloudflared](https://github.com/cloudflare/cloudflared) +- (Optional) [Apprise](https://github.com/caronc/apprise) -(**Not recommended for ARM CPU users.** Since there is no prebuilt for node-sqlite3, it is hard to get it running) ```bash # Update your npm to the latest version From 51ffa14f16c14f25bab41945bd7639779e693ba3 Mon Sep 17 00:00:00 2001 From: Louis Lam Date: Mon, 6 Jun 2022 23:14:58 +0800 Subject: [PATCH 2/4] =?UTF-8?q?Updated=20=F0=9F=94=A7=20How=20to=20Install?= =?UTF-8?q?=20(markdown)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- 🔧-How-to-Install.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/🔧-How-to-Install.md b/🔧-How-to-Install.md index 4794e31..5685f66 100644 --- a/🔧-How-to-Install.md +++ b/🔧-How-to-Install.md @@ -103,7 +103,7 @@ https://github.com/louislam/uptime-kuma/blob/master/docker/docker-compose.yml ## (Optional) One more step for Reverse Proxy -This is optional for someone who want to do reverse proxy. +This is optional for someone who want to use a reverse proxy. Unlikely other web apps, Uptime Kuma is based on WebSocket. You need two more headers **"Upgrade"** and **"Connection"** in order to reverse proxy WebSocket. From 09e99d08571dc7b8d34ddb5f8ed63b925597d9a2 Mon Sep 17 00:00:00 2001 From: Louis Lam Date: Thu, 9 Jun 2022 19:56:29 +0800 Subject: [PATCH 3/4] Updated Environment Variables (markdown) --- Environment-Variables.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/Environment-Variables.md b/Environment-Variables.md index 4b31ace..ec86ec2 100644 --- a/Environment-Variables.md +++ b/Environment-Variables.md @@ -1,6 +1,6 @@ -## Server environment variables +## Server Environment Variables -| Environment variable | Server argument | Description | Default | +| Environment Variable | Server Argument | Description | Default | | ------------------------------------------ | -------------------------- | --------------------------------------------------------------------- | ---------: | | `DATA_DIR` | `data-dir` | Set the directory where the data should be stored (could be relative) | `./data/` | | `UPTIME_KUMA_HOST` or `HOST` | `host` | Host to bind to, could be an ip. | `::` | @@ -8,13 +8,15 @@ | `UPTIME_KUMA_SSL_KEY` or `SSL_KEY` | `ssl-key` | Path to SSL key | | | `UPTIME_KUMA_SSL_CERT` or `SSL_CERT` | `ssl-cert` | Path to SSL certificate | | | `UPTIME_KUMA_CLOUDFLARED_TOKEN` | `cloudflared-token` | Cloudflare Tunnel Token (Available in 1.14.0) | | +| `UPTIME_KUMA_DISABLE_FRAME_SAMEORIGIN` | `disable-frame-sameorigin` | By default, Uptime Kuma is not allowed in iframe if the domain name is not the same as the parent. It protects your Uptime Kuma to be a phishing website. If you don't need this protection, you can set it to `true` | `false` | | `NODE_EXTRA_CA_CERTS` | | Add your self-signed ca certs. (e.g. /cert/path/CAcert.pem) [Read more](https://github.com/louislam/uptime-kuma/issues/1380) | | | `NODE_TLS_REJECT_UNAUTHORIZED` | | Ignore all TLS errors | `0` | +| `NODE_OPTIONS` | | Set it to `--insecure-http-parser`, if you encountered error `Invalid header value char` when your website using WAF | | -## Docker specific environment variables +## Docker Specific Environment Variables -| Environment variable | Description | Default | +| Environment Variable | Description | Default | | -------------------- | ----------------------------------- | ------: | | `PUID` | User id to access the data storage | `1000` | | `PGID` | Group id to access the data storage | `1000` | @@ -24,7 +26,6 @@ | Environment variable | Server argument | Description | Default | | ------------------------------------------ | -------------------------- | --------------------------------------------------------------------- | ---------: | | `NODE_ENV` | | Set the NodeJS environment flag | production | -| `UPTIME_KUMA_DISABLE_FRAME_SAMEORIGIN` | `disable-frame-sameorigin` | Prevent kuma from being opened by an IFrame from other hosts | `false` | | `UPTIME_KUMA_LOG_RESPONSE_BODY_MONITOR_ID` | | Monitor ID - If provided, it will output the monitor's response to your console | | | `UPTIME_KUMA_HIDE_LOG` | | (1.15.0) Examples: debug_monitor,info_monitor,debug_cert,warn_monitor | | | `SQL_LOG` | | Set `1` to enable | | | From 77804a284a297dba597e47b07e1a6174f42f73ca Mon Sep 17 00:00:00 2001 From: Louis Lam Date: Wed, 22 Jun 2022 20:23:41 +0800 Subject: [PATCH 4/4] Update to 1.17.0 --- 🆙-How-to-Update.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/🆙-How-to-Update.md b/🆙-How-to-Update.md index 1227246..6342075 100644 --- a/🆙-How-to-Update.md +++ b/🆙-How-to-Update.md @@ -34,7 +34,7 @@ cd # Update from git git fetch --all -git checkout 1.16.1 --force +git checkout 1.17.0 --force # Install dependencies and prebuilt npm install --production