Add Uptime Kuma docs #39451
Add Uptime Kuma docs #39451
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughA new documentation file was added for the Uptime Kuma integration with Home Assistant. This file introduces the integration, describes its setup process, available sensors, configuration options, known limitations, and removal instructions, using standard Home Assistant documentation templates. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant HomeAssistant
participant UptimeKuma
User->>HomeAssistant: Configure Uptime Kuma integration (provide URL, API key)
HomeAssistant->>UptimeKuma: Authenticate and fetch monitor data via API
UptimeKuma-->>HomeAssistant: Return monitor status, response time, etc.
HomeAssistant-->>User: Display sensors (status, response time, etc.)
Note over HomeAssistant: Data is updated every 30 seconds
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
source/_integrations/uptime_kuma.markdown (2)
36-41: Align configuration keys with YAML conventions
In theconfiguration_basicblock, option names should be unquoted, snake_case YAML keys that match the integration’s config schema. Consider updating as follows:-{% configuration_basic %} -"URL": - description: "Address of your Uptime Kuma instance. Example: `https://uptime.example.com`." -Verify SSL certificate: - description: "Enable SSL certificate verification for secure connections." -"API key": - description: "An API key to authenticate with your Uptime Kuma instance." -{% endconfiguration_basic %} +{% configuration_basic %} +url: + description: "Address of your Uptime Kuma instance. Example: `https://uptime.example.com`." +verify_ssl: + description: "Enable SSL certificate verification for secure connections." +api_key: + description: "An API key to authenticate with your Uptime Kuma instance." +{% endconfiguration_basic %}
68-68: Fix list numbering and add trailing newline
Per markdownlint rules, ordered lists should restart at1.and the file must end with a single newline. Update this line and ensure a newline at EOF:-4. You can now remove the API key used for Home Assistant from Uptime Kuma, unless it is also used by other integrations or applications. +1. You can now remove the API key used for Home Assistant from Uptime Kuma, unless it is also used by other integrations or applications.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
68-68: Ordered list item prefix
Expected: 1; Actual: 4; Style: 1/1/1(MD029, ol-prefix)
68-68: Files should end with a single newline character
null(MD047, single-trailing-newline)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
source/_integrations/uptime_kuma.markdown(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/uptime_kuma.markdown
68-68: Ordered list item prefix
Expected: 1; Actual: 4; Style: 1/1/1
(MD029, ol-prefix)
68-68: Files should end with a single newline character
null
(MD047, single-trailing-newline)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
| description: Instructions on how to integrate Uptime Kuma with Home Assistant. | ||
| ha_category: | ||
| - Sensor | ||
| ha_iot_class: Cloud push |
There was a problem hiding this comment.
Correct the ha_iot_class identifier
The ha_iot_class value must use the official enum format (cloud_push), not a human-readable string.
- ha_iot_class: Cloud push
+ ha_iot_class: cloud_push📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ha_iot_class: Cloud push | |
| ha_iot_class: cloud_push |
🤖 Prompt for AI Agents
In source/_integrations/uptime_kuma.markdown at line 6, the ha_iot_class value
is set to "Cloud push" which is a human-readable string. Change this value to
the official enum format "cloud_push" using lowercase letters and underscore to
match the required identifier format.
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
source/_integrations/uptime_kuma.markdown (1)
6-6: Correct theha_iot_classidentifier
Theha_iot_classvalue must use the official enum format, not a human-readable string.- ha_iot_class: Cloud push + ha_iot_class: cloud_push
🧹 Nitpick comments (2)
source/_integrations/uptime_kuma.markdown (2)
37-37: Unify example domain suffix
The document currently mixes.organd.comin examples—standardize on one. Update the config example to match the prerequisites section:- "URL": - description: "Address of your Uptime Kuma instance. Example: `https://uptime.example.com`." + "URL": + description: "Address of your Uptime Kuma instance. Example: `https://uptime.example.org`."
68-68: Use consistent ordered list prefixes
Markdown lint expects all ordered list items to use1.as the prefix. Change this step accordingly:- 4. You can now remove the API key used for Home Assistant from Uptime Kuma... + 1. You can now remove the API key used for Home Assistant from Uptime Kuma...🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
68-68: Ordered list item prefix
Expected: 1; Actual: 4; Style: 1/1/1(MD029, ol-prefix)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
source/_integrations/uptime_kuma.markdown(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/uptime_kuma.markdown
68-68: Ordered list item prefix
Expected: 1; Actual: 4; Style: 1/1/1
(MD029, ol-prefix)
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (2)
source/_integrations/uptime_kuma.markdown (2)
31-32: Remove quotes inside the{% icon %}macroQuoting the icon name is not supported and renders the literal quotes.
-... **{% icon "mdi:cog" %} Settings → API Keys** and selecting **{% icon "mdi:plus" %}Add API Key**. +... **{% icon mdi:cog %} Settings → API Keys** and selecting **{% icon mdi:plus %} Add API Key**.
63-68: Fix ordered-list numbering style (MD029)Home Assistant docs lint requires each ordered item to start with
1.to enable auto-increment.-4. You can now remove the API key used for Home Assistant from Uptime Kuma, unless it is also used by other integrations or applications. +1. You can now remove the API key used for Home Assistant from Uptime Kuma, unless it is also used by other integrations or applications.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
source/_integrations/uptime_kuma.markdown(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/uptime_kuma.markdown
68-68: Ordered list item prefix
Expected: 1; Actual: 4; Style: 1/1/1
(MD029, ol-prefix)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (1)
source/_integrations/uptime_kuma.markdown (1)
7-7: Confirmha_releasevalue
ha_release: 2025.8seems out of sync with the current release cycle (presently 2024.x). Please verify the intended target version for this integration.
| description: Instructions on how to integrate Uptime Kuma with Home Assistant. | ||
| ha_category: | ||
| - Sensor | ||
| ha_iot_class: Cloud polling |
There was a problem hiding this comment.
Incorrect ha_iot_class enum – use the canonical snake-case value
Use the official enum cloud_polling; the current value will break the docs build.
-ha_iot_class: Cloud polling
+ha_iot_class: cloud_polling📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ha_iot_class: Cloud polling | |
| ha_iot_class: cloud_polling |
🤖 Prompt for AI Agents
In source/_integrations/uptime_kuma.markdown at line 6, the ha_iot_class value
is incorrectly set to "Cloud polling" which is not the canonical enum format.
Change this value to the official snake-case enum "cloud_polling" to ensure the
documentation builds correctly without errors.
| {% configuration_basic %} | ||
| "URL": | ||
| description: "Address of your Uptime Kuma instance. Example: `https://uptime.example.com`." | ||
| "Verify SSL certificate": | ||
| description: "Enable SSL certificate verification for secure connections." | ||
| "API key": | ||
| description: "An API key to authenticate with your Uptime Kuma instance." | ||
| {% endconfiguration_basic %} |
There was a problem hiding this comment.
🛠️ Refactor suggestion
configuration_basic block does not follow expected key syntax
Keys should match the actual config-flow field ids (lower-case, snake_case) and include an optional name label. Current mixed-case strings with spaces will fail to render.
-{% configuration_basic %}
-"URL":
- description: "Address of your Uptime Kuma instance. Example: `https://uptime.example.com`."
-"Verify SSL certificate":
- description: "Enable SSL certificate verification for secure connections."
-"API key":
- description: "An API key to authenticate with your Uptime Kuma instance."
-{% endconfiguration_basic %}
+{% configuration_basic %}
+url:
+ name: URL
+ description: Address of your Uptime Kuma instance. Example: `https://uptime.example.com`.
+verify_ssl:
+ name: Verify SSL certificate
+ description: Enable SSL certificate verification for secure connections.
+api_key:
+ name: API key
+ description: An API key to authenticate with your Uptime Kuma instance.
+{% endconfiguration_basic %}📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| {% configuration_basic %} | |
| "URL": | |
| description: "Address of your Uptime Kuma instance. Example: `https://uptime.example.com`." | |
| "Verify SSL certificate": | |
| description: "Enable SSL certificate verification for secure connections." | |
| "API key": | |
| description: "An API key to authenticate with your Uptime Kuma instance." | |
| {% endconfiguration_basic %} | |
| {% configuration_basic %} | |
| url: | |
| name: URL | |
| description: Address of your Uptime Kuma instance. Example: `https://uptime.example.com`. | |
| verify_ssl: | |
| name: Verify SSL certificate | |
| description: Enable SSL certificate verification for secure connections. | |
| api_key: | |
| name: API key | |
| description: An API key to authenticate with your Uptime Kuma instance. | |
| {% endconfiguration_basic %} |
🤖 Prompt for AI Agents
In source/_integrations/uptime_kuma.markdown around lines 35 to 42, the keys
inside the configuration_basic block use mixed-case and spaces, which do not
match the expected lower-case, snake_case syntax required for config-flow field
ids. Rename the keys to use lower-case snake_case (e.g., "url",
"verify_ssl_certificate", "api_key") and optionally add a name label for display
purposes to ensure proper rendering.
Proposed change
Add docs for Uptime Kuma integration
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit
Summary by CodeRabbit