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-21 08:16:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

Config flow documentation for html5 (#31805)

Browse Source 
* html5: Config flow documentation

* Add config flow link

* Tiny tweak

---------

Co-authored-by: alexyao2015 <alexyao2015@users.noreply.github.com>
Co-authored-by: Franck Nijhof <frenck@frenck.nl>
This commit is contained in:
Alex Yao 2024-08-31 03:02:54 -05:00 committed by GitHub
parent 32694b473a
commit 636c186bf7
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 2 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
source/_integrations/html5.markdown
View File

@ -4,6 +4,7 @@ description: Instructions on how to use the HTML5 push notifications platform fr
ha_category:
- Notifications
ha_release: 0.27
ha_config_flow: true
ha_iot_class: Cloud Push
ha_domain: html5
ha_platforms:
@ -20,35 +21,6 @@ The `html5` notification {% term integration %} enables you to receive push noti
HTML5 push notifications **do not** work on iOS versions below 16.4.
{% endimportant %}
## Configuration
To enable this platform, add the following lines to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry
notify:
- platform: html5
vapid_pub_key: YOUR_PUBLIC_KEY
vapid_prv_key: YOUR_PRIVATE_KEY
vapid_email: YOUR_EMAIL
```
{% configuration %}
vapid_pub_key:
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, [see configuring the platform](#configuring-the-platform).
required: true
type: string
vapid_email:
description: The email account of your Google account associated with your Firebase project, [see configuring the platform](#configuring-the-platform).
required: true
type: string
{% endconfiguration %}
### Requirements
The `html5` platform can only function if all of the following requirements are met:
@ -60,15 +32,8 @@ The `html5` platform can only function if all of the following requirements are
- 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 in front of Home Assistant and this will still work. The certificate must be trustworthy (i.e., not self-signed).
- You are willing to accept the notification permission in your browser.
### Configuring the platform
1. 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 in the next step).
2. Go to [https://console.firebase.google.com](https://console.firebase.google.com), and click the "Add project" button
3. Choose your Google Cloud project for the name field (or create a new one). Decline analytics.
4. Then, click the cogwheel on top left and select "Project settings".
5. Select the "Cloud Messaging" tab.
6. Generate a new key pair in "Web configuration" at the bottom of the page. Add the public key as `vapid_pub_key` in the config, then choose the 3 dots, and copy the private key for `vapid_prv_key` in the config.
7. Input your Google email as `vapid_email` in the config.
{% include integrations/config_flow.md %}
### Setting up your browser