ric/uptime-kuma
1
0
Fork 0
mirror of https://github.com/louislam/uptime-kuma.git synced 2025-02-21 11:05:56 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Merge pull request #5 from erwineverts/master 

Document ENV variables
Louis Lam 2022-03-28 19:11:55 +08:00 • committed by GitHub
commit d83a52b00c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
Environment-Variables.md

@ -1,15 +1,19 @@
### UPTIME_KUMA_SSL_CERT `string`
- SSL Cert File Path
- Default Value: `undefined`
# Server environment variables
### UPTIME_KUMA_SSL_KEY `string`
- SSL Key File Path
- 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) | |
# Docker specific environment variables
### UPTIME_KUMA_DISABLE_FRAME_SAMEORIGIN `int`
(1.10.0)
-
- Default Value: `undefined`
| Environment variable | Description | Default |
| -------------------- | ----------------------------------- | ------: |
| `PUID` | User id to access the data storage | `1000` |
| `GUID` | Group id to access the data storage | `1000` |