Skip to content

Commit 92e9877

Browse files
ajfriesenfabaff
authored andcommitted
Add Information to Push Notifications component (home-assistant#3502)
* Changed to ordered list. * Add information for HASSIO domain verifying HASSIO Users need to place the domain verification file from google to a specific location. Add information about the "www" directory and how to open it in he browser.
1 parent 35cdff0 commit 92e9877

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

source/_components/notify.html5.markdown

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,24 +33,33 @@ Configuration variables:
3333

3434
### {% linkable_title Getting ready for Chrome %}
3535

36-
- Create new project at [https://console.cloud.google.com/home/dashboard](https://console.cloud.google.com/home/dashboard).
37-
- Go to [https://console.cloud.google.com/apis/credentials/domainverification](https://console.cloud.google.com/apis/credentials/domainverification) and verify your domain.
38-
- After that, go to [https://console.firebase.google.com](https://console.firebase.google.com) and select import Google project, select the project you created.
39-
- Then, click the cogwheel on top left and select "Project settings".
40-
- Select 'Cloud Messaging' tab, listed beneath Project Credentials will be your 152 character 'Server Key' and 12 digit ID 'Sender ID'.
36+
1. Create new project at [https://console.cloud.google.com/home/dashboard](https://console.cloud.google.com/home/dashboard).
37+
2. Go to [https://console.cloud.google.com/apis/credentials/domainverification](https://console.cloud.google.com/apis/credentials/domainverification) and verify your domain.
38+
3. After that, go to [https://console.firebase.google.com](https://console.firebase.google.com) and select import Google project, select the project you created.
39+
4. Then, click the cogwheel on top left and select "Project settings".
40+
5. Select 'Cloud Messaging' tab, listed beneath Project Credentials will be your 152 character 'Server Key' and 12 digit ID 'Sender ID'.
41+
42+
#### {% linkable_title Verify your domain with Hass.io %}
43+
44+
1. For verifying your domain you need to download a file in step 2.
45+
2. Create a dictionary named "www" in you Hass.io configuration dictionary.
46+
3. Place the file (something like this: google*.html) in the "www" directory.
47+
4. You can open it by going to **https://yourdomain/local/exact_file_name.html**
48+
5. Proceed with step 3.
4149

4250
### {% linkable_title Requirements %}
4351

4452
The `html5` platform can only function if all of the following requirements are met:
4553
(On Hass.io these requirements are already met.)
4654

47-
* You are using Chrome and/or Firefox on any desktop platform, ChromeOS, or Android.
55+
* You are using Chrome and/or Firefox on any desktop platform, ChromeOS or Android.
4856
* Your Home Assistant instance is exposed to the world.
4957
* If using a proxy, HTTP basic authentication must be off for registering or unregistering for push notifications. It can be re-enabled afterwards.
5058
* `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).
5159
* 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](/ecosystem/nginx/) in front of Home Assistant and this will still work. The certificate must be trustworthy (i.e. not self signed).
5260
* You are willing to accept the notification permission in your browser.
5361

62+
5463
### {% linkable_title Setting up %}
5564

5665
Assuming you have already added the platform to your configuration:
@@ -62,6 +71,7 @@ Assuming you have already added the platform to your configuration:
6271
5. Assuming you accept, that's all there is to it!
6372
6. (Optional, but highly recommended!) Open the `html5_push_registrations.conf` file in your configuration directory. You will see a new entry for the browser you just added. Rename it from `unnamed device` to a name of your choice, which will make it easier to identify later. _Do not change anything else in this file!_ You need to restart Home Assistant after making any changes to the file.
6473

74+
6575
### {% linkable_title Usage %}
6676

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

0 commit comments

Comments
 (0)