jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-23 09:17:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Html5 push docs (#11549)

Browse Source 
* Improved html5 docs around domain verification.

* Minor change

Co-authored-by: Fabian Affolter <mail@fabian-affolter.ch>
This commit is contained in:
Mark Lopez 2019-12-28 05:05:27 -06:00 committed by Franck Nijhof
parent b5a2b12f3b
commit 0cb2421c2d
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
source/_integrations/html5.markdown
View File

@ -54,15 +54,15 @@ name:
type: string
default: notify
vapid_pub_key:
description: The VAPID public key generated by Google (this is the key that is immediately visible under "webpush certificates").
description: The VAPID public key generated by Google (this is the key that is immediately visible under "webpush certificates"), [see configuring the platform](#configuring_the_platform).
required: true
type: string
vapid_prv_key:
description: The VAPID private key generated by Google.
description: The VAPID private key generated by Google, [see configuring the platform](#configuring_the_platform).
required: true
type: string
vapid_email:
description: The e-mail account associated with your Firebase project.
description: The e-mail account associated with your Firebase project, [see configuring the platform](#configuring_the_platform).
required: true
type: string
gcm_api_key:
@ -80,7 +80,7 @@ gcm_sender_id:
The `html5` platform can only function if all of the following requirements are met:
* You are using Chrome and/or Firefox on any desktop platform, ChromeOS or Android.
* Your Home Assistant instance is accessible from outside your network over HTTPS.
* Your Home Assistant instance is accessible from outside your network over HTTPS or can perform an alternative [Domain Name Verification Method](https://support.google.com/webmasters/answer/9008080#domain_name_verification) on the domain used by Home Assistant.
* If using a proxy, HTTP basic authentication must be off for registering or unregistering for push notifications. It can be re-enabled afterwards.
* If you don't run Hass.io: `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).
* You have configured SSL/TLS for your Home Assistant. It doesn't need to be configured in Home Assistant though, e.g., 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).
@ -88,8 +88,8 @@ The `html5` platform can only function if all of the following requirements are
### Configuring the platform
1. Make sure you can access your Home Assistant installation from outside your network over HTTPS ([see docs](/docs/configuration/remote/)).
2. Create a new project at [https://console.cloud.google.com/home/dashboard](https://console.cloud.google.com/home/dashboard).
1. Make sure you can access your Home Assistant installation from outside your network over HTTPS ([see docs](/docs/configuration/remote/)) or can perform an alternative [Domain Name Verification Method](https://support.google.com/webmasters/answer/9008080#domain_name_verification) on the domain used by Home Assistant.
2. Create a new project at [https://console.cloud.google.com/home/dashboard](https://console.cloud.google.com/home/dashboard), this project will be imported into Firebase later (alternatively, the project can also be created during step 4).
3. Go to [https://console.cloud.google.com/apis/credentials/domainverification](https://console.cloud.google.com/apis/credentials/domainverification) and verify your domain via Google Webmaster Central / Search Console - [see below](#verify-your-domain).
4. With the domain verified, go to [https://console.firebase.google.com](https://console.firebase.google.com), select import Google project and select the project you created.
5. Then, click the cogwheel on top left and select "Project settings".