140 lines
5.0 KiB
ReStructuredText
140 lines
5.0 KiB
ReStructuredText
Web Server Component
|
|
====================
|
|
|
|
.. seo::
|
|
:description: Instructions for setting up a web server in ESPHome.
|
|
:image: http.svg
|
|
:keywords: web server, http, REST API
|
|
|
|
The ``web_server`` component creates a simple web server on the node that can be accessed
|
|
through any browser and a simple `REST API`_. Please note that enabling this component
|
|
will take up *a lot* of memory and can lead to problems, especially on the ESP8266.
|
|
|
|
To navigate to the web server in your browser, either use the IP address of the node or
|
|
use ``<node_name>.local/`` (note the trailing forward slash) via mDNS.
|
|
|
|
To conserve flash size, the CSS and JS files used on the root page to show a simple user
|
|
interface are hosted by esphome.io. If you want to use your own service, use the
|
|
``css_url`` and ``js_url`` options in your configuration.
|
|
|
|
.. _REST API: /web-api/index.html
|
|
|
|
.. figure:: /components/images/web_server.png
|
|
|
|
Example web server frontend (Version 1)
|
|
|
|
Version 2:
|
|
----------
|
|
.. figure:: /components/images/web_server-v2.png
|
|
|
|
Web Components (Version 2)
|
|
|
|
.. code-block:: yaml
|
|
|
|
# Example configuration entry
|
|
web_server:
|
|
port: 80
|
|
|
|
|
|
Configuration variables:
|
|
------------------------
|
|
|
|
- **port** (*Optional*, int): The port the web server should open its socket on.
|
|
- **css_url** (*Optional*, url): The URL that should be used for the CSS stylesheet. Defaults
|
|
to https://esphome.io/_static/webserver-v1.min.css (updates will go to ``v2``, ``v3``, etc). Can be set to empty string.
|
|
- **css_include** (*Optional*, local file): Path to local file to be included in web server index page.
|
|
Contents of this file will be served as ``/0.css`` and used as CSS stylesheet by internal webserver.
|
|
Useful when building device without internet access, where you want to use built-in AP and webserver.
|
|
- **js_url** (*Optional*, url): The URL that should be used for the JS script. Defaults
|
|
to https://esphome.io/_static/webserver-v1.min.js. Can be set to empty string.
|
|
- **js_include** (*Optional*, local file): Path to local file to be included in web server index page.
|
|
Contents of this file will be served as ``/0.js`` and used as JS script by internal webserver.
|
|
Useful when building device without internet access, where you want to use built-in AP and webserver.
|
|
- **auth** (*Optional*): Enables basic authentication with username and password.
|
|
|
|
- **username** (**Required**, string): The username to use for authentication.
|
|
- **password** (**Required**, string): The password to check for authentication.
|
|
|
|
- **include_internal** (*Optional*, boolean): Whether ``internal`` entities should be displayed on the
|
|
web interface. Defaults to ``false``.
|
|
- **ota** (*Optional*, boolean): Turn on or off the OTA feature inside webserver. Strongly not suggested without enabled authentication settings. Defaults to ``true``.
|
|
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
|
|
- **version** (*Optional*, string): 1 or 2. Version 1 displays as a table. Version 2 uses web components and has more functionality. Default: `2`
|
|
|
|
.. note::
|
|
|
|
Example web_server configuration using HTTP authentication:
|
|
|
|
.. code-block:: yaml
|
|
|
|
# Example configuration entry
|
|
web_server:
|
|
port: 80
|
|
auth:
|
|
username: admin
|
|
password: !secret web_server_password
|
|
|
|
Example web_server configuration using version 1 (previous behaviour):
|
|
|
|
.. code-block:: yaml
|
|
|
|
# Example configuration entry
|
|
web_server:
|
|
port: 80
|
|
version: 1
|
|
|
|
Example web_server configuration using version 2 - no internet/intranet required:
|
|
|
|
.. code-block:: yaml
|
|
|
|
# Example configuration entry
|
|
web_server:
|
|
local: true
|
|
|
|
|
|
|
|
All of the assets are inlined, compressed and served from flash
|
|
|
|
Here be Dragons
|
|
===============
|
|
|
|
The following assume copies of the files with local paths - which are config dependant.
|
|
|
|
Example web_server version 1 configuration with CSS and JS included from esphome-docs.
|
|
CSS and JS URL's are set to empty value, so no internet access is needed for this device to show it's web interface.
|
|
Force to turn off OTA function because the missing authentication.
|
|
|
|
.. code-block:: yaml
|
|
|
|
# Example configuration entry V1
|
|
web_server:
|
|
port: 80
|
|
ota: false
|
|
css_include: "../../../esphome-docs/_static/webserver-v1.min.css"
|
|
js_include: "../../../esphome-docs/_static/webserver-v1.min.js"
|
|
js_url: ""
|
|
|
|
Example web_server version 2 configuration with JS included from a local file.
|
|
|
|
CSS and JS URL's are set to empty value, so no internet access is needed for this device to show it's web interface.
|
|
V2 embeds the css within the js file so is not required, however you could include your own CSS.
|
|
|
|
.. code-block:: yaml
|
|
|
|
# Example configuration entry V2
|
|
web_server:
|
|
js_include: "./v2/www.js"
|
|
js_url: ""
|
|
version: 2
|
|
|
|
|
|
Copy https://oi.esphome.io/v2/www.js to a V2 folder in your yaml folder.
|
|
|
|
|
|
See Also
|
|
--------
|
|
|
|
- :apiref:`web_server/web_server.h`
|
|
- :doc:`prometheus`
|
|
- :ghedit:`Edit`
|