Skip to content

Commit 8e4f61c

Browse files
committed
📚 Updates the README to reflect the latest changes
1 parent 5c561ce commit 8e4f61c

File tree

1 file changed

+39
-4
lines changed

1 file changed

+39
-4
lines changed

README.md

Lines changed: 39 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,11 +38,15 @@ comparison to installing any other Hass.io add-on.
3838
1. [Add our Hass.io add-ons repository][repository] to your Hass.io instance.
3939
1. Install the "Node-RED" add-on.
4040
1. Set a `credential_secret`, which is used to encrypt sensitive data.
41-
1. Configure usernames & passwords.
42-
1. If you have SSL, set the `ssl` option to true.
41+
This is just a "password", which you should save on a secondary location.
42+
1. If you do NOT use SSL, be sure to set the `ssl` option to `false`.
4343
1. Start the "Node-RED" add-on.
4444
1. Check the logs of "Node-RED" to see if everything went well.
45-
1. Login with your Home Assistant username/password.
45+
1. Log in with your Home Assistant username/password.
46+
1. The add-on works straight out the box! No need to configure a server!
47+
48+
**Note**: The add-on is **pre-configured** out of the box! There is no need
49+
to add/change/update the server connection settings!
4650

4751
Please read the rest of this document further instructions.
4852

@@ -158,7 +162,9 @@ to HTTPS. This is recommended when you have SSL enabled.
158162
### Option: `credential_secret`
159163

160164
Credentials are encrypted by Node-RED in storage, using secret key.
161-
This option allows you to specify your secret key.
165+
This option allows you to specify your secret key. This can be anything
166+
you like, it is just like a password. Be sure to store it somewhere safe.
167+
You might need it in the future! (e.g., When restoring a backup).
162168

163169
**Note**: _Once you set this property, do not change it - doing so will prevent
164170
Node-RED from being able to decrypt your existing credentials and they will be
@@ -243,6 +249,35 @@ panel_iframe:
243249
url: http://addres.to.your.hass.io:1880
244250
```
245251
252+
## FAQ
253+
254+
### Node-RED could not establish connection
255+
256+
So, this is like the most asked question. It involves messages in the error
257+
logs that look like this:
258+
259+
```text
260+
Home assistant connection failed with error: Connection to home assistant could
261+
not be established with config: http://XXXXX.duckdns.org <password redacted>
262+
```
263+
264+
The solution to this is simple:
265+
266+
- Click on one of the Home Assistant nodes in your flow.
267+
- Click on the little edit button, next to the server name.
268+
- Change the URL to: `http://hassio/homeassistant`.
269+
- Save it, and deploy your flow!
270+
- Now the add-on handles the authentication for you.
271+
272+
### The configured certfile is not found
273+
274+
This error is shown when you have enabled `ssl` in the add-on option,
275+
but the SSL certificate files are not found on disk.
276+
277+
Either correct the `certfile` in case you are using SSL, get an SSL certificate
278+
(which you actually should) OR disable the `ssl` feature by setting the
279+
configuration option to `false`.
280+
246281
## Changelog & Releases
247282

248283
This repository keeps a change log using [GitHub's releases][releases]

0 commit comments

Comments
 (0)