Skip to content

Commit ef2e982

Browse files
nordlead2005fabaff
authored andcommitted
HTML5 notification install and usage clarification (home-assistant#1758)
Added additional requirements and clarification to getting HTML 5 push notifications working. These were stumbling blocks for me and some of the information I gathered in the forums, some I just guessed at.
1 parent 256deaf commit ef2e982

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

source/_components/notify.html5.markdown

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,9 @@ The `html5` platform can only function if all of the following requirements are
4646

4747
* You are using Chrome and/or Firefox on any desktop platform, ChromeOS or Android.
4848
* Your Home Assistant instance is exposed to the world.
49-
* You have configured SSL for your Home Assistant. It doesn't need to be configured in Home Assistant though, i.e. you can be running nginx in front of Home Assistant and this will still work.
49+
* If using a proxy, basic auth must be off for registering or unregistering for push notifications. It can be re-enabled afterwards.
50+
* pywebpush must be installed. libffi-dev, libpython-dev, and libssl-dev must be installed prior to pywebpush (i.e. pywebpush probably won't automatically install).
51+
* You have configured SSL for your Home Assistant. It doesn't need to be configured in Home Assistant though, i.e. you can be running nginx in front of Home Assistant and this will still work. The certificate must be trustworthy (i.e. not self signed)
5052
* You are willing to accept the notification permission in your browser.
5153

5254
### {% linkable_title Setting up %}
@@ -64,6 +66,8 @@ Assuming you have already added the platform to your configuration:
6466

6567
The `html5` platform accepts a standard notify payload. However, there are also some special features built in which you can control in the payload.
6668

69+
Any json examples below can be [converted to YAML](https://www.json2yaml.com/) for automations.
70+
6771
#### {% linkable_title Actions %}
6872

6973
Chrome supports notification actions, which are configurable buttons that arrive with the notification and can cause actions on Home Assistant to happen when pressed. You can send [up to 2 actions](https://cs.chromium.org/chromium/src/third_party/WebKit/public/platform/modules/notifications/WebNotificationConstants.h?q=maxActions&sq=package:chromium&dr=CSs&l=14).

0 commit comments

Comments
 (0)