mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-08 12:08:58 +00:00
121 lines
3.7 KiB
Markdown
121 lines
3.7 KiB
Markdown
---
|
|
layout: page
|
|
title: "NGINX Configuration"
|
|
description: "Configure Nginx to work with Home Assistant as a subdomain"
|
|
date: 2016-06-20 13:05
|
|
sidebar: true
|
|
comments: false
|
|
sharing: true
|
|
footer: true
|
|
---
|
|
|
|
This example demonstrates how you can configure NGINX to act as a proxy for Home Assistant.
|
|
|
|
This is useful if you want to have:
|
|
|
|
* a subdomain redirecting to your Home Assistant instance
|
|
* several subdomain for several instance
|
|
* HTTPS redirection
|
|
|
|
#### {% linkable_title Subdomain %}
|
|
|
|
So you already have a working NGINX server available at example.org. Your Home Assistant is correctly working on this web server and available at http://localhost:8123
|
|
|
|
To be able to access to your Home Assistant instance by using https://home.example.org, create file `/etc/nginx/sites-enabled/homeassistant` (or symlink via `/etc/nginx/sites-available`) and add the following:
|
|
|
|
```nginx
|
|
server {
|
|
listen 443 ssl;
|
|
server_name home.example.org;
|
|
|
|
ssl on;
|
|
ssl_certificate /etc/nginx/ssl/home.example.org/home.example.org-bundle.crt;
|
|
ssl_certificate_key /etc/nginx/ssl/home.example.org/home.example.org.key;
|
|
ssl_prefer_server_ciphers on;
|
|
|
|
location / {
|
|
proxy_pass http://localhost:8123/;
|
|
proxy_set_header Host $host;
|
|
|
|
proxy_http_version 1.1;
|
|
proxy_set_header Upgrade $http_upgrade;
|
|
proxy_set_header Connection "upgrade";
|
|
}
|
|
|
|
location /api/websocket {
|
|
proxy_pass http://localhost:8123/api/websocket;
|
|
proxy_set_header Host $host;
|
|
|
|
proxy_http_version 1.1;
|
|
proxy_set_header Upgrade $http_upgrade;
|
|
proxy_set_header Connection "upgrade";
|
|
|
|
}
|
|
}
|
|
```
|
|
|
|
If you don't want HTTPS, you can change `listen 443 ssl` to `listen 80` or better, consider redirecting all HTTP to HTTPS. See further down.
|
|
|
|
#### {% linkable_title Multiple Instance %}
|
|
|
|
You already have Home Assistant running on http://localhost:8123 and available at home.example.org as describe before. The configuration file for this Home Assistant is available in `/home/alice/.homeassistant/configuration.yaml`.
|
|
|
|
You want another instance available at https://countryside.example.org
|
|
|
|
You can either :
|
|
* Create a new user, `bob`, to hold the configuration file in `/home/bob/.homeassistant/configuration.yaml` and run Home Assistant as this new user
|
|
* Create another configuration directory in `/home/alice/.homeassistan2/configuration.yaml` and run Home Assistant using `hass --config /home/alice/.homeassistant2/`
|
|
|
|
In both solution, change port number used by modifying `configuration.yaml` file.
|
|
|
|
```yaml
|
|
http:
|
|
server_port: 8124
|
|
...
|
|
```
|
|
|
|
Start Home Assistant: Now, you have another instance running on http://localhost:8124
|
|
|
|
To access this instance by using https://countryside.example.org create the file `/etc/nginx/sites-enabled/countryside.example.org` (or symlink via `/etc/nginx/sites-available`) and add the following:
|
|
|
|
```bash
|
|
server {
|
|
listen 443 ssl;
|
|
server_name countryside.example.org;
|
|
|
|
ssl on;
|
|
ssl_certificate /etc/nginx/ssl/countryside.example.org/countryside.example.org-bundle.crt;
|
|
ssl_certificate_key /etc/nginx/ssl/countryside.example.org/countryside.example.org.key;
|
|
ssl_prefer_server_ciphers on;
|
|
|
|
location / {
|
|
proxy_pass http://localhost:8124/;
|
|
proxy_set_header Host $host;
|
|
}
|
|
|
|
location /api/websocket {
|
|
proxy_pass http://localhost:8124/api/websocket;
|
|
proxy_set_header Host $host;
|
|
|
|
proxy_http_version 1.1;
|
|
proxy_set_header Upgrade $http_upgrade;
|
|
proxy_set_header Connection "upgrade";
|
|
|
|
}
|
|
}
|
|
```
|
|
|
|
#### {% linkable_title HTTP to HTTPS redirection %}
|
|
|
|
Add to your `/etc/nginx/sites-enabled/default`
|
|
|
|
```bash
|
|
server {
|
|
listen 80 default_server;
|
|
server_name example.tld;
|
|
|
|
return 301 https://$host$request_uri;
|
|
}
|
|
```
|
|
|