From f47549d66005ddaaedf9bf9018905cb84b15747e Mon Sep 17 00:00:00 2001 From: Erwin Everts <690259-erwineverts@users.noreply.gitlab.com> Date: Mon, 28 Mar 2022 12:13:22 +0200 Subject: [PATCH] #355 Document ENV variables --- Environment-Variables.md | 25 +++++++++++-------------- 1 file changed, 11 insertions(+), 14 deletions(-) diff --git a/Environment-Variables.md b/Environment-Variables.md index a788d7a..20f3400 100644 --- a/Environment-Variables.md +++ b/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` \ No newline at end of file +| 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) | |