2.3 KiB
layout, title, description, date, sidebar, comments, sharing, footer, logo, ha_category
| layout | title | description | date | sidebar | comments | sharing | footer | logo | ha_category |
|---|---|---|---|---|---|---|---|---|---|
| page | HTTP | Offers a web framework to serve files. | 2015-12-06 21:35 | true | false | true | true | http.png | Other |
The http component serves all files and data required for the Home Assistant frontend. You only need to add this to your configuration file if you want to change any of the default settings.
# Example configuration.yaml entry
http:
api_password: YOUR_PASSWORD
server_port: 12345
development: 1
ssl_certificate: /etc/letsencrypt/live/hass.example.com/fullchain.pem
ssl_key: /etc/letsencrypt/live/hass.example.com/privkey.pem
Configuration variables:
- api_password (Optional): Protect Home Assistant with a password.
- server_port (Optional): Let you set a port to use. Defaults to 8123.
- development (Optional): Disable caching and load unvulcanized assets. Useful for Frontend development.
- ssl_certificate (Optional): Path to your TLS/SSL certificate to serve Home Assistant over a secure connection.
- ssl_key (Optional): Path to your TLS/SSL key to serve Home Assistant over a secure connection.
The Set up encryption using Let's Encrypt blog post gives you details about the encryption of your traffic using free certificates from Let's Encrypt.
On top of the http component is a REST API and a Python API available. There is also support for Server-sent events available.
The http platforms are not real platforms within the meaning of the terminology used around Home Assistant. Home Assistant's REST API sends and receives messages over HTTP.
To use those kind of sensors or binary sensors in your installation no configuration in Home Assistant is needed. All configuration is done on the devices themselves. This means that you must be able to edit the target URL or endpoint and the payload. The entity will be created after the first message has arrived.
All requests need to be sent to the endpoint of the device and must be POST.