NGINX Home Assistant SSL proxy for Home Assistant (app)

About

NGINX Home Assistant SSL proxy is an app that runs an SSL/TLS proxy in front of Home Assistant. It is commonly paired with the Duck DNS or Let's Encrypt apps to provide secure remote access, using certificate and key files stored in the SSL directory. Options cover the domain name, an optional Strict-Transport-Security header, and extra NGINX configuration files for the default server and additional servers read from the share directory. It can also load Cloudflare IP addresses so IP banning works correctly, connect to the backend over SSL, and read the real client address through Proxy Protocol from an upstream load balancer. HTTP/3 over QUIC can be enabled on a chosen UDP port alongside HTTP/2 and HTTP/1.1. It requires Home Assistant OS, runs on aarch64 and amd64, and has no sidebar page.

Automatic summary of the docs and configuration of home-assistant/apps. Something wrong, or are you the maintainer and want your own text here? Get in touch

Supports

Updated with Home Assistant Ships and updates with every Home Assistant release.

Setting it up

Install it under Settings, Apps, then start it.

Permissions

Supervisor APICan talk to the Supervisor, which manages apps and the system.

Network

443/tcpHTTPS (SSL) Port

Configuration

DomainThe domain name to use for the proxy.
HSTSValue for the HSTS HTTP header to send. If empty, the header is not sent.
Certificate FileThe certificate file to use in the /ssl directory.
Private Key FilePrivate Private Key File to use in the /ssl directory.
CloudFlareIf enabled, configure Nginx with a list of IP addresses directly from Cloudflare that will be used for set_real_ip_from directive Nginx config.
Use SSL BackendIf enabled, configure Nginx to use SSL to connect to backend.
Max body size (in MB)Configures Nginx to limit the maximum allowed size of the client request body, specified in megabytes. Set to 0 to allow requests of any size.
CustomizeSee the Documentation tab for more information about these options.
Real IP from (enables PROXY protocol)Configures Nginx to use TCP Proxy Protocol, specifies what IP to trust TLS upstream requests from.