Add Docker documentation #35877
Add Docker documentation #35877
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
| ### Docker could not connect to Tahoma | ||
|
|
||
| If you are using Docker, it's possible that the container running Home Assistant doesn't have access to the hostname of the Tahoma service running the API. | ||
|
|
||
| ``` | ||
| curl -I gateway-xxxx-xxxx-xxxx.local:8443 | ||
| curl: (6) Could not resolve host: gateway-xxxx-xxxx-xxxx.local | ||
| ``` | ||
|
|
||
| Make sure Home Assistant has access to the service or use the IP address instead of the hostname. |
There was a problem hiding this comment.
That seems quite impossible; how can this happen?
The only thing I can thing about is: Running our containers in an unsupported way?
|
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
📝 WalkthroughWalkthroughThe changes introduce a new section in the Overkiz integration documentation, specifically addressing connectivity issues between Docker and the Tahoma service. This section includes an example of a specific error message that users may encounter and provides guidance on resolving the issue by ensuring Home Assistant has access to the Tahoma service or by using the service's IP address instead of its hostname. The overall structure of the document remains unchanged. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Docker
participant Tahoma API
User->>Docker: Start Home Assistant container
Docker->>Tahoma API: Attempt to connect
alt Connection successful
Docker->>User: Connection established
else Connection failed
Docker->>User: Display error message
User->>Docker: Check access
alt Access issue
User->>Docker: Use IP address instead of hostname
end
end
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (2)
source/_integrations/overkiz.markdown (2)
135-136: Enhance the technical accuracy of the issue description.The current description could be more precise. Consider this revision for better clarity:
-If you are using Docker, it's possible that the container running Home Assistant doesn't have access to the hostname of the Tahoma service running the API. +When running Home Assistant in Docker, the container may fail to resolve the Tahoma gateway's hostname due to DNS resolution limitations in the Docker network.🧰 Tools
🪛 LanguageTool
[style] ~135-~135: For conciseness, try rephrasing this sentence.
Context: ...ect to Tahoma If you are using Docker, it's possible that the container running Home Assistant doesn't have access to t...(MAY_MIGHT_BE)
137-140: Add language specification and improve the code example.The code block should specify the language and provide more context about the command.
-``` +```bash +# Test connection to Tahoma gateway curl -I gateway-xxxx-xxxx-xxxx.local:8443 curl: (6) Could not resolve host: gateway-xxxx-xxxx-xxxx.local<details> <summary>🧰 Tools</summary> <details> <summary>🪛 Markdownlint</summary> 137-137: null Fenced code blocks should have a language specified (MD040, fenced-code-language) </details> </details> </blockquote></details> </blockquote></details> <details> <summary>📜 Review details</summary> **Configuration used: CodeRabbit UI** **Review profile: CHILL** <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between 7ce05f70d50703d30db9236afca9a78e9a3d4aa0 and 4f1319b03c9d5769a146ad3fcd2b6141a4db51cf. </details> <details> <summary>📒 Files selected for processing (1)</summary> * `source/_integrations/overkiz.markdown` (1 hunks) </details> <details> <summary>🧰 Additional context used</summary> <details> <summary>🪛 LanguageTool</summary> <details> <summary>source/_integrations/overkiz.markdown</summary> [style] ~135-~135: For conciseness, try rephrasing this sentence. Context: ...ect to Tahoma If you are using Docker, it's possible that the container running Home Assistant doesn't have access to t... (MAY_MIGHT_BE) </details> </details> <details> <summary>🪛 Markdownlint</summary> <details> <summary>source/_integrations/overkiz.markdown</summary> 137-137: null Fenced code blocks should have a language specified (MD040, fenced-code-language) </details> </details> </details> <details> <summary>🔇 Additional comments (2)</summary> <details> <summary>source/_integrations/overkiz.markdown (2)</summary> `133-133`: **LGTM!** The section header is clear and follows the document's structure. --- `132-142`: **Add verification steps for the solution.** Consider adding a section that helps users verify their setup is working correctly. Consider adding these verification steps to the documentation: ```markdown To verify your setup: 1. Test the connection: `curl -I <your-gateway-ip>:8443` 2. Check Home Assistant logs for successful connection 3. Verify device discovery in Home Assistant🧰 Tools
🪛 LanguageTool
[style] ~135-~135: For conciseness, try rephrasing this sentence.
Context: ...ect to Tahoma If you are using Docker, it's possible that the container running Home Assistant doesn't have access to t...(MAY_MIGHT_BE)
🪛 Markdownlint
137-137: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
| curl: (6) Could not resolve host: gateway-xxxx-xxxx-xxxx.local | ||
| ``` | ||
|
|
||
| Make sure Home Assistant has access to the service or use the IP address instead of the hostname. |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Expand the solution with specific implementation steps.
The current solution lacks detailed guidance. Consider expanding it with specific steps:
-Make sure Home Assistant has access to the service or use the IP address instead of the hostname.
+To resolve this issue, you have two options:
+
+1. Enable DNS resolution in the Docker container:
+ - Add the following to your `docker-compose.yml`:
+ ```yaml
+ services:
+ homeassistant:
+ network_mode: host
+ ```
+ - Or use the `--network host` flag with `docker run`
+
+2. Use the IP address instead of the hostname:
+ - Find your Tahoma gateway's IP address from your router
+ - Replace `gateway-xxxx-xxxx-xxxx.local` with the IP address in your Home Assistant configuration
Proposed change
Adding docs for Docker users connecting to Tahoma service.
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit