Using NGINX as a proxy for Home Assistant allows you to serve Home Assistant securely over standard ports. This configuration file and instructions will walk you through setting up Home Assistant over a secure connection.
Chances are, you have a dynamic IP Address (your ISP changes your address periodically). If this is true, you can use a Dynamic DNS service to obtain a domain and set it up to update with you IP. If you purchase your own domain name, you will be able to easily get a trusted SSL certificate later.
+Chances are, you have a dynamic IP address (your ISP changes your address periodically). If this is true, you can use a Dynamic DNS service to obtain a domain and set it up to update with you IP. If you purchase your own domain name, you will be able to easily get a trusted SSL certificate later.
This will vary depending on your OS. Check out Google for this. After installing, ensure that NGINX is not running.
++You will at least need nginx >= 1.3.13, as WebSocket support is required for the reverse proxy. +
There are two ways of obtaining an SSL certificate.
If you purchased your own domain, you can use https://letsencrypt.org/ to obtain a free, publicly trusted SSL certificate. This will allow you to work with services like IFTTT. Download and install per the instructions online and get a certificate using the following command.
-$ sudo ./letsencrypt-auto certonly --standalone -d example.com -d www.example.com
+$ sudo ./letsencrypt-auto certonly --standalone -d example.com -d www.example.com
Instead of example.com, use your domain. You will need to renew this certificate every 90 days.
@@ -119,7 +122,7 @@ Some Linux distributions (including CentOS and Fedora) will not have the 8. Port forwarding.
Forward ports 443 and 80 to your server on your router. Do not forward port 8123.
NGINX Config
-map $http_upgrade $connection_upgrade {
+map $http_upgrade $connection_upgrade {
default upgrade;
'' close;
}
diff --git a/docs/installation/docker/index.html b/docs/installation/docker/index.html
index 170b9a6113..531f92f29c 100644
--- a/docs/installation/docker/index.html
+++ b/docs/installation/docker/index.html
@@ -81,11 +81,12 @@
macOS
-When using boot2docker on macOS you are unable to map the local time to your Docker container. Use -e "TZ=America/Los_Angeles" instead of -v /etc/localtime:/etc/localtime:ro. Replace “America/Los_Angeles” with your timezone.
-Additionally, if your expectation is that you will be able to browse directly to http://localhost:8123 on your macOS host, then you will also need to replace the --net=host switch with -p 8123:8123. This is currently the only way to forward ports on to your actual host (macOS) machine instead of the virtual machine inside xhyve. More detail on this can be found in the docker forums.
+When using docker-ce (or boot2docker) on macOS, you are unable to map the local timezone to your Docker container (see Docker issue https://github.com/docker/for-mac/issues/44). Instead of -v /etc/localtime:/etc/localtime:ro, just pass in the timezone environment variable when you launch the container, ex: -e "TZ=America/Los_Angeles". Replace “America/Los_Angeles” with your timezone.
+If you wish to browse directly to http://localhost:8123 from your macOS host, meaning forward ports directly to the container, replace the --net=host switch with -p 8123:8123. More detail can be found in the docker forums.
$ docker run -d --name="home-assistant" -v /path/to/your/config:/config -e "TZ=America/Los_Angeles" -p 8123:8123 homeassistant/home-assistant
+Alternatively, docker-compose works with any recent release of docker-ce on macOS. Note that (further down this page) we provide an example docker-compose.yml however it differs from the docker run example above. To make the .yml directives match, you would need to make two changes: first add the equivalent ports: directive, then remove the network_mode: host section. This is because Port mapping is incompatible with network_mode: host:. More details can be found at [Docker networking docs] (https://docs.docker.com/engine/userguide/networking/#default-networks). Note also the /dev/tty* device name used by your Arduino etc. devices will differ from the Linux example, so the compose mount: may require updates.
Windows
When running Home Assistant in Docker on Windows, you may have some difficulty getting ports to map for routing (since the --net=host switch actually applies to the hypervisor’s network interface). To get around this, you will need to add port proxy ipv4 rules to your local Windows machine, like so (Replacing ‘192.168.1.10’ with whatever your Windows IP is, and ‘10.0.50.2’ with whatever your Docker container’s IP is):
netsh interface portproxy add v4tov4 listenaddress=192.168.1.10 listenport=8123 connectaddress=10.0.50.2 connectport=8123
diff --git a/docs/mqtt/discovery/index.html b/docs/mqtt/discovery/index.html
index 5c8143e428..74c3436b26 100644
--- a/docs/mqtt/discovery/index.html
+++ b/docs/mqtt/discovery/index.html
@@ -104,7 +104,7 @@
<component>: One of the supported components, eg. binary_sensor.<node_id>: (Optional) id of the node providing the topic.<object_id>: The ID of the device. This will become the entity_id in Home Assistant.<object_id>: “The ID of the device. This is only to allow for separate topics for each device and is not used for the entity_id.”<>: The topic config or state which defines the current action.
The payload will be checked like an entry in your configuration.yaml file if a new device is added. This means that missing variables will be filled with the platform’s default values. All configuration variables which are required must be present in the initial payload send to /config.
diff --git a/docs/z-wave/installation/index.html b/docs/z-wave/installation/index.html
index 4ec764a7d4..06feac952b 100644
--- a/docs/z-wave/installation/index.html
+++ b/docs/z-wave/installation/index.html
@@ -94,7 +94,7 @@
Configuration
# Example configuration.yaml entry
zwave:
- usb_path: /dev/ttyUSB0
+ usb_path: /dev/ttyACM0
diff --git a/hassio/installing_third_party_addons/index.html b/hassio/installing_third_party_addons/index.html
index b7df297444..60e27bc355 100644
--- a/hassio/installing_third_party_addons/index.html
+++ b/hassio/installing_third_party_addons/index.html
@@ -91,7 +91,7 @@ From the Hass.io main panel open the add-on store.
Add the URL of the repository and then press “Add”. A new card for the repository will appear.
Help: Repository is not showing up
-If you have added a repository, but it’s not showing up, it means that the repository contains invalid configuration. Go to the Hass.io panel -> Three dot menu -> Advanced Settings -> Supervisor card -> View logs and scroll to the bottom. It should tell you what went wrong. Report this information to the repository author.
+If you have added a repository, but it’s not showing up, it means that the repository contains invalid configuration. Go to the Hass.io panel and then the System tab to find the System log. It should tell you what went wrong. Report this information to the repository author.