HTTP


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.

It is HIGHLY recommended that you set the api_password, especially if you are planning to expose your installation to the internet.

Don’t use option server_host on a Hass.io installation!

# Example configuration.yaml entry
http:
  api_password: YOUR_PASSWORD

Configuration variables:

Configuration Variables

api_password

(string)(Optional)Protect Home Assistant with a password.

server_host

(string)(Optional)Only listen to incoming requests on specific IP/host (default: bind to 0.0.0.0 which means accept all IPv4 connections). Use server_host: "::0" if you want to listen to (and only) IPv6.

server_port

(integer)(Optional)Let you set a port to use.

Default value: 8123

base_url

(string)(Optional)The URL that Home Assistant is available on the internet. For example: hass-example.duckdns.org:8123. Defaults to the local IP address. The iOS app finds local installations, if you have an outside URL use this so that you can auto-fill when discovered in the app.

Default value: The local IP address

ssl_certificate

(string)(Optional)Path to your TLS/SSL certificate to serve Home Assistant over a secure connection.

ssl_peer_certificate

(string)(Optional)Path to the client/peer TLS/SSL certificate to accept secure connections from.

ssl_key

(string)(Optional)Path to your TLS/SSL key to serve Home Assistant over a secure connection.

cors_allowed_origins

(string | list)(Optional)A list of origin domain names to allow CORS requests from. Enabling this will set the Access-Control-Allow-Origin header to the Origin header if it is found in the list, and the Access-Control-Allow-Headers header to Origin, Accept, X-Requested-With, Content-type, X-HA-access. You must provide the exact Origin, i.e. https://www.home-assistant.io will allow requests from https://www.home-assistant.io but not http://www.home-assistant.io.

trusted_proxies

(string | list)(Optional)List of trusted proxies, consisting of IP addresses or networks, that are allowed to set the X-Forwarded-For header. This is required when using use_x_forwarded_for because all requests to Home Assistant, regardless of source, will arrive from the reverse proxy IP address. Therefore in a reverse proxy scenario, this option should be set with extreme care.

use_x_forwarded_for

(boolean)(Optional)Enable parsing of the X-Forwarded-For header, passing on the client’s correct IP address in proxied setups. You must also whitelist trusted proxies using the trusted_proxies setting above for this to work. Non-whitelisted requests with this header will be considered IP spoofing attacks, and the header will, therefore, be ignored.

Default value: false

trusted_networks

(string | list)(Optional)List of trusted networks, consisting of IP addresses or networks, that are allowed to bypass password protection when accessing Home Assistant. If using a reverse proxy with the use_x_forwarded_for and trusted_proxies options enabled, requests proxied to Home Assistant with a trusted X-Forwarded-For header will appear to come from the IP given in that header instead of the proxy IP.

ip_ban_enabled

(boolean)(Optional)Flag indicating whether additional IP filtering is enabled.

Default value: false

login_attempts_threshold

(integer)(Optional)Number of failed login attempt from single IP after which it will be automatically banned if ip_ban_enabled is True. When set to -1 no new automatic bans will be added.

Default value: -1

ssl_profile

(string)(Optional)The Mozilla SSL profile to use. Only lower if you are experiencing integrations causing SSL handshake errors.

Default value: modern

The sample below shows a configuration entry with possible values:

# Example configuration.yaml entry
http:
  api_password: YOUR_PASSWORD
  server_port: 12345
  ssl_certificate: /etc/letsencrypt/live/hass.example.com/fullchain.pem
  ssl_key: /etc/letsencrypt/live/hass.example.com/privkey.pem
  cors_allowed_origins:
    - https://google.com
    - https://www.home-assistant.io
  use_x_forwarded_for: True
  trusted_proxies:
    - 127.0.0.1
    - ::1
  trusted_networks:
    - 127.0.0.1
    - ::1
    - 192.168.0.0/24
    - fd00::/8
  ip_ban_enabled: True
  login_attempts_threshold: 5

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.

Or use a self signed certificate following the instructions here Self-signed certificate for SSL/TLS.

APIs

On top of the http component is a REST API, Python API and WebSocket API available. There is also support for Server-sent events.

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.

HTTP sensors

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.

IP filtering and banning

If you want to apply additional IP filtering, and automatically ban brute force attempts, set ip_ban_enabled to True and the maximum number of attempts. After the first ban, an ip_bans.yaml file will be created in the root configuration folder. It will have the banned IP address and time in UTC when it was added:

127.0.0.1:
  banned_at: '2016-11-16T19:20:03'

After a ban is added a Persistent Notification is populated to the Home Assistant frontend.

Please note, that sources from trusted_networks won’t be banned automatically.

Hosting files

If you want to use Home Assistant to host or serve static files then create a directory called www under the configuration path (/config on Hass.io, .homeassistant elsewhere). The static files in www/ can be accessed by the following URL http://your.domain:8123/local/, for example audio.mp3 would be accessed as http://your.domain:8123/local/audio.mp3.

If you’ve had to create the www/ folder for the first time, you’ll need to restart Home Assistant.