home-assistant / home-assistant.io

:blue_book: Home Assistant User documentation
https://www.home-assistant.io
Other
4.73k stars 7.17k forks source link

Missing information re. host in MuteSync integration. #17782

Closed MaxVonEvil closed 3 years ago

MaxVonEvil commented 3 years ago

Feedback

The instructions do not reference that you are prompted for a hostname. It is not clear which host this is. Presuming it's the computer where the mutesync software is installed. Also, if there's a port which needs to be opened in the local firewall that would be useful info too.

URL

https://www.home-assistant.io/integrations/mutesync/

Version

2021.4.6

Additional information

image

ltraughb commented 3 years ago

I'm in the same boat. I have searched high and low and I can't find anything that helps me get this running.

frenck commented 3 years ago

This is now the 3rd time this comes up, and I am (for real) trying to understand the confusion. How is this different from almost any other integration we have and raised this question?

Presuming it's the computer where the mutesync software is installed.

What else could it be?

This is not offensive, really I don't mean to be offensive, I truly am interested in what causes this. For example, we never receive this feedback for AdGuard, Pi-hole, Hue, tradfri, or any other integration that describes this in the same way.

Is it the term "Host" that is unknown? Would "Hostname or IP" be more clear? What is the alternative or suggestion to make it more clear? And how would that suggestion differ from what is already there?

As for firewalls, that is not a concern or responsibility for this project. There are many systems out there that may handle this differently and we want to avoid becoming a manual for all of those.

MaxVonEvil commented 3 years ago

Hi all, I've been in touch with Tom over at Mutesync (CC) on other matters regarding the app. The hostname is confirmed to be the local computer where the Mutesync app is running. Port TCP/8249 needs to be open inbound, as the app is being polled by HA on that port.

Thanks, Max

On Thu, May 13, 2021 at 4:25 PM Franck Nijhof @.***> wrote:

This is now the 3rd time this comes up, and I am (for real) trying to understand the confusion. How is this different from almost any other integration we have and raised this question?

This is not offensive, I truly am interested in what causes this. For example, we never receive this feedback for AdGuard, Pi-hole, Hue, tradfri, or any other integration that describes this in the same way.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/home-assistant/home-assistant.io/issues/17782#issuecomment-840891372, or unsubscribe https://github.com/notifications/unsubscribe-auth/AEXRQVHOL4JYMBM23HBNSDTTNRNXVANCNFSM44SGJUFQ .

--

With best regards, Max Ranzau / +1 610 462 2200

frenck commented 3 years ago

Yes, @MaxVonEvil, that is correct. But could you take a moment and see my message above and explain to me why it caused confusion in this case?

It would really help me understand what is going on.

MaxVonEvil commented 3 years ago

Hello Everyone,

Sorry for the confusion. I really should have put the port information in the docs. I'll submit a PR.

Max is right, the hostname is the computer where the mutesync app is running and Port TCP/8249 needs to be open inbound. Are you having any other issues?

Just FYI unfortunately, we've had some sporadic crashes on Windows, we're actively trying to improve the experience there.

Thanks for giving my humble app your attention!

On Thu, May 13, 2021 at 9:47 PM Max R @.***> wrote:

Hi all, I've been in touch with Tom over at Mutesync (CC) on other matters regarding the app. The hostname is confirmed to be the local computer where the Mutesync app is running. Port TCP/8249 needs to be open inbound, as the app is being polled by HA on that port.

Thanks, Max

On Thu, May 13, 2021 at 4:25 PM Franck Nijhof @.***> wrote:

This is now the 3rd time this comes up, and I am (for real) trying to understand the confusion. How is this different from almost any other integration we have and raised this question?

This is not offensive, I truly am interested in what causes this. For example, we never receive this feedback for AdGuard, Pi-hole, Hue, tradfri, or any other integration that describes this in the same way.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/home-assistant/home-assistant.io/issues/17782#issuecomment-840891372, or unsubscribe https://github.com/notifications/unsubscribe-auth/AEXRQVHOL4JYMBM23HBNSDTTNRNXVANCNFSM44SGJUFQ .

--

With best regards, Max Ranzau / +1 610 462 2200