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

#355 Document ENV variables

Erwin Everts 2022-03-28 12:13:22 +02:00
parent 5bbe4a8a45
commit f47549d660
1 changed files with 11 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
Environment-Variables.md

@ -1,15 +1,12 @@
### UPTIME_KUMA_SSL_CERT `string`
- SSL Cert File Path
- Default Value: `undefined`
# Environment variables
### UPTIME_KUMA_SSL_KEY `string`
- SSL Key File Path
- Default Value: `undefined`
### UPTIME_KUMA_DISABLE_FRAME_SAMEORIGIN `int`
(1.10.0)
-
- Default Value: `undefined`
| Environment variable | Server argument | Description | Default |
| ------------------------------------------ | -------------------------- | --------------------------------------------------------------------- | ---------: |
| `NODE_ENV` | | Set the NodeJS environment flag | production |
| `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. | `::` |
| `UPTIME_KUMA_PORT` or `PORT` | `port` | Port to listen to | `3001` |
| `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_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` | | Log beat event to STDOUT ("1" to enable) | |