Kuma Mieru 文档
配置

连接 Uptime Kuma

在 Uptime Kuma 中创建状态页并设置显示时区,再把状态页 URL 交给 Kuma Mieru。

版本要求

经测试,Kuma Mieru 兼容 Uptime Kuma 的最新稳定版本(v1.23.0 及以上)。版本较低时,请参考 Uptime Kuma 官方升级文档升级到 v1.23.0 或以上,升级前先备份数据。

准备步骤

安装 Uptime Kuma

安装并配置 Uptime Kuma。

设置显示时区

在 Uptime Kuma 的设置中,把 Display Timezone(显示时区)改为任意 UTC+0 时区。

Uptime Kuma 后端传给前端的时间不带时区信息,Kuma Mieru 统一按 UTC+0 显示时间。显示时区不是 UTC+0 时,Kuma Mieru 中的时间会出现偏移。

创建状态页

在 Uptime Kuma 中创建状态页(Status Page),复制它的 URL,例如 https://example.kuma-mieru.invalid/status/test1。

配置环境变量

把状态页 URL 写入 UPTIME_KUMA_URLS:

.env
UPTIME_KUMA_URLS=https://example.kuma-mieru.invalid/status/test1

设置位置取决于部署方式,见环境变量。

状态页 URL

Kuma Mieru 从 URL 中取出两部分:/status/ 前面的部分是 Uptime Kuma 的基础 URL,/status/ 后面的一段是页面 ID。Uptime Kuma 部署在子路径下时,路径前缀保留在基础 URL 中。

状态页 URL基础 URL页面 ID
https://example.kuma-mieru.invalid/status/test1https://example.kuma-mieru.invalidtest1
https://example.kuma-mieru.invalid/kuma/status/defaulthttps://example.kuma-mieru.invalid/kumadefault

URL 中没有 /status/<页面 ID> 时,配置生成失败。

多个状态页

用 | 分隔多个 URL。这些状态页可以来自不同的 Uptime Kuma 实例:

.env
UPTIME_KUMA_URLS=https://example.kuma-mieru.invalid/status/default|https://status.kuma-mieru.invalid/status/secondary
  • 第一个 URL 是默认页面。
  • 页面 ID 在所有实例之间必须唯一。两个实例都有页面 ID 为 default 的状态页时,配置生成失败,报错信息以 Duplicate page id "default" 开头。请在其中一个实例中给状态页换一个页面 ID。

Kuma Mieru 如何读取数据

sequenceDiagram
  participant G as generate 脚本
  participant K as Uptime Kuma
  participant S as Kuma Mieru 服务端
  participant B as 浏览器
  G->>K: 请求每个状态页
  K-->>G: 状态页的标题、描述和图标
  G->>G: 写入 generated-config.json
  B->>S: 打开仪表盘
  S->>K: 请求监控数据
  K-->>S: 返回监控数据
  S-->>B: 返回页面
  • generate 脚本在构建时或容器启动时运行,时机见选择部署方式。它访问不到 Uptime Kuma 时,标题、描述和图标使用环境变量的值或默认值。
  • Kuma Mieru 的服务端在运行时向 Uptime Kuma 请求监控数据,所以运行 Kuma Mieru 的环境需要能访问状态页 URL。
  • Uptime Kuma 使用自签名证书时,见 ALLOW_INSECURE_TLS。这个变量作用于服务端运行时的请求,不作用于 generate 脚本读取状态页元信息的请求;自签名证书环境中,这一步请求失败,标题、描述和图标使用环境变量的值或默认值。
  • 服务端运行时请求的超时与重试次数也在环境变量中设置。

最后更新于