signal-cli-rest-api icon indicating copy to clipboard operation
signal-cli-rest-api copied to clipboard

Home Assistant documentation needs clarification/more details.

Open SkyLined opened this issue 3 years ago • 5 comments

The problem

The following page and paragraph on it are lacking enough information for the average user to complete them. https://github.com/bbernhard/signal-cli-rest-api/blob/master/doc/HOMEASSISTANT.md

Alternative 2: Install Home Assistant Add-on

Add this repository to your Home Assistant Add-on Store repository list:

https://github.com/haberda/hassio_addons

Then install and start the add-on.

Add this repository to your Home Assistant Add-on Store repository list assumes that users know hot to do that, which is not a given. Step-by-step instructions would be useful, such as:

  • Go to Settings -> Add-ons
  • Click on ADD-ON STORE in the bottom-right corner
  • Click the three vertical dots in the top-right corner
  • Click repositories
  • Copy+paste https://github.com/haberda/hassio_addons into the test field and click ADD

Secondly, Then install and start the add-on. does not tell me which add-on to install. After adding the repository, if I search for "Signal" in the add-ons store, I get no results. Also, it might again be useful to provide a step-by-step guide on how to do this.


The below is irrelevant but added because your form requested it

Are you using the latest released version?

  • [X] Yes

Have you read the troubleshooting page?

  • [X] Yes

What type of installation are you running?

Home Assistant Signal Addon

In which mode are you using the docker container?

Normal Mode

What's the architecture of your host system?

x86-64

Additional information

No response

SkyLined avatar Nov 07 '22 12:11 SkyLined

I'm here because of this issue. I feel I know home assistant reasonably well and I am getting new add-on options after adding the repository. Even after checking for update and restarting HA

Darklyte avatar Nov 17 '22 21:11 Darklyte

Thanks for the feedback! As a developer it is really hard to find the balance between "documenting every tiny step" and "not documenting enough". So in case you have the feeling that something isn't clear and you would like to add something, please feel free to create a pull request. I am always happy for suggestions - and things like that are always highly appreciated!

bbernhard avatar Nov 19 '22 13:11 bbernhard

I'm here because of this issue as well. I feel I know home assistant reasonably well and I am NOT getting new add-on options after adding the repository. Even after checking for update and restarting HA.

Hacksclusive-Quux avatar Dec 06 '22 14:12 Hacksclusive-Quux

@bbernhard I opened this issue because I do not know what to do for the Then install and start the add-on. step. Somebody knowledgeable should create a step-by-step description for that. While they are committing that change, they can add the step-by-step description for the Add this repository to your Home Assistant Add-on Store repository list I provided above, so I don't have to.

SkyLined avatar Dec 07 '22 08:12 SkyLined

I had similar issues. The app is called Signal Messenger. After adding the repository to my Home Assistant instance, I had to wait a few hours for the addon to appear. Restarting and/or manually checking for updates didn't help, just waiting.

Johnson145 avatar Jan 16 '23 21:01 Johnson145