Skip to content

Update installation.md #984

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 26, 2023
Merged

Update installation.md #984

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions docs/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,15 @@ Installation


### Secure Connection
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/).
- The option secure connection enables connection thru WSS (HTTPS). With the option disabled the connection will be WS (HTTP).
- If enabled provide pathways to SSL certificate and key files. The pathways will be ignored if secure connection is disabled.
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.
To use a secure connection:
- Enable the option _Secure connection_
- 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.
- If you provide incorrect pathways, the integration will fail to setup with no clear indication of why.

If you do not use HTTPS for your Home Assistant instance:
- Disable the option _Secure connection_
- _Path to SSL certificate/key_ will be ignored.
<img width="576" src="https://user-images.githubusercontent.com/25015949/229125441-210554ee-8edf-4c3f-bb27-02c4634f2c6b.png">


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

- 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.
- Some chargers require the protocol section 'ws://' to be removed, or require the url to end with a '/'.
- If you have configured _Secure connection_ in previous step, you should use 'wss://'
- Some chargers require the url to be specified as an IP address, i.e. '192.168.178.1:9000'
- You may need to reboot your charger before the changes become effective.

Expand Down