Skip to content

Commit 784383c

Browse files
Update installation.md (#984)
Improved instructions related to secure connection
1 parent 63b29d3 commit 784383c

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

docs/installation.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,15 @@ Installation
2727

2828

2929
### Secure Connection
30-
If using [Let’s Encrypt](https://github.com/home-assistant/addons/tree/master/letsencrypt), [Duck DNS](https://www.home-assistant.io/integrations/duckdns/) or other add-ons that enables HTTPS you can get a secure WWS connection for OCPP. For more information on how to generate keys [see this blog post](https://www.home-assistant.io/blog/2017/09/27/effortless-encryption-with-lets-encrypt-and-duckdns/).
31-
- The option secure connection enables connection thru WSS (HTTPS). With the option disabled the connection will be WS (HTTP).
32-
- If enabled provide pathways to SSL certificate and key files. The pathways will be ignored if secure connection is disabled.
30+
If you are using [Let’s Encrypt](https://github.com/home-assistant/addons/tree/master/letsencrypt), [Duck DNS](https://www.home-assistant.io/integrations/duckdns/) or other add-on that enables secure HTTPS for your Home Assistant instance, you can get a secure WSS connection for OCPP.
31+
To use a secure connection:
32+
- Enable the option _Secure connection_
33+
- Provide the pathways to your HA's SSL certificate and key files. These are typically located in the /config or /ssl folder, and typically named fullchain.pem and privkey.pem respectively.
34+
- If you provide incorrect pathways, the integration will fail to setup with no clear indication of why.
35+
36+
If you do not use HTTPS for your Home Assistant instance:
37+
- Disable the option _Secure connection_
38+
- _Path to SSL certificate/key_ will be ignored.
3339
<img width="576" src="https://user-images.githubusercontent.com/25015949/229125441-210554ee-8edf-4c3f-bb27-02c4634f2c6b.png">
3440

3541

@@ -55,6 +61,7 @@ If using [Let’s Encrypt](https://github.com/home-assistant/addons/tree/master/
5561

5662
- Configure your charger to use the OCPP websocket of your Central System (e.g. ws://homeassistant.local:9000). This is charger specific, so consult your manual.
5763
- Some chargers require the protocol section 'ws://' to be removed, or require the url to end with a '/'.
64+
- If you have configured _Secure connection_ in previous step, you should use 'wss://'
5865
- Some chargers require the url to be specified as an IP address, i.e. '192.168.178.1:9000'
5966
- You may need to reboot your charger before the changes become effective.
6067

0 commit comments

Comments
 (0)