进阶 uptime.kuma.pet 2026-11-20 10:30:00 · 2 阅读

第5章 Uptime Kuma 环境变量配置

环境变量(1.20.0)

对于非 Docker 用户,可以在根目录创建一个名为 `.env` 的文件,格式如下: ``` UPTIME_KUMA_HOST=127.0.0.1 UPTIME_KUMA_PORT=8080 ```

#### 服务器参数用法 ``` node --run start-server -- --host=127.0.0.1 --port=8080 ```

服务器环境变量

| 环境变量 | 服务器参数 | 起始版本 | 描述 | 默认值 | | :--- | :--- | :--- | :--- | :--- | | `DATA_DIR` | `--data-dir=` | | 设置数据存储目录(支持相对路径)。 | `/data` | | `UPTIME_KUMA_HOST` 或 `HOST` | `--host=` | | 要绑定的主机地址,可以是 IP。 | `::` | | `UPTIME_KUMA_PORT` 或 `PORT` | `--port=` | | 监听端口。 | `3001` | | `UPTIME_KUMA_SSL_KEY` 或 `SSL_KEY` | `--ssl-key=` | | SSL 密钥文件路径。 | | | `UPTIME_KUMA_SSL_CERT` 或 `SSL_CERT` | `--ssl-cert=` | | SSL 证书文件路径。 | | | `UPTIME_KUMA_SSL_KEY_PASSPHRASE` 或 `SSL_KEY_PASSPHRASE` | `--ssl-key-passphrase=` | 1.21.1 | SSL 密钥短语。 | | | `UPTIME_KUMA_CLOUDFLARED_TOKEN` | `--cloudflared-token=` | 1.14.0 | Cloudflare Tunnel 令牌。 | | | `UPTIME_KUMA_DISABLE_FRAME_SAMEORIGIN` | `--disable-frame-sameorigin=` | | 默认情况下,如果域名与父级不同,Uptime Kuma 不允许在 iframe 中嵌入,这可以防止 Uptime Kuma 被用于钓鱼网站。如果你不需要此保护,可以将其设置为 `true`。 | `false` | | `UPTIME_KUMA_WS_ORIGIN_CHECK` | | | 默认情况下,Uptime Kuma 会验证 WebSockets 的 ORIGIN 头部是否与服务器主机名匹配。如果你不需要此保护,可以将其设置为 `bypass`。更多背景信息请参考 GHSA-mj22-23ff-2hrr。 | `cors-like` | | `UPTIME_KUMA_ALLOW_ALL_CHROME_EXEC` | `--allow-all-chrome-exec=` | 1.23.0 | 允许指定任意可执行文件作为 Chromium。 | `0` | | `UPTIME_KUMA_SQLITE_SINGLE_CONNECTION` | | 2.3.2 | 可以设置为 `false` 以启用多个连接,但可能会出现 `SQLITE_BUSY: database is locked` 错误。阅读更多:#7289。 | `true` | | `NODE_EXTRA_CA_CERTS` | | | 添加自签名 CA 证书。(例如:`/cert/path/CAcert.pem`)阅读更多。 | | | `NODE_TLS_REJECT_UNAUTHORIZED` | | | 忽略所有 TLS 错误。 | `0` | | `NODE_OPTIONS` | | | 如果你在使用 WAF 的网站遇到 `Invalid header value char` 错误,请将其设置为 `--insecure-http-parser`。 | | | `NOTIFICATION_PROXY` | | 2.0.0 | 指定用于发送通知的网络代理。代理必须作为完整的 URL 提供,例如:`http://proxy.example.com:8080`。支持的协议包括:`http:`、`https:`、`socks:`、`socks4:`、`socks5:` 和 `socks5h:`。 | | | `UPTIME_KUMA_DISABLE_LEAK_PWD_CHECK` | `--disable-leak-pwd-check=` | 3.0.0 | 禁用密码泄露检查。 | | | `UK_INITIAL_ADMIN_USERNAME` | | 3.0.0 | 初始管理员用户的用户名。仅在不存在用户时使用;首次初始化后忽略。必须与 `UK_INITIAL_ADMIN_PASSWORD` 一起设置。 | | | `UK_INITIAL_ADMIN_PASSWORD` | | 3.0.0 | 初始管理员用户的密码。仅在不存在用户时使用;首次初始化后忽略。必须与 `UK_INITIAL_ADMIN_USERNAME` 一起设置。 | |

`UK_INITIAL_ADMIN_USERNAME` 和 `UK_INITIAL_ADMIN_PASSWORD` 仅适用于使用空数据库的首次启动;此时将跳过设置向导。 之后更改它们不会修改现有的管理员密码;请使用重置密码 CLI 命令。

MariaDB 环境变量

| 环境变量 | 起始版本 | 描述 | | :--- | :--- | :--- | | `UPTIME_KUMA_DB_TYPE` | 2.0.0 | 数据库类型:`sqlite`、`mariadb`。 | | `UPTIME_KUMA_DB_HOSTNAME` | 2.0.0 | 数据库主机名。仅用于 `mariadb`。 | | `UPTIME_KUMA_DB_PORT` | 2.0.0 | 数据库端口。仅用于 `mariadb`,默认 `3306`。 | | `UPTIME_KUMA_DB_SOCKET` | 2.1.0 | 数据库 Unix socket。如果使用,主机名和端口将被忽略。 | | `UPTIME_KUMA_DB_POOL_MAX_CONNECTIONS` | 2.1.0 | 最大并发连接池连接数,默认为 10。 | | `UPTIME_KUMA_DB_NAME` | 2.0.0 | 数据库名称。 | | `UPTIME_KUMA_DB_USERNAME` | 2.0.0 | 数据库用户名。 | | `UPTIME_KUMA_DB_PASSWORD` | 2.0.0 | 数据库密码。 | | `UPTIME_KUMA_DB_SSL` | 2.1.0 | 可选。为数据库连接启用 SSL(`true`/`false`,默认:`false`)。 | | `UPTIME_KUMA_DB_CA` | 2.1.0 | 可选。SSL 连接的 CA 证书内容(PEM 格式)。 |

以下变量也有 `*_FILE` 变体,这对于使用 Docker secrets 非常有用。除了从该路径加载外,它们的行为相同。

* `UPTIME_KUMA_DB_PASSWORD_FILE` * `UPTIME_KUMA_DB_USERNAME_FILE` * `UPTIME_KUMA_DB_CA_FILE`

仅用于开发

| 环境变量 | 服务器参数 | 起始版本 | 描述 | 默认值 | | :--- | :--- | :--- | :--- | :--- | | `NODE_ENV` | | | 设置 NodeJS 环境标志。`development`、`production`。 | `production` | | `UPTIME_KUMA_LOG_RESPONSE_BODY_MONITOR_ID` | | | 监控 ID。如果提供,它会将监控的响应输出到你的控制台。 | | | `UPTIME_KUMA_HIDE_LOG` | | 1.15.0 | 示例:`debug_monitor`、`info_monitor`、`debug_cert`、`warn_monitor`。 | | | `UPTIME_KUMA_LOG_FORMAT` | | 2.2.0 | 设置为 `json` 以 JSON 格式输出日志。 | | | `SQL_LOG` | | | 设置为 1 以启用。 | | | `UPTIME_KUMA_ENABLE_EMBEDDED_MARIADB` | | 2.0.0 | 设置为 1 以启用。 | | | `UPTIME_KUMA_IN_CONTAINER` | | 1.23.0 | Uptime Kuma 是否在容器中? | | | `UPTIME_KUMA_DEBUG_INSPECTOR` | | 2.4.1 | 设置为 1 以启用 Node.js Inspector(绑定到 127.0.0.1:9229)。 | |

反向代理

为了安全地将 Uptime Kuma 暴露到 Web,建议将其代理到传统的 Web 服务器(如 nginx 或 Apache)后面。以下是一些……

Cloudflare 附注

默认情况下,Cloudflare 对 API 不友好,包括 Uptime Kuma。Cloudflare 可能会阻止来自 Uptime Kuma 的请求。

评论 (0)