Connect Uptime Kuma
Create a status page in Uptime Kuma, set the display time zone, and give the status page URL to Kuma Mieru.
Version requirement
Kuma Mieru is tested and compatible with the latest stable version of Uptime Kuma (v1.23.0 and later). If your version is older, upgrade to v1.23.0 or later as described in the Uptime Kuma update guide. Back up your data before you upgrade.
Preparation
Install Uptime Kuma
Install and configure Uptime Kuma.
Set the display time zone
In the Uptime Kuma settings, set Display Timezone to a UTC+0 time zone.
The times that the Uptime Kuma backend sends to the frontend carry no time zone information. Kuma Mieru shows all times in UTC+0. If the display time zone is not UTC+0, the times in Kuma Mieru are offset.
Create a status page
Create a status page in Uptime Kuma and copy its URL, for example https://example.kuma-mieru.invalid/status/test1.
Configure the environment variables
Put the status page URL in UPTIME_KUMA_URLS:
UPTIME_KUMA_URLS=https://example.kuma-mieru.invalid/status/test1Where you set it depends on the deployment method. See Environment Variables.
Status page URL
Kuma Mieru splits the URL into two parts. The part before /status/ is the base URL of Uptime Kuma. The segment after /status/ is the page ID. If Uptime Kuma runs under a subpath, the base URL keeps the path prefix.
| Status page URL | Base URL | Page ID |
|---|---|---|
https://example.kuma-mieru.invalid/status/test1 | https://example.kuma-mieru.invalid | test1 |
https://example.kuma-mieru.invalid/kuma/status/default | https://example.kuma-mieru.invalid/kuma | default |
If a URL has no /status/<page ID> part, configuration generation fails.
Multiple status pages
Separate multiple URLs with |. The status pages can come from different Uptime Kuma instances:
UPTIME_KUMA_URLS=https://example.kuma-mieru.invalid/status/default|https://status.kuma-mieru.invalid/status/secondary- The first URL is the default page.
- Each page ID must be unique across all instances. If two instances both have a status page with the page ID
default, configuration generation fails with an error that starts withDuplicate page id "default". Give the status page in one of the instances a different page ID.
How Kuma Mieru reads the data
sequenceDiagram participant G as generate script participant K as Uptime Kuma participant S as Kuma Mieru server participant B as Browser G->>K: Request each status page K-->>G: Title, description and icon of the status page G->>G: Write generated-config.json B->>S: Open the dashboard S->>K: Request monitoring data K-->>S: Monitoring data S-->>B: Page
- The
generatescript runs during the build or when the container starts. For the details, see Choose a Deployment Method. If the script cannot reach Uptime Kuma, the title, description and icon come from the environment variables or the defaults. - The Kuma Mieru server requests the monitoring data from Uptime Kuma at runtime. Thus the environment that runs Kuma Mieru must be able to reach the status page URL.
- If Uptime Kuma uses a self-signed certificate, see ALLOW_INSECURE_TLS. This variable applies to the runtime requests of the server. It does not apply to the requests of the
generatescript that read the status page metadata. With a self-signed certificate, that step fails, and the title, description and icon come from the environment variables or the defaults. - You also set the timeout and the retry count of the runtime server requests in Environment Variables.
Last updated on