ric/uptime-kuma
1
0
Fork 0
mirror of https://github.com/louislam/uptime-kuma.git synced 2024-11-30 18:24:03 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Merge remote-tracking branch 'production/master'

Louis Lam 2022-06-22 20:40:57 +08:00
commit 1655830a30
3 changed files with 16 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
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 | | |

2
🆙-How-to-Update.md

@ -34,7 +34,7 @@ cd <uptime-kuma-directory>
# 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

12
🔧-How-to-Install.md

@ -51,9 +51,15 @@ docker run -d --restart=always -p <YOUR_PORT>:3001 -v <YOUR_DIR OR VOLUME>:/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
@ -97,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.