Home Assistant Add-on: NGINX Home Assistant SSL proxy
Follow these steps to get the add-on installed on your system:
- Navigate in your Home Assistant frontend to Supervisor -> Add-on Store.
- Find the "NGINX Home Assistant SSL proxy" add-on and click it.
- Click on the "INSTALL" button.
How to use
The NGINX Proxy add-on is commonly used in conjunction with the Duck DNS add-on to set up secure remote access to your Home Assistant instance. The following instructions covers this scenario.
- The certificate to your registered domain should already be created via the Duck DNS add-on or another method. Make sure that the certificate files exist in the
- In the
configuration.yamlfile, some options in the
http:section are no longer necessary for this scenario, and should be commented out or removed:
- And you need to add the
trusted_proxiessection (requests from reverse proxies will be blocked if these options are not set).
http: use_x_forwarded_for: true trusted_proxies: - 172.30.33.0/24
- In the nginx addon configuration, change the
domainoption to the domain name you registered (from DuckDNS or any other domain you control).
- Leave all other options as-is.
- Save configuration.
- Start the add-on.
- Have some patience and wait a couple of minutes.
- Check the add-on log output to see the result.
domain: home.example.com certfile: fullchain.pem keyfile: privkey.pem hsts: "max-age=31536000; includeSubDomains" customize: active: false default: "nginx_proxy_default*.conf" servers: "nginx_proxy/*.conf" cloudflare: false
The domain name to use for the proxy.
The certificate file to use in the
/ssl directory. Keep filename as-is if you used default settings to create the certificate with the Duck DNS add-on.
Private key file to use in the
Value for the
Strict-Transport-Security HTTP header to send. If empty, the header is not sent.
If true, additional NGINX configuration files for the default server and additional servers are read from files in the
/share directory specified by the
The filename of the NGINX configuration for the default server, found in the
The filename(s) of the NGINX configuration for the additional servers, found in the
If enabled, configure Nginx with a list of IP addresses directly from Cloudflare that will be used for
set_real_ip_from directive Nginx config.
This is so the
ip_ban_enabled feature can be used and work correctly in /config/customize.yaml.
Known issues and limitations
- By default, port 80 is disabled in the add-on configuration in case the port is needed for other components or add-ons like
You have several options to get them answered:
- The Home Assistant Discord Chat Server.
- The Home Assistant Community Forum.
- Join the Reddit subreddit in /r/homeassistant
In case you've found a bug, please open an issue on our GitHub.