Be more verbose about hostname #341
Conversation
nut/DOCS.md
Outdated
| @@ -15,7 +15,7 @@ many [individuals and companies][nut-acknowledgements]. | |||
|
|
|||
| Be sure to add the NUT integration after starting the add-on. | |||
|
|
|||
| **Note**: _The host `a0d7b954-nut` can be used to allow Home Assistant to | |||
| **Note**: _The host `a0d7b954-nut` must be used to allow Home Assistant to | |||
There was a problem hiding this comment.
can, not must.
Revert this change please.
nut/DOCS.md
Outdated
| @@ -35,7 +35,7 @@ comparison to installing any other Home Assistant add-on. | |||
| 1. Configure the `users` and `devices` options. | |||
| 1. Start the "Network UPS Tools" add-on. | |||
| 1. Check the logs of the "Network UPS Tools" add-on to see if everything went well. | |||
| 1. Configure the [NUT Integration][nut-ha-docs]. | |||
| 1. Configure the [NUT Integration][nut-ha-docs] and use `a0d7b954-nut` hostname. | |||
There was a problem hiding this comment.
This could be something else... for example, in my case, it is 40817795-nut. But I guess this is the common one, so that is fine.
The sentence doesn't flow though add the before hostname? Also, I think HA asks for "Host" and not "hostname"?
There was a problem hiding this comment.
AFAIK the id is SHA1(addon_url)[:8], so it will be a0d7b954-nut for most people as long as you don't change its name or move it. But it's a good point, I rewrote it to allow for other hostnames, hopefully it flows better now.
As for the host or hostname question, the only place where hostname is not used is the title of the field in the integration configuration. The add-on page shows hostname and even the tooltip in the integration configuration says: The hostname or IP address of your NUT server. So I guess it's pick-your-own, the consistency is already gone and I tried now to match the field name in the right context. That being said, I can stick to using just one of them if you prefer that.
|
There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days. Thank you for your contributions. |
github-actions
bot
added
the
stale
Proposed Changes
Documentation change. The fact that add-on specific hostname has to be used in the NUT integration instead of the default
localhostis not highlighted well and it led to several comments in tickets, e.g. here, or here.So I'm changing the text from /can/ to /must/ and I'm adding it to the steps to follow as well to make it less likely to be overlooked as it happened to me.
Related Issues