[web_server] Add documentation for Private Network Access support (#3338)

This commit is contained in:
Daniel Baulig 2023-11-06 16:59:05 -08:00 committed by GitHub
parent e499434bb2
commit 26567a3146
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 0 deletions

View File

@ -56,6 +56,10 @@ Configuration variables:
- **include_internal** (*Optional*, boolean): Whether ``internal`` entities should be displayed on the
web interface. Defaults to ``false``.
- **enable_private_network_access** (*Optional*, boolean): Enables support for
`Private Network Access <https://wicg.github.io/private-network-access>`__ and the
`Private Network Access Permission Prompt <https://wicg.github.io/private-network-access/#permission-prompt>`__.
Defaults to ``true``.
- **log** (*Optional*, boolean): Turn on or off the log feature inside webserver. Defaults to ``true``.
- **ota** (*Optional*, boolean): Turn on or off the OTA feature inside webserver. Strongly not suggested without enabled authentication settings. Defaults to ``true``. Cannot be used with the ``esp-idf`` framework.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.