From a61ca670d252d208a15eda733839628e56e1915d Mon Sep 17 00:00:00 2001 From: Travis CI Date: Sat, 25 Mar 2017 18:24:32 +0000 Subject: [PATCH] Site updated at 2017-03-25 18:24:32 UTC --- atom.xml | 2 +- blog/categories/community/atom.xml | 2 +- blog/categories/device-tracking/atom.xml | 2 +- blog/categories/esp8266/atom.xml | 2 +- blog/categories/how-to/atom.xml | 2 +- blog/categories/ibeacons/atom.xml | 2 +- blog/categories/internet-of-things/atom.xml | 2 +- blog/categories/iot-data/atom.xml | 2 +- blog/categories/merchandise/atom.xml | 2 +- blog/categories/micropython/atom.xml | 2 +- blog/categories/mqtt/atom.xml | 2 +- blog/categories/organisation/atom.xml | 2 +- blog/categories/owntracks/atom.xml | 2 +- blog/categories/presence-detection/atom.xml | 2 +- .../public-service-announcement/atom.xml | 2 +- blog/categories/release-notes/atom.xml | 2 +- blog/categories/survey/atom.xml | 2 +- blog/categories/talks/atom.xml | 2 +- blog/categories/technology/atom.xml | 2 +- blog/categories/user-stories/atom.xml | 2 +- blog/categories/video/atom.xml | 2 +- blog/categories/website/atom.xml | 2 +- cookbook/apache_configuration/index.html | 212 +------- cookbook/githubbackup/index.html | 306 +----------- cookbook/index.html | 19 +- cookbook/owntracks_two_mqtt_broker/index.html | 15 - cookbook/tls_domain_certificate/index.html | 193 +------ .../tls_self_signed_certificate/index.html | 156 +----- cookbook/tor_configuration/index.html | 205 +------- docs/automation/action/index.html | 17 +- docs/automation/condition/index.html | 17 +- docs/automation/examples/index.html | 17 +- docs/automation/index.html | 17 +- docs/automation/templating/index.html | 17 +- docs/automation/trigger/index.html | 17 +- docs/automation/troubleshooting/index.html | 17 +- docs/autostart/index.html | 17 +- docs/autostart/init.d/index.html | 17 +- docs/autostart/macos/index.html | 17 +- docs/autostart/synology/index.html | 17 +- docs/autostart/systemd/index.html | 17 +- docs/autostart/upstart/index.html | 17 +- docs/backend/database/index.html | 17 +- docs/backend/index.html | 17 +- docs/backend/updater/index.html | 17 +- docs/configuration/basic/index.html | 17 +- .../customizing-devices/index.html | 17 +- docs/configuration/devices/index.html | 17 +- docs/configuration/events/index.html | 17 +- .../configuration/group_visibility/index.html | 17 +- docs/configuration/index.html | 17 +- docs/configuration/packages/index.html | 17 +- .../configuration/platform_options/index.html | 17 +- docs/configuration/remote/index.html | 17 +- docs/configuration/secrets/index.html | 17 +- docs/configuration/securing/index.html | 17 +- .../splitting_configuration/index.html | 17 +- docs/configuration/state_object/index.html | 17 +- docs/configuration/templating/index.html | 17 +- docs/configuration/troubleshooting/index.html | 17 +- docs/configuration/yaml/index.html | 17 +- docs/ecosystem/apache/index.html | 377 ++++++++++++++ docs/ecosystem/appdaemon/api/index.html | 17 +- .../appdaemon/configuration/index.html | 17 +- .../appdaemon/example_apps/index.html | 17 +- docs/ecosystem/appdaemon/index.html | 17 +- .../appdaemon/installation/index.html | 17 +- docs/ecosystem/appdaemon/operation/index.html | 17 +- docs/ecosystem/appdaemon/reboot/index.html | 17 +- docs/ecosystem/appdaemon/running/index.html | 17 +- docs/ecosystem/appdaemon/tutorial/index.html | 17 +- docs/ecosystem/appdaemon/updating/index.html | 17 +- docs/ecosystem/appdaemon/windows/index.html | 17 +- .../ecosystem/backup/backup_github/index.html | 471 ++++++++++++++++++ .../tls_domain_certificate/index.html | 357 +++++++++++++ .../tls_self_signed_certificate/index.html | 321 ++++++++++++ .../hadashboard/dash_config/index.html | 17 +- docs/ecosystem/hadashboard/hapush/index.html | 17 +- docs/ecosystem/hadashboard/index.html | 17 +- .../hadashboard/installation/index.html | 17 +- docs/ecosystem/hadashboard/reboot/index.html | 17 +- .../ecosystem/hadashboard/updating/index.html | 17 +- docs/ecosystem/index.html | 17 +- docs/ecosystem/ios/devices_file/index.html | 17 +- docs/ecosystem/ios/index.html | 17 +- docs/ecosystem/ios/integration/index.html | 17 +- docs/ecosystem/ios/location/index.html | 17 +- .../ios/notifications/actions/index.html | 17 +- .../ios/notifications/architecture/index.html | 17 +- .../ios/notifications/attachments/index.html | 17 +- .../ios/notifications/basic/index.html | 17 +- .../content_extensions/index.html | 17 +- docs/ecosystem/ios/notifications/index.html | 17 +- .../privacy_security_rate_limits/index.html | 17 +- .../requesting_location_updates/index.html | 17 +- .../ios/notifications/sounds/index.html | 17 +- docs/ecosystem/nginx/index.html | 17 +- docs/ecosystem/notebooks/api/index.html | 17 +- docs/ecosystem/notebooks/database/index.html | 17 +- docs/ecosystem/notebooks/graph/index.html | 17 +- docs/ecosystem/notebooks/index.html | 17 +- .../notebooks/installation/index.html | 17 +- docs/ecosystem/notebooks/stats/index.html | 17 +- docs/ecosystem/scenegen/index.html | 17 +- docs/ecosystem/synology/index.html | 17 +- docs/ecosystem/tor/index.html | 369 ++++++++++++++ docs/frontend/browsers/index.html | 17 +- docs/frontend/index.html | 17 +- docs/frontend/mobile/index.html | 17 +- docs/frontend/webserver/index.html | 17 +- docs/hassbian/common-tasks/index.html | 17 +- docs/hassbian/customization/index.html | 17 +- docs/hassbian/index.html | 17 +- docs/hassbian/installation/index.html | 17 +- docs/hassbian/integrations/index.html | 17 +- docs/hassbian/upgrading/index.html | 17 +- docs/index.html | 17 +- docs/installation/archlinux/index.html | 17 +- docs/installation/armbian/index.html | 17 +- docs/installation/centos/index.html | 17 +- docs/installation/docker/index.html | 17 +- docs/installation/fedora/index.html | 17 +- docs/installation/index.html | 17 +- docs/installation/macos/index.html | 17 +- docs/installation/python/index.html | 17 +- .../raspberry-pi-all-in-one/index.html | 17 +- docs/installation/raspberry-pi/index.html | 17 +- docs/installation/synology/index.html | 17 +- docs/installation/troubleshooting/index.html | 17 +- docs/installation/updating/index.html | 17 +- docs/installation/vagrant/index.html | 17 +- docs/installation/virtualenv/index.html | 17 +- docs/installation/windows/index.html | 17 +- docs/mqtt/birth_will/index.html | 17 +- docs/mqtt/broker/index.html | 17 +- docs/mqtt/certificate/index.html | 17 +- docs/mqtt/discovery/index.html | 17 +- docs/mqtt/index.html | 17 +- docs/mqtt/logging/index.html | 17 +- docs/mqtt/processing_json/index.html | 17 +- docs/mqtt/service/index.html | 17 +- docs/mqtt/testing/index.html | 17 +- docs/scripts/conditions/index.html | 17 +- docs/scripts/index.html | 17 +- docs/scripts/service-calls/index.html | 17 +- docs/tools/dev-tools/index.html | 17 +- docs/tools/hass/index.html | 17 +- docs/tools/index.html | 17 +- docs/tools/scripts/index.html | 17 +- docs/z-wave/controllers/index.html | 17 +- docs/z-wave/device-specific/index.html | 17 +- docs/z-wave/index.html | 17 +- docs/z-wave/settings/index.html | 17 +- sitemap.xml | 60 +-- 154 files changed, 3897 insertions(+), 1231 deletions(-) create mode 100644 docs/ecosystem/apache/index.html create mode 100644 docs/ecosystem/backup/backup_github/index.html create mode 100644 docs/ecosystem/certificates/tls_domain_certificate/index.html create mode 100644 docs/ecosystem/certificates/tls_self_signed_certificate/index.html create mode 100644 docs/ecosystem/tor/index.html diff --git a/atom.xml b/atom.xml index af975080da..3460cd8df8 100644 --- a/atom.xml +++ b/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Home Assistant]]> - 2017-03-25T16:17:06+00:00 + 2017-03-25T18:21:02+00:00 https://home-assistant.io/ diff --git a/blog/categories/community/atom.xml b/blog/categories/community/atom.xml index 06b53ccc6e..e7d5b94eb0 100644 --- a/blog/categories/community/atom.xml +++ b/blog/categories/community/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Community | Home Assistant]]> - 2017-03-25T16:17:06+00:00 + 2017-03-25T18:21:02+00:00 https://home-assistant.io/ diff --git a/blog/categories/device-tracking/atom.xml b/blog/categories/device-tracking/atom.xml index a04b1979fe..29dbb89e45 100644 --- a/blog/categories/device-tracking/atom.xml +++ b/blog/categories/device-tracking/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Device-Tracking | Home Assistant]]> - 2017-03-25T16:17:06+00:00 + 2017-03-25T18:21:02+00:00 https://home-assistant.io/ diff --git a/blog/categories/esp8266/atom.xml b/blog/categories/esp8266/atom.xml index 93cc945f21..9f2a9650d0 100644 --- a/blog/categories/esp8266/atom.xml +++ b/blog/categories/esp8266/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: ESP8266 | Home Assistant]]> - 2017-03-25T16:17:06+00:00 + 2017-03-25T18:21:02+00:00 https://home-assistant.io/ diff --git a/blog/categories/how-to/atom.xml b/blog/categories/how-to/atom.xml index eb5c91d6ff..9aaa666c5c 100644 --- a/blog/categories/how-to/atom.xml +++ b/blog/categories/how-to/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: How-To | Home Assistant]]> - 2017-03-25T16:17:06+00:00 + 2017-03-25T18:21:02+00:00 https://home-assistant.io/ diff --git a/blog/categories/ibeacons/atom.xml b/blog/categories/ibeacons/atom.xml index 98243a0557..80fc1c5de5 100644 --- a/blog/categories/ibeacons/atom.xml +++ b/blog/categories/ibeacons/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: iBeacons | Home Assistant]]> - 2017-03-25T16:17:06+00:00 + 2017-03-25T18:21:02+00:00 https://home-assistant.io/ diff --git a/blog/categories/internet-of-things/atom.xml b/blog/categories/internet-of-things/atom.xml index 7267c73150..6a3e8aabe0 100644 --- a/blog/categories/internet-of-things/atom.xml +++ b/blog/categories/internet-of-things/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Internet-of-Things | Home Assistant]]> - 2017-03-25T16:17:06+00:00 + 2017-03-25T18:21:02+00:00 https://home-assistant.io/ diff --git a/blog/categories/iot-data/atom.xml b/blog/categories/iot-data/atom.xml index 14dac032be..81ef57d10b 100644 --- a/blog/categories/iot-data/atom.xml +++ b/blog/categories/iot-data/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: IoT-Data | Home Assistant]]> - 2017-03-25T16:17:06+00:00 + 2017-03-25T18:21:02+00:00 https://home-assistant.io/ diff --git a/blog/categories/merchandise/atom.xml b/blog/categories/merchandise/atom.xml index ea2f4affa7..bb07fed7dc 100644 --- a/blog/categories/merchandise/atom.xml +++ b/blog/categories/merchandise/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Merchandise | Home Assistant]]> - 2017-03-25T16:17:06+00:00 + 2017-03-25T18:21:02+00:00 https://home-assistant.io/ diff --git a/blog/categories/micropython/atom.xml b/blog/categories/micropython/atom.xml index 24472f54a0..7f93cff8ad 100644 --- a/blog/categories/micropython/atom.xml +++ b/blog/categories/micropython/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Micropython | Home Assistant]]> - 2017-03-25T16:17:06+00:00 + 2017-03-25T18:21:02+00:00 https://home-assistant.io/ diff --git a/blog/categories/mqtt/atom.xml b/blog/categories/mqtt/atom.xml index ffc95f5d9b..fe723e8947 100644 --- a/blog/categories/mqtt/atom.xml +++ b/blog/categories/mqtt/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: MQTT | Home Assistant]]> - 2017-03-25T16:17:06+00:00 + 2017-03-25T18:21:02+00:00 https://home-assistant.io/ diff --git a/blog/categories/organisation/atom.xml b/blog/categories/organisation/atom.xml index c7f8a12997..c9b63a9ec7 100644 --- a/blog/categories/organisation/atom.xml +++ b/blog/categories/organisation/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Organisation | Home Assistant]]> - 2017-03-25T16:17:06+00:00 + 2017-03-25T18:21:02+00:00 https://home-assistant.io/ diff --git a/blog/categories/owntracks/atom.xml b/blog/categories/owntracks/atom.xml index 71047d28c1..e41bf4a582 100644 --- a/blog/categories/owntracks/atom.xml +++ b/blog/categories/owntracks/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: OwnTracks | Home Assistant]]> - 2017-03-25T16:17:06+00:00 + 2017-03-25T18:21:02+00:00 https://home-assistant.io/ diff --git a/blog/categories/presence-detection/atom.xml b/blog/categories/presence-detection/atom.xml index decc3c80d6..efeafab237 100644 --- a/blog/categories/presence-detection/atom.xml +++ b/blog/categories/presence-detection/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Presence-Detection | Home Assistant]]> - 2017-03-25T16:17:06+00:00 + 2017-03-25T18:21:02+00:00 https://home-assistant.io/ diff --git a/blog/categories/public-service-announcement/atom.xml b/blog/categories/public-service-announcement/atom.xml index 4ad3019df1..227016fa76 100644 --- a/blog/categories/public-service-announcement/atom.xml +++ b/blog/categories/public-service-announcement/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Public-Service-Announcement | Home Assistant]]> - 2017-03-25T16:17:06+00:00 + 2017-03-25T18:21:02+00:00 https://home-assistant.io/ diff --git a/blog/categories/release-notes/atom.xml b/blog/categories/release-notes/atom.xml index f4ebcf97e6..c922afbc73 100644 --- a/blog/categories/release-notes/atom.xml +++ b/blog/categories/release-notes/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Release-Notes | Home Assistant]]> - 2017-03-25T16:17:06+00:00 + 2017-03-25T18:21:02+00:00 https://home-assistant.io/ diff --git a/blog/categories/survey/atom.xml b/blog/categories/survey/atom.xml index a2ac2a3a6c..c28155a5bf 100644 --- a/blog/categories/survey/atom.xml +++ b/blog/categories/survey/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Survey | Home Assistant]]> - 2017-03-25T16:17:06+00:00 + 2017-03-25T18:21:02+00:00 https://home-assistant.io/ diff --git a/blog/categories/talks/atom.xml b/blog/categories/talks/atom.xml index 8f0356c49d..da51904875 100644 --- a/blog/categories/talks/atom.xml +++ b/blog/categories/talks/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Talks | Home Assistant]]> - 2017-03-25T16:17:06+00:00 + 2017-03-25T18:21:02+00:00 https://home-assistant.io/ diff --git a/blog/categories/technology/atom.xml b/blog/categories/technology/atom.xml index c45b7f8553..af0dbcfff5 100644 --- a/blog/categories/technology/atom.xml +++ b/blog/categories/technology/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Technology | Home Assistant]]> - 2017-03-25T16:17:06+00:00 + 2017-03-25T18:21:02+00:00 https://home-assistant.io/ diff --git a/blog/categories/user-stories/atom.xml b/blog/categories/user-stories/atom.xml index 3a9cdbd1ea..5e5b0706e4 100644 --- a/blog/categories/user-stories/atom.xml +++ b/blog/categories/user-stories/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: User-Stories | Home Assistant]]> - 2017-03-25T16:17:06+00:00 + 2017-03-25T18:21:02+00:00 https://home-assistant.io/ diff --git a/blog/categories/video/atom.xml b/blog/categories/video/atom.xml index 5f16f12277..f806f3c627 100644 --- a/blog/categories/video/atom.xml +++ b/blog/categories/video/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Video | Home Assistant]]> - 2017-03-25T16:17:06+00:00 + 2017-03-25T18:21:02+00:00 https://home-assistant.io/ diff --git a/blog/categories/website/atom.xml b/blog/categories/website/atom.xml index d4eb8866fe..337a7f7e58 100644 --- a/blog/categories/website/atom.xml +++ b/blog/categories/website/atom.xml @@ -4,7 +4,7 @@ <![CDATA[Category: Website | Home Assistant]]> - 2017-03-25T16:17:06+00:00 + 2017-03-25T18:21:02+00:00 https://home-assistant.io/ diff --git a/cookbook/apache_configuration/index.html b/cookbook/apache_configuration/index.html index 4e244ec06b..9df56711c4 100644 --- a/cookbook/apache_configuration/index.html +++ b/cookbook/apache_configuration/index.html @@ -1,204 +1,10 @@ - - - - - - - - - Apache Configuration - Home Assistant - - - - - - - - - - - - - - - - - - - - - - -
-
-
-
- - - Home Assistant - -
-
- -
-
-
-
-
-
-
-
-
-

- Apache Configuration -

-
-
-

This example demonstrates how you can configure Apache 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
    • -
-

Subdomain

-

So you already have a working Apache server available at example.org. Your Home Assistant is correctly working on this web server and available at http://localhost:8123

-

Enable mod_proxy_wstunnel by running if you encounter issues while serving Home Assistant through your proxy:

-
$ sudo a2enmod proxy_wstunnel
-
-
-

To be able to access to your Home Assistant instance by using https://home.example.org, add to following file to /etc/httpd/conf/extra/ as hass.conf

-
<VirtualHost *:443>
-  ProxyPreserveHost On
-  ProxyRequests Off
-  ServerName home.example.org
-  ProxyPass /api/websocket ws://localhost:8123/api/websocket
-  ProxyPassReverse /api/websocket ws://localhost:8123/api/websocket
-  ProxyPass / http://localhost:8123/
-  ProxyPassReverse / http://localhost:8123/
-</VirtualHost>
-
-
-

and make sure that this file is read by Apache’s main configuration file /etc/httpd/conf/httpd.conf

-
...
-Include conf/extra/hass.conf
-...
-
-
-

If you don’t want HTTPS, you can change <VirtualHost *:443> to <VirtualHost *:80> or better consider redirecting all HTTP to HTTPS.

-

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

-
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 add to /etc/httpd/conf/extra/hass.conf

-
<VirtualHost *:443>
-  ProxyPreserveHost On
-  ProxyRequests Off
-  ServerName countryside.example.org
-  ProxyPass /api/websocket ws://localhost:8123/api/websocket
-  ProxyPassReverse /api/websocket ws://localhost:8123/api/websocket
-  ProxyPass / http://localhost:8124/
-  ProxyPassReverse / http://localhost:8124/
-</VirtualHost>
-
-
-

HTTP to HTTPS redirection

-

Add to your /etc/httpd/conf/extra/hass.conf

-
<VirtualHost *:80>
-  ServerName example.org
-  ServerSignature Off
-
-  RewriteEngine on
-  RewriteCond %{HTTPS} !=on
-  RewriteRule .* https://%{SERVER_NAME}%{REQUEST_URI} [NE,R,L]
-</VirtualHost>
-
-
-
-
- -
-
- - - + + + +Redirecting… + + +

Redirecting…

+Click here if you are not redirected. + diff --git a/cookbook/githubbackup/index.html b/cookbook/githubbackup/index.html index 8b2694e75f..7240fc1a4b 100644 --- a/cookbook/githubbackup/index.html +++ b/cookbook/githubbackup/index.html @@ -1,298 +1,10 @@ - - - - - - - - - Configuration Backup to GitHub - Home Assistant - - - - - - - - - - - - - - - - - - - - - - -
-
-
-
- - - Home Assistant - -
-
- -
-
-
-
-
-
-
-
-
-

- Configuration Backup to GitHub -

-
-
-

Backing up and regularly syncing your Home Assistant configuration to GitHub has several benefits:

-
    -
  • A remote copy of your Home Assistant YAML files in case you need to recover
    • -
  • A documented history of your changes for troubleshooting purposes
    • -
  • It will help the Home Assistant community learn from your configuration examples
    • -
-

-This is not a comprehensive tutorial on using GitHub, more information can be found in the GitHub Help pages. This guide assumes the user has an intermediate experience level and is comfortable with such concepts as: navigating the Home Assistant directory structure, logging in as the Home Assistant user, and working with the command line. -

-

-This will not create a full backup of your Home Assistant files or your OS. In addition to backing up to Github, you should consider having regular backups of all your Home Assistant configuration files and images of your SD card if applicable. -

-

Important Best Practices

-

Some best practices to consider before putting your configuration on GitHub:

-
    -
  • Extensive use of secrets.yaml to hide sensitive information like usernames, passwords, device information, and location
    • -
  • Exclusion of some files, including secrets.yaml and device-specific information using a .gitignore file
    • -
  • Regularly commiting your configuration to GitHub to make sure that your backup is up to date
    • -
  • Use a README.md to document your configuration and include screenshots of your Home Assistant GUI
    • -
-

Step 1: Installing and Initializing Git

-

In order to put your configuration on GitHub, you must install the git package on your Home Assistant server (instructions below will work on Raspberry Pi, Ubunutu, or any Debian-based system):

-
$ sudo apt-get update
-$ sudo apt-get install git
-
-
-

Step 2: Creating .gitignore

-

-Before creating and pushing your Home Assistant configuration to GitHub, please make sure to follow the secrets.yaml best practice mentioned above and scrub your configuration for any passwords or sensitive information. -

-

Creating a .gitignore file in your repository will tell git which files NOT to push to the GitHub server. This should be used to prevent publishing sensitive files to the public. It should contain a list of filenames and pattern matches. This list should include at least your secrets.yaml file, device configuration files, and the Home Assistant database/directory structure. The .gitignore file should be placed in your Home Assistant directory.

-

Here is a sane example, but yours should be based on the files in your structure:

-

.gitignore

-
*.pid
-*.xml
-*.csr
-*.crt
-*.key
-www
-OZW_Log.txt
-home-assistant.log
-home-assistant_v2.db
-*.db-journal
-lib
-deps
-tts
-secrets.yaml
-known_devices.yaml
-*.conf
-plex.conf
-phue.conf
-harmony_media_room.conf
-pyozw.sqlite
-.*
-!/.gitignore
-
-
-

More information on the layout of the file can be found in the .gitignore manual.

-

Step 3: Preparing your Home Assistant directory for GitHub

-

In your Home Assistant directory, type the following commands as the Home Assistant user, replacing the email address and name with your information:

-
$ git init
-$ git config user.email "you@example.com"
-$ git config user.name "Your Name"
-$ git add .
-$ git commit
-
-
-

After the git commit command, you will be asked to enter a message for the commit. This will add a comment beside each file on GitHub describing the purpose for the commit. In this case, you can enter something like “Initial commit of my Home Assistant configuration.”

-

Step 4: Creating Repository on GitHub

-
    -
  • Connect to GitHub and login to your account (or create an account if you don’t already have one).
    • -
  • Click “New Repository” and give your repository a name/description (Home-AssistantConfig is used in the example below). You do NOT need to change any other options.
    • -
  • Click “Create Repository”
    • -
-

Step 5: Your initial commit to GitHub

-

Once you are sure you are using secrets.yaml and .gitignore correctly, it is time to push your configuration to the GitHub Repository that you just created.

-

In your Home Assistant directory, type the following commands as the Home Assistant user, replacing “username” in the URL with your GitHub username:

-
$ git remote add origin https://github.com/username/Home-AssistantConfig
-$ git push -u origin master
-
-
-

You will be asked to enter your GitHub username and password (or ssh key passphrase if you use GitHub with ssh).

-

Congratulations, you now have a copy of your current Home Assistant Configuration on GitHub!

-

Step 6: Keeping your repository up to date

-

You should update your repository on a regular basis; ideally after you make a major configuration change (new device, new component, etc.). The below script will update your repository with any changed configuration files and allow you to add a comment with the commit for tracking purposes:

-

-You may need to adjust the paths in the script depending on your Home Assistant configuration. -

-

gitupdate.sh

-
#!/bin/bash
-
-cd /home/homeassistant/.homeassistant
-source /srv/homeassistant/homeassistant_venv/bin/activate
-hass --script check_config
-
-git add .
-git status
-echo -n "Enter the Description for the Change: " [Minor Update]
-read CHANGE_MSG
-git commit -m "${CHANGE_MSG}"
-git push origin master
-
-exit
-
-
-

Every time you run this script, you will be prompted for a comment to describe the change(s) that you are commiting. This comment will be displayed beside each changed file on GitHub and will be stored after each commit. You will also be asked to enter your GitHub username and password (or ssh key passphrase if you use GitHub with ssh).

-

Step 7: Configuration file testing

-

Travis CI is a continuous integration testing system that runs every time the code in your repository is updated and allows you to validate that your code works on a fresh install.

-
    -
  • Authorise Travis CI to have access to your github repos.
    • -
  • Create the build script that travis will run to test your repo.
    • -
  • Create a dummy secrets.yaml for Travis.
    • -
-

Example .travis.yml

-
language: python
-python:
-  - "3.4"
-before_install:
-  - mv travis_secrets.yaml secrets.yaml  
-install:
-  - pip3 install homeassistant
-script:
-  - hass -c . --script check_config
-
-
-

Since the secrets.yaml should not be stored in your repo for security reasons, you won’t be able to access it at build time. Creating a dummy secrets.yaml is as simple as creating a new file that mimics your existing secrets.yaml with the required keys, but not their value.

-
#travis_secrets.yaml
-http_api: 000000000000000000000000
-home_latitude: 00.00000
-home_longitude: 00.0000
-home_elevation: 0
-
-
-

Extra commands

-

You can enter these commands to get a list of the files in your local git repository and a status of files that have changed but not commited yet:

-
$ git ls-files
-$ git status
-
-
-

Examples:

-
homeassistant@raspberrypi:~/.homeassistant $ git ls-files    
-.gitignore
-README.md
-automation.yaml
-configuration.yaml
-customize.yaml
-device_tracker.yaml
-group.yaml
-script.yaml
-
-homeassistant@raspberrypi:~/.homeassistant $ git status
-On branch master
-Your branch is up-to-date with 'origin/master'.
-Changes not staged for commit:
-  (use "git add <file>..." to update what will be committed)
-  (use "git checkout -- <file>..." to discard changes in working directory)
-
-        modified:   .gitignore
-        modified:   automation.yaml
-        modified:   customize.yaml
-        modified:   group.yaml
-
-no changes added to commit (use "git add" and/or "git commit -a")
-
-
-
-
- -
-
- - - + + + +Redirecting… + + +

Redirecting…

+Click here if you are not redirected. + diff --git a/cookbook/index.html b/cookbook/index.html index 90bb2967b3..550079c35f 100644 --- a/cookbook/index.html +++ b/cookbook/index.html @@ -203,24 +203,7 @@ A great place to find popular configurations is on this Infrastructure

User Interface

    diff --git a/cookbook/owntracks_two_mqtt_broker/index.html b/cookbook/owntracks_two_mqtt_broker/index.html index 976cdad47b..0c0ba9884f 100644 --- a/cookbook/owntracks_two_mqtt_broker/index.html +++ b/cookbook/owntracks_two_mqtt_broker/index.html @@ -154,24 +154,9 @@ Fill out

    Infrastructure

    diff --git a/cookbook/tls_domain_certificate/index.html b/cookbook/tls_domain_certificate/index.html index 7e0f06e83a..a03b0abadc 100644 --- a/cookbook/tls_domain_certificate/index.html +++ b/cookbook/tls_domain_certificate/index.html @@ -1,185 +1,10 @@ - - - - - - - - - Certificate for SSL/TLS via domain ownership - Home Assistant - - - - - - - - - - - - - - - - - - - - - - -
    -
    -
    -
    - - - Home Assistant - -
    -
    - -
    -
    -
    -
    -
    -
    -
    -
    -
    -

    - Certificate for SSL/TLS via Domain Ownership -

    -
    -
    -

    If your Home Assistant instance is only accessible from your local network you can still protect the communication between your browsers and the frontend with SSL/TLS. You can use Self-sign certificate but your browser will present a warning and some https-only features might not work.

    -

    Prerequirement for this guide

    -
      -
    • Your Home Assistant instance is not exposed to the internet. If it is - use this guide
      • -
    • You control a public domain name. The domain doesn’t have to point to a site. A domain controlled by a trusted friend will do. (A friend you trust not to MITM you)
      • -
    • Your home router supports custom DNS entries.
      • -
    -

    Run certbot

    -
    $ mkdir certbot
-$ cd certbot
-$ wget https://dl.eff.org/certbot-auto
-$ chmod a+x certbot-auto
-$ sudo ./certbot-auto --manual certonly --preferred-challenges dns -d "mydomain.com" --email your@email.address
-
    -
    -
      -
    • Agree to Terms of Service
      • -
    • Choose whether to share your email with Electronic Frontier Foundation.
      • -
    • Agree to your IP being logged
      • -
    -

    You will get the following text:

    -
    Please deploy a DNS TXT record under the name
-_acme-challenge.mydomain.com with the following value:
-
-deadbeefdeadbeefdeadbeefdeadbeefdeadbeef
-
-Once this is deployed,
--------------------------------------------------------------------------------
-Press Enter to Continue
-
    -
    -
      -
    • -

      Deploy the value to TXT field using your domain registar.

      -
      • -
    • Go to a site that queries domain record. For example this one and look if it sees your brand new TXT field (Don’t forget to enter the full domain: _acme-challenge.mydomain.com)
      • -
    • Press Enter at certbot prompt.
      • -
    -

    Make mydomain.com point to your Home Assistant instance

    -

    If your router uses DNSMasq (for example DDWRT) add the following line to DNSMasq options:

    -
    address=/mydomain.com/<hass ip>
-
    -
    -

    Edit your Home Assistant configuration to use your certificates

    -
    http:
-  api_password: YOUR_SECRET_PASSWORD
-  base_url: https://mydomain.com:8123
-  ssl_certificate: /etc/letsencrypt/live/mydomain.com/fullchain.pem
-  ssl_key: /etc/letsencrypt/live/mydomain.com/privkey.pem
-
    -
    -

    Make sure the files are accessible by the user that runs Home Assistant, eg. homeassistant for a HASSbian setup.

    -
    -
    - -
    -
    - - - + + + +Redirecting… + + +

    Redirecting…

    +Click here if you are not redirected. + diff --git a/cookbook/tls_self_signed_certificate/index.html b/cookbook/tls_self_signed_certificate/index.html index c92a64f7fe..b032885932 100644 --- a/cookbook/tls_self_signed_certificate/index.html +++ b/cookbook/tls_self_signed_certificate/index.html @@ -1,148 +1,10 @@ - - - - - - - - - Self-signed certificate for SSL/TLS - Home Assistant - - - - - - - - - - - - - - - - - - - - - - -
    -
    -
    -
    - - - Home Assistant - -
    -
    - -
    -
    -
    -
    -
    -
    -
    -
    -
    -

    - Self-signed Certificate for SSL/TLS -

    -
    -
    -

    If your Home Assistant instance is only accessible from your local network you can still protect the communication between your browsers and the frontend with SSL/TLS. Let’s encrypt will only work if you have a DNS entry and remote access is allowed. The solution is to use a self-signed certificate. As you most likely don’t have a certification authority (CA) your browser will conplain about the security. If you have a CA then this will not be an issue.

    -

    To create locally a certificate you need the OpenSSL command-line tool.

    -

    Change to your Home Assistant configuration directory like ~/.homeassistant. This will make it easier to backup your certificate and the key. Run the command shown below.

    -
    $ openssl req -new -x509 -sha256 -newkey rsa:4096 -nodes -keyout privkey.pem -days 730 -out fullchain.pem
-
    -
    -

    For details about the parameters, please check the OpenSSL documentation. Provide the requested information during the generation process. At the end you will have two files called privkey.pem and fullchain.pem. The key and the certificate.

    -

    Update the http: entry in your configuration.yaml file and let it point to your created files.

    -
    http:
-  api_password: YOUR_SECRET_PASSWORD
-  ssl_certificate: /home/fab/.homeassistant/fullchain.pem
-  ssl_key: /home/fab/.homeassistant/privkey.pem
-
    -
    -

    A tutorial “Working with SSL Certificates, Private Keys and CSRs” could give you some insight about special cases.

    -
    -
    - -
    -
    - - - + + + +Redirecting… + + +

    Redirecting…

    +Click here if you are not redirected. + diff --git a/cookbook/tor_configuration/index.html b/cookbook/tor_configuration/index.html index d29e47e4d7..0cd86e4901 100644 --- a/cookbook/tor_configuration/index.html +++ b/cookbook/tor_configuration/index.html @@ -1,197 +1,10 @@ - - - - - - - - - Tor Onion Service Configuration - Home Assistant - - - - - - - - - - - - - - - - - - - - - - - -
    -
    -
    -
    - - - Home Assistant - -
    -
    - -
    -
    -
    -
    -
    -
    -
    -
    -
    -

    - Tor Onion Service Configuration -

    -
    -
    -

    This is an example about how you can configure Tor to provide secure remote access to your Home Assistant instance as an Onion site, through Tor’s Hidden Service feature. With this enabled, you do not need to open your firewall ports or setup HTTPS to enable secure remote access.

    -

    This is useful if you want to have:

    -
      -
    • Access your Home Assistant instance remotely without opening a firewall port or setting up a VPN
      • -
    • Don’t want to or know how to get an SSL/TLS certificate and HTTPS configuration setup
      • -
    • Want to block attackers from even being able to access/scan your port and server at all
      • -
    • Want to block anyone from knowing your home IP address and seeing your traffic to your Home Assistant
      • -
    -

    Background and Contact

    -

    This configuration is part of an effort to apply strong cryptography technologies (like Onion Routing and End-to-End Encryption) to technology we increasingly depend on in our day to day lives. Just like when WhatsApp enabled end-to-end encryption messaging for everyone, every home automation and IoT platform should do the same, because A) the technology is all there, freely licensed and open-source and B) up to this point, all the commercial manufacturers have been doing a horrific job with security.

    -

    You can learn more about how Tor can be used to secure home automation and IoT platforms through this short set of slides on the Internet of Onion Things

    -

    This configuration was provided by @n8fr8 (github, twitter) of the Guardian Project and Tor Project. You can send questions, feedback and ideas to support@guardianproject.info.

    -

    Hidden Services and Onion Sites

    -

    Tor allows clients and relays to offer hidden services. That is, you can offer a web server, SSH server, etc., without revealing your IP address to its users. In fact, because you don’t use any public address, you can run a hidden service from behind your firewall. Learn more about Hidden Services on the Tor Project website.

    -

    Onion sites are websites that run on a Tor Hidden Service node. “dot onion” sites are an IETF recognized special use domain name.

    -

    Setting up Tor on your Home Assistant

    -

    First, install Tor. On a Debian-based system, you can install the package easily:

    -
    $ sudo apt-get install tor
-
    -
    -

    You can find more instructions for downloading and installing Tor on other platforms on the Tor Project Download Page.

    -

    Next, modify Tor’s main configuration file /etc/tor/torrc to include the following lines:

    -
    ############### This section is just for location-hidden services ###
-
-## Once you have configured a hidden service, you can look at the
-## contents of the file ".../hidden_service/hostname" for the address
-## to tell people.
-...
-HiddenServiceDir /var/lib/tor/homeassistant/
-HiddenServicePort 80 127.0.0.1:8123
-HiddenServiceAuthorizeClient stealth haremote1
-...
-
    -
    -

    The “stealth” entry above ensures traffic to and from your Home Assistant instance over Tor, is hidden even from other nodes on the Tor network. The haremote1 value is a generic client name entry that you can modify as you please.

    -

    Then, restart Tor:

    -
    $ sudo /etc/init.d/tor restart
-
    -
    -

    Then read the new generated authentication cookie from the Tor-generated hostname file:

    -
    $ sudo more /var/lib/tor/homeassistant/hostname
-
    -
    -

    The output of that command should look something like this, but with your own unique “dot onion” domain and authentication cookie:

    -
    abcdef1234567890.onion ABCDEF1122334455667789 # client: haremote1
-
    -
    -

    You are now done with the Home Assistant Tor server configuration. Make sure your Home Assistant instance is running, and now you can move to client configuration.

    -

    Tor Client Access Setup

    -

    Using this setup, you can access your Home Assistant instance over Tor from your laptop or mobile device, using Tor Browser and other software.

    -

    Add the authentication cookie to your torrc client configuration on your laptop or mobile device. Using the sample values from above, it would look like this:

    -
    HidServAuth abcdef1234567890.onion ABCDEF1122334455667789
-
    -
    -

    For Tor Browser on Windows, Mac or Linux, you can find the torrc file here: <tor browser install directory>/Browser/TorBrowser/Data/Tor/torrc-defaults

    -

    Once you have added the entry, restart the browser, and then browse to the “dot onion” site address to connect to your Home Assistant instance.

    -

    For Orbot: Tor on Android, add it in Orbot -> Menu -> Settings to the “Torrc Custom Config” entry. Restart Orbot, and then use the Orfox browser app, and browse to the “dot onion” site name to access your Home Assistant instance. You can also use Orbot’s VPN mode, to enable Tor access from any application on your device, such as Tasker or Owntracks.

    -

    On iOS, we have not fully tested this yet, but you should be able to add custom torrc entries on Onion Browser, Red Onion or TOBY browsers, all available in the iTunes App Store.

    -

    Some More Advanced Ideas

    -

    With this configuration, only you can access your Home Assistant instance Onion site through Tor, and no one else. You can share the authentication cookie with multiple devices and users, or you can generate a unique one for each - up to you! If you have multiple, say for an industrial, business or corporate configuration, this would provide an easy way to revoke access to a specific user or device.

    -

    If you always access your Home Assistant instance via Tor, you can easily run this on an isolated “IoT” network segment at your install site, keeping your internal home network traffic separate from any potentially compromised devices (like cheap “smart” lightbulbs with backdoors!).

    -

    You could also use Tor as a means to connect your Home Assistant instance to a remote device, sensor or other service that you do not want to or connect provide a direct, open IP connection to. Again, Tor provides authenticated and confidential routing (aka “privacy and encryption”) by default, without having to setup TLS/SSL or VPN. It is just important to secure IoT nodes within your network, as it is to secure remote access!

    -

    As mentioned, with Orbot on Android, you can enable a “full device” VPN mode, that allows any app you have to tunnel through Tor, even if it is not Tor or proxy aware. This means you should be able to enter your “dot onion” Onion site address into any app you want to access to your Home Assistant instance, and it should work.

    -
    -
    - -
    -
    - - - + + + +Redirecting… + + +

    Redirecting…

    +Click here if you are not redirected. + diff --git a/docs/automation/action/index.html b/docs/automation/action/index.html index c2d7f61f72..d4d60757a3 100644 --- a/docs/automation/action/index.html +++ b/docs/automation/action/index.html @@ -304,9 +304,24 @@
  • Integration with other apps
-
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/automation/condition/index.html b/docs/automation/condition/index.html index be326ac800..baa7a54d95 100644 --- a/docs/automation/condition/index.html +++ b/docs/automation/condition/index.html @@ -270,9 +270,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/automation/examples/index.html b/docs/automation/examples/index.html index 578f86707a..c56403c7e0 100644 --- a/docs/automation/examples/index.html +++ b/docs/automation/examples/index.html @@ -304,9 +304,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/automation/index.html b/docs/automation/index.html index 1980289d51..e937b2407b 100644 --- a/docs/automation/index.html +++ b/docs/automation/index.html @@ -295,9 +295,24 @@ The difference between a condition and a trigger can be confusing as they are ve
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/automation/templating/index.html b/docs/automation/templating/index.html index eee4e67b41..e2106f4798 100644 --- a/docs/automation/templating/index.html +++ b/docs/automation/templating/index.html @@ -508,9 +508,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/automation/trigger/index.html b/docs/automation/trigger/index.html index 80942b402a..a273cecfd9 100644 --- a/docs/automation/trigger/index.html +++ b/docs/automation/trigger/index.html @@ -380,9 +380,24 @@ With template triggers you can also evaluate attribute changes by using is_state
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/automation/troubleshooting/index.html b/docs/automation/troubleshooting/index.html index 48d3b2ae29..db14b4ad66 100644 --- a/docs/automation/troubleshooting/index.html +++ b/docs/automation/troubleshooting/index.html @@ -257,9 +257,24 @@ INFO [homeassistant.components.automation] Initialized rule Rain is over
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/autostart/index.html b/docs/autostart/index.html index 0038095515..1a2206fea6 100644 --- a/docs/autostart/index.html +++ b/docs/autostart/index.html @@ -258,9 +258,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/autostart/init.d/index.html b/docs/autostart/init.d/index.html index 0166bf0575..630df250fd 100644 --- a/docs/autostart/init.d/index.html +++ b/docs/autostart/init.d/index.html @@ -359,9 +359,24 @@ esac
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/autostart/macos/index.html b/docs/autostart/macos/index.html index ba899b6b59..497be30115 100644 --- a/docs/autostart/macos/index.html +++ b/docs/autostart/macos/index.html @@ -264,9 +264,24 @@ Home Assistant has been uninstalled.
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/autostart/synology/index.html b/docs/autostart/synology/index.html index e27aa4c0a2..7fe0988c75 100644 --- a/docs/autostart/synology/index.html +++ b/docs/autostart/synology/index.html @@ -279,9 +279,24 @@ stop on runlevel [06]
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/autostart/systemd/index.html b/docs/autostart/systemd/index.html index 5a37e648bc..c3704394a7 100644 --- a/docs/autostart/systemd/index.html +++ b/docs/autostart/systemd/index.html @@ -342,9 +342,24 @@ WantedBy=multi-user.target
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/autostart/upstart/index.html b/docs/autostart/upstart/index.html index 2f2ecbbf11..b39d8651af 100644 --- a/docs/autostart/upstart/index.html +++ b/docs/autostart/upstart/index.html @@ -368,9 +368,24 @@ esac
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/backend/database/index.html b/docs/backend/database/index.html index 9a584b38ab..bf69b12664 100644 --- a/docs/backend/database/index.html +++ b/docs/backend/database/index.html @@ -344,9 +344,24 @@ group.all_switches 8018
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/backend/index.html b/docs/backend/index.html index 9dbf2ee988..8657f59320 100644 --- a/docs/backend/index.html +++ b/docs/backend/index.html @@ -253,9 +253,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/backend/updater/index.html b/docs/backend/updater/index.html index ee4f982aa8..47394cb6b5 100644 --- a/docs/backend/updater/index.html +++ b/docs/backend/updater/index.html @@ -410,9 +410,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/configuration/basic/index.html b/docs/configuration/basic/index.html index 8b284d67a7..d0c3c91159 100644 --- a/docs/configuration/basic/index.html +++ b/docs/configuration/basic/index.html @@ -282,9 +282,24 @@ If you decide to expose your Home Assistant instance to the internet and forget
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/configuration/customizing-devices/index.html b/docs/configuration/customizing-devices/index.html index 75f2c91a6b..e6a1ec8c02 100644 --- a/docs/configuration/customizing-devices/index.html +++ b/docs/configuration/customizing-devices/index.html @@ -326,9 +326,24 @@ New customize information will be applied the next time the state of the entity
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/configuration/devices/index.html b/docs/configuration/devices/index.html index c8807fcced..ee59042ca2 100644 --- a/docs/configuration/devices/index.html +++ b/docs/configuration/devices/index.html @@ -296,9 +296,24 @@ Each group consists of a name and a list of entity IDs. Entity IDs can be retrie
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/configuration/events/index.html b/docs/configuration/events/index.html index 63315e4f94..cdc51366e4 100644 --- a/docs/configuration/events/index.html +++ b/docs/configuration/events/index.html @@ -396,9 +396,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/configuration/group_visibility/index.html b/docs/configuration/group_visibility/index.html index 1c6e98de49..ba55d483bf 100644 --- a/docs/configuration/group_visibility/index.html +++ b/docs/configuration/group_visibility/index.html @@ -398,9 +398,24 @@ If a sensor belongs to only one group and that group is hidden, the sensor will
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/configuration/index.html b/docs/configuration/index.html index 94a441fe37..8dca25e3e5 100644 --- a/docs/configuration/index.html +++ b/docs/configuration/index.html @@ -283,9 +283,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/configuration/packages/index.html b/docs/configuration/packages/index.html index 975fae9ba4..ef8b1ac574 100644 --- a/docs/configuration/packages/index.html +++ b/docs/configuration/packages/index.html @@ -315,9 +315,24 @@ See the documentation about for encrypted keyring:
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/configuration/securing/index.html b/docs/configuration/securing/index.html index 9ff35252ca..4fbb07b39c 100644 --- a/docs/configuration/securing/index.html +++ b/docs/configuration/securing/index.html @@ -266,9 +266,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/configuration/splitting_configuration/index.html b/docs/configuration/splitting_configuration/index.html index 4160e139a9..e23e037a68 100644 --- a/docs/configuration/splitting_configuration/index.html +++ b/docs/configuration/splitting_configuration/index.html @@ -613,9 +613,24 @@ customize.yaml
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/configuration/state_object/index.html b/docs/configuration/state_object/index.html index cdda292076..fc179de34d 100644 --- a/docs/configuration/state_object/index.html +++ b/docs/configuration/state_object/index.html @@ -332,9 +332,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/configuration/templating/index.html b/docs/configuration/templating/index.html index 337be17a73..44d1d3ae6a 100644 --- a/docs/configuration/templating/index.html +++ b/docs/configuration/templating/index.html @@ -423,9 +423,24 @@ Closest to an entity: {{ closest(states.zone.school, 'group.children') }}
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/configuration/troubleshooting/index.html b/docs/configuration/troubleshooting/index.html index bdea13e2db..4edf530781 100644 --- a/docs/configuration/troubleshooting/index.html +++ b/docs/configuration/troubleshooting/index.html @@ -304,9 +304,24 @@ Whenever you report an issue, be aware that we are volunteers who do not have ac
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/configuration/yaml/index.html b/docs/configuration/yaml/index.html index 9405b53c86..76561a47e4 100644 --- a/docs/configuration/yaml/index.html +++ b/docs/configuration/yaml/index.html @@ -291,9 +291,24 @@ The other properties (like name) are specified using mappings. Note that the sec
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/ecosystem/apache/index.html b/docs/ecosystem/apache/index.html new file mode 100644 index 0000000000..0ea730cf88 --- /dev/null +++ b/docs/ecosystem/apache/index.html @@ -0,0 +1,377 @@ + + + + + + + + + Apache Proxy - Home Assistant + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + + + Home Assistant + +
    +
    + +
    +
    +
    +
    +
    +
    +
    +
    +
    Edit this page on GitHub
    +
    +

    + Apache Proxy +

    +
    +
    +

    This example demonstrates how you can configure Apache 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
      • +
    +

    Subdomain

    +

    So you already have a working Apache server available at example.org. Your Home Assistant is correctly working on this web server and available at http://localhost:8123

    +

    Enable mod_proxy_wstunnel by running if you encounter issues while serving Home Assistant through your proxy:

    +
    $ sudo a2enmod proxy_wstunnel
+
    +
    +

    To be able to access to your Home Assistant instance by using https://home.example.org, add to following file to /etc/httpd/conf/extra/ as hass.conf

    +
    <VirtualHost *:443>
+  ProxyPreserveHost On
+  ProxyRequests Off
+  ServerName home.example.org
+  ProxyPass /api/websocket ws://localhost:8123/api/websocket
+  ProxyPassReverse /api/websocket ws://localhost:8123/api/websocket
+  ProxyPass / http://localhost:8123/
+  ProxyPassReverse / http://localhost:8123/
+</VirtualHost>
+
    +
    +

    and make sure that this file is read by Apache’s main configuration file /etc/httpd/conf/httpd.conf

    +
    ...
+Include conf/extra/hass.conf
+...
+
    +
    +

    If you don’t want HTTPS, you can change <VirtualHost *:443> to <VirtualHost *:80> or better consider redirecting all HTTP to HTTPS.

    +

    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

    +
    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 add to /etc/httpd/conf/extra/hass.conf

    +
    <VirtualHost *:443>
+  ProxyPreserveHost On
+  ProxyRequests Off
+  ServerName countryside.example.org
+  ProxyPass /api/websocket ws://localhost:8123/api/websocket
+  ProxyPassReverse /api/websocket ws://localhost:8123/api/websocket
+  ProxyPass / http://localhost:8124/
+  ProxyPassReverse / http://localhost:8124/
+</VirtualHost>
+
    +
    +

    HTTP to HTTPS redirection

    +

    Add to your /etc/httpd/conf/extra/hass.conf

    +
    <VirtualHost *:80>
+  ServerName example.org
+  ServerSignature Off
+
+  RewriteEngine on
+  RewriteCond %{HTTPS} !=on
+  RewriteRule .* https://%{SERVER_NAME}%{REQUEST_URI} [NE,R,L]
+</VirtualHost>
+
    +
    +
    +
    + +
    +
    + + + + diff --git a/docs/ecosystem/appdaemon/api/index.html b/docs/ecosystem/appdaemon/api/index.html index 443f433dfd..7260e0c193 100644 --- a/docs/ecosystem/appdaemon/api/index.html +++ b/docs/ecosystem/appdaemon/api/index.html @@ -1609,9 +1609,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/ecosystem/appdaemon/configuration/index.html b/docs/ecosystem/appdaemon/configuration/index.html index d6946bc612..bcdc82484d 100644 --- a/docs/ecosystem/appdaemon/configuration/index.html +++ b/docs/ecosystem/appdaemon/configuration/index.html @@ -308,9 +308,24 @@ timezone = <timezone>
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/ecosystem/appdaemon/example_apps/index.html b/docs/ecosystem/appdaemon/example_apps/index.html index 9d9c0ea318..e2a8018b5b 100644 --- a/docs/ecosystem/appdaemon/example_apps/index.html +++ b/docs/ecosystem/appdaemon/example_apps/index.html @@ -251,9 +251,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/ecosystem/appdaemon/index.html b/docs/ecosystem/appdaemon/index.html index 44e2580665..7df08c840e 100644 --- a/docs/ecosystem/appdaemon/index.html +++ b/docs/ecosystem/appdaemon/index.html @@ -251,9 +251,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/ecosystem/appdaemon/installation/index.html b/docs/ecosystem/appdaemon/installation/index.html index bb26a09881..2b1d0b95df 100644 --- a/docs/ecosystem/appdaemon/installation/index.html +++ b/docs/ecosystem/appdaemon/installation/index.html @@ -271,9 +271,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/ecosystem/appdaemon/operation/index.html b/docs/ecosystem/appdaemon/operation/index.html index 180e1b94a8..fa8f4dcf03 100644 --- a/docs/ecosystem/appdaemon/operation/index.html +++ b/docs/ecosystem/appdaemon/operation/index.html @@ -251,9 +251,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/ecosystem/appdaemon/reboot/index.html b/docs/ecosystem/appdaemon/reboot/index.html index 70fe42f0ca..63b5b18a9f 100644 --- a/docs/ecosystem/appdaemon/reboot/index.html +++ b/docs/ecosystem/appdaemon/reboot/index.html @@ -251,9 +251,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/ecosystem/appdaemon/running/index.html b/docs/ecosystem/appdaemon/running/index.html index 865f8a30b8..448005fb10 100644 --- a/docs/ecosystem/appdaemon/running/index.html +++ b/docs/ecosystem/appdaemon/running/index.html @@ -313,9 +313,24 @@ optional arguments:
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/ecosystem/appdaemon/tutorial/index.html b/docs/ecosystem/appdaemon/tutorial/index.html index 77e2b37d6b..8f4519e409 100644 --- a/docs/ecosystem/appdaemon/tutorial/index.html +++ b/docs/ecosystem/appdaemon/tutorial/index.html @@ -344,9 +344,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/ecosystem/appdaemon/updating/index.html b/docs/ecosystem/appdaemon/updating/index.html index a2cc260025..3a594ffeda 100644 --- a/docs/ecosystem/appdaemon/updating/index.html +++ b/docs/ecosystem/appdaemon/updating/index.html @@ -260,9 +260,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/ecosystem/appdaemon/windows/index.html b/docs/ecosystem/appdaemon/windows/index.html index cb46c5aaa5..e71c452e1c 100644 --- a/docs/ecosystem/appdaemon/windows/index.html +++ b/docs/ecosystem/appdaemon/windows/index.html @@ -258,9 +258,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/ecosystem/backup/backup_github/index.html b/docs/ecosystem/backup/backup_github/index.html new file mode 100644 index 0000000000..af96f57382 --- /dev/null +++ b/docs/ecosystem/backup/backup_github/index.html @@ -0,0 +1,471 @@ + + + + + + + + + Configuration Backup to GitHub - Home Assistant + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + + + Home Assistant + +
    +
    + +
    +
    +
    +
    +
    +
    +
    +
    +
    Edit this page on GitHub
    +
    +

    + Configuration Backup to GitHub +

    +
    +
    +

    Backing up and regularly syncing your Home Assistant configuration to GitHub has several benefits:

    +
      +
    • A remote copy of your Home Assistant YAML files in case you need to recover
      • +
    • A documented history of your changes for troubleshooting purposes
      • +
    • It will help the Home Assistant community learn from your configuration examples
      • +
    +

    +This is not a comprehensive tutorial on using GitHub, more information can be found in the GitHub Help pages. This guide assumes the user has an intermediate experience level and is comfortable with such concepts as: navigating the Home Assistant directory structure, logging in as the Home Assistant user, and working with the command line. +

    +

    +This will not create a full backup of your Home Assistant files or your OS. In addition to backing up to Github, you should consider having regular backups of all your Home Assistant configuration files and images of your SD card if applicable. +

    +

    Important Best Practices

    +

    Some best practices to consider before putting your configuration on GitHub:

    +
      +
    • Extensive use of secrets.yaml to hide sensitive information like usernames, passwords, device information, and location
      • +
    • Exclusion of some files, including secrets.yaml and device-specific information using a .gitignore file
      • +
    • Regularly commiting your configuration to GitHub to make sure that your backup is up to date
      • +
    • Use a README.md to document your configuration and include screenshots of your Home Assistant GUI
      • +
    +

    Step 1: Installing and Initializing Git

    +

    In order to put your configuration on GitHub, you must install the git package on your Home Assistant server (instructions below will work on Raspberry Pi, Ubunutu, or any Debian-based system):

    +
    $ sudo apt-get update
+$ sudo apt-get install git
+
    +
    +

    Step 2: Creating .gitignore

    +

    +Before creating and pushing your Home Assistant configuration to GitHub, please make sure to follow the secrets.yaml best practice mentioned above and scrub your configuration for any passwords or sensitive information. +

    +

    Creating a .gitignore file in your repository will tell git which files NOT to push to the GitHub server. This should be used to prevent publishing sensitive files to the public. It should contain a list of filenames and pattern matches. This list should include at least your secrets.yaml file, device configuration files, and the Home Assistant database/directory structure. The .gitignore file should be placed in your Home Assistant directory.

    +

    Here is a sane example, but yours should be based on the files in your structure:

    +

    .gitignore

    +
    *.pid
+*.xml
+*.csr
+*.crt
+*.key
+www
+OZW_Log.txt
+home-assistant.log
+home-assistant_v2.db
+*.db-journal
+lib
+deps
+tts
+secrets.yaml
+known_devices.yaml
+*.conf
+plex.conf
+phue.conf
+harmony_media_room.conf
+pyozw.sqlite
+.*
+!/.gitignore
+
    +
    +

    More information on the layout of the file can be found in the .gitignore manual.

    +

    Step 3: Preparing your Home Assistant directory for GitHub

    +

    In your Home Assistant directory, type the following commands as the Home Assistant user, replacing the email address and name with your information:

    +
    $ git init
+$ git config user.email "you@example.com"
+$ git config user.name "Your Name"
+$ git add .
+$ git commit
+
    +
    +

    After the git commit command, you will be asked to enter a message for the commit. This will add a comment beside each file on GitHub describing the purpose for the commit. In this case, you can enter something like “Initial commit of my Home Assistant configuration.”

    +

    Step 4: Creating Repository on GitHub

    +
      +
    • Connect to GitHub and login to your account (or create an account if you don’t already have one).
      • +
    • Click “New Repository” and give your repository a name/description (Home-AssistantConfig is used in the example below). You do NOT need to change any other options.
      • +
    • Click “Create Repository”
      • +
    +

    Step 5: Your initial commit to GitHub

    +

    Once you are sure you are using secrets.yaml and .gitignore correctly, it is time to push your configuration to the GitHub Repository that you just created.

    +

    In your Home Assistant directory, type the following commands as the Home Assistant user, replacing “username” in the URL with your GitHub username:

    +
    $ git remote add origin https://github.com/username/Home-AssistantConfig
+$ git push -u origin master
+
    +
    +

    You will be asked to enter your GitHub username and password (or ssh key passphrase if you use GitHub with ssh).

    +

    Congratulations, you now have a copy of your current Home Assistant Configuration on GitHub!

    +

    Step 6: Keeping your repository up to date

    +

    You should update your repository on a regular basis; ideally after you make a major configuration change (new device, new component, etc.). The below script will update your repository with any changed configuration files and allow you to add a comment with the commit for tracking purposes:

    +

    +You may need to adjust the paths in the script depending on your Home Assistant configuration. +

    +

    gitupdate.sh

    +
    #!/bin/bash
+
+cd /home/homeassistant/.homeassistant
+source /srv/homeassistant/homeassistant_venv/bin/activate
+hass --script check_config
+
+git add .
+git status
+echo -n "Enter the Description for the Change: " [Minor Update]
+read CHANGE_MSG
+git commit -m "${CHANGE_MSG}"
+git push origin master
+
+exit
+
    +
    +

    Every time you run this script, you will be prompted for a comment to describe the change(s) that you are commiting. This comment will be displayed beside each changed file on GitHub and will be stored after each commit. You will also be asked to enter your GitHub username and password (or ssh key passphrase if you use GitHub with ssh).

    +

    Step 7: Configuration file testing

    +

    Travis CI is a continuous integration testing system that runs every time the code in your repository is updated and allows you to validate that your code works on a fresh install.

    +
      +
    • Authorise Travis CI to have access to your github repos.
      • +
    • Create the build script that travis will run to test your repo.
      • +
    • Create a dummy secrets.yaml for Travis.
      • +
    +

    Example .travis.yml

    +
    language: python
+python:
+  - "3.4"
+before_install:
+  - mv travis_secrets.yaml secrets.yaml
+install:
+  - pip3 install homeassistant
+script:
+  - hass -c . --script check_config
+
    +
    +

    Since the secrets.yaml should not be stored in your repo for security reasons, you won’t be able to access it at build time. Creating a dummy secrets.yaml is as simple as creating a new file that mimics your existing secrets.yaml with the required keys, but not their value.

    +
    #travis_secrets.yaml
+http_api: 000000000000000000000000
+home_latitude: 00.00000
+home_longitude: 00.0000
+home_elevation: 0
+
    +
    +

    Extra commands

    +

    You can enter these commands to get a list of the files in your local git repository and a status of files that have changed but not commited yet:

    +
    $ git ls-files
+$ git status
+
    +
    +

    Examples:

    +
    homeassistant@raspberrypi:~/.homeassistant $ git ls-files
+.gitignore
+README.md
+automation.yaml
+configuration.yaml
+customize.yaml
+device_tracker.yaml
+group.yaml
+script.yaml
+
+homeassistant@raspberrypi:~/.homeassistant $ git status
+On branch master
+Your branch is up-to-date with 'origin/master'.
+Changes not staged for commit:
+  (use "git add <file>..." to update what will be committed)
+  (use "git checkout -- <file>..." to discard changes in working directory)
+
+        modified:   .gitignore
+        modified:   automation.yaml
+        modified:   customize.yaml
+        modified:   group.yaml
+
+no changes added to commit (use "git add" and/or "git commit -a")
+
    +
    +
    +
    + +
    +
    + + + + diff --git a/docs/ecosystem/certificates/tls_domain_certificate/index.html b/docs/ecosystem/certificates/tls_domain_certificate/index.html new file mode 100644 index 0000000000..a5f9a506d2 --- /dev/null +++ b/docs/ecosystem/certificates/tls_domain_certificate/index.html @@ -0,0 +1,357 @@ + + + + + + + + + Certificate for SSL/TLS via domain ownership - Home Assistant + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + + + Home Assistant + +
    +
    + +
    +
    +
    +
    +
    +
    +
    +
    +
    Edit this page on GitHub
    +
    +

    + Certificate for SSL/TLS via Domain Ownership +

    +
    +
    +

    If your Home Assistant instance is only accessible from your local network you can still protect the communication between your browsers and the frontend with SSL/TLS. You can use Self-sign certificate but your browser will present a warning and some https-only features might not work.

    +

    Prerequirement for this guide

    +
      +
    • Your Home Assistant instance is not exposed to the internet. If it is - use this guide
      • +
    • You control a public domain name. The domain doesn’t have to point to a site. A domain controlled by a trusted friend will do. (A friend you trust not to MITM you)
      • +
    • Your home router supports custom DNS entries.
      • +
    +

    Run certbot

    +
    $ mkdir certbot
+$ cd certbot
+$ wget https://dl.eff.org/certbot-auto
+$ chmod a+x certbot-auto
+$ sudo ./certbot-auto --manual certonly --preferred-challenges dns -d "mydomain.com" --email your@email.address
+
    +
    +
      +
    • Agree to Terms of Service
      • +
    • Choose whether to share your email with Electronic Frontier Foundation.
      • +
    • Agree to your IP being logged
      • +
    +

    You will get the following text:

    +
    Please deploy a DNS TXT record under the name
+_acme-challenge.mydomain.com with the following value:
+
+deadbeefdeadbeefdeadbeefdeadbeefdeadbeef
+
+Once this is deployed,
+-------------------------------------------------------------------------------
+Press Enter to Continue
+
    +
    +
      +
    • Deploy the value to TXT field using your domain registar.
      • +
    • Go to a site that queries domain record. For example this one and look if it sees your brand new TXT field (Don’t forget to enter the full domain: _acme-challenge.mydomain.com)
      • +
    • Press Enter at certbot prompt.
      • +
    +

    Make mydomain.com point to your Home Assistant instance

    +

    If your router uses DNSMasq (for example DDWRT) add the following line to DNSMasq options:

    +
    address=/mydomain.com/<hass ip>
+
    +
    +

    Edit your Home Assistant configuration to use your certificates

    +

    The http section must contain the full path to the needed files.

    +
    http:
+  api_password: YOUR_SECRET_PASSWORD
+  base_url: https://mydomain.com:8123
+  ssl_certificate: /etc/letsencrypt/live/mydomain.com/fullchain.pem
+  ssl_key: /etc/letsencrypt/live/mydomain.com/privkey.pem
+
    +
    +

    Make sure the files are accessible by the user that runs Home Assistant, eg. homeassistant for a HASSbian setup.

    +
    +
    + +
    +
    + + + + diff --git a/docs/ecosystem/certificates/tls_self_signed_certificate/index.html b/docs/ecosystem/certificates/tls_self_signed_certificate/index.html new file mode 100644 index 0000000000..7c78366cd3 --- /dev/null +++ b/docs/ecosystem/certificates/tls_self_signed_certificate/index.html @@ -0,0 +1,321 @@ + + + + + + + + + Self-signed certificate for SSL/TLS - Home Assistant + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + + + Home Assistant + +
    +
    + +
    +
    +
    +
    +
    +
    +
    +
    +
    Edit this page on GitHub
    +
    +

    + Self-signed Certificate for SSL/TLS +

    +
    +
    +

    If your Home Assistant instance is only accessible from your local network you can still protect the communication between your browsers and the frontend with SSL/TLS. Let’s encrypt will only work if you have a DNS entry and remote access is allowed. The solution is to use a self-signed certificate. As you most likely don’t have a certification authority (CA) your browser will conplain about the security. If you have a CA then this will not be an issue.

    +

    To create locally a certificate you need the OpenSSL command-line tool.

    +

    Change to your Home Assistant configuration directory like ~/.homeassistant. This will make it easier to backup your certificate and the key. Run the command shown below.

    +
    $ openssl req -new -x509 -sha256 -newkey rsa:4096 -nodes -keyout privkey.pem -days 730 -out fullchain.pem
+
    +
    +

    For details about the parameters, please check the OpenSSL documentation. Provide the requested information during the generation process. At the end you will have two files called privkey.pem and fullchain.pem. The key and the certificate.

    +

    Update the http: entry in your configuration.yaml file and let it point to your created files.

    +
    http:
+  api_password: YOUR_SECRET_PASSWORD
+  ssl_certificate: /home/fab/.homeassistant/fullchain.pem
+  ssl_key: /home/fab/.homeassistant/privkey.pem
+
    +
    +

    A tutorial “Working with SSL Certificates, Private Keys and CSRs” could give you some insight about special cases.

    +
    +
    + +
    +
    + + + + diff --git a/docs/ecosystem/hadashboard/dash_config/index.html b/docs/ecosystem/hadashboard/dash_config/index.html index 4483f4ebc3..18b59bad34 100644 --- a/docs/ecosystem/hadashboard/dash_config/index.html +++ b/docs/ecosystem/hadashboard/dash_config/index.html @@ -446,9 +446,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/ecosystem/hadashboard/hapush/index.html b/docs/ecosystem/hadashboard/hapush/index.html index 0408646886..02da21ef28 100644 --- a/docs/ecosystem/hadashboard/hapush/index.html +++ b/docs/ecosystem/hadashboard/hapush/index.html @@ -316,9 +316,24 @@ logfile = "/etc/hapush/hapush.log"
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/ecosystem/hadashboard/index.html b/docs/ecosystem/hadashboard/index.html index 42019baf39..53b305fcab 100644 --- a/docs/ecosystem/hadashboard/index.html +++ b/docs/ecosystem/hadashboard/index.html @@ -256,9 +256,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/ecosystem/hadashboard/installation/index.html b/docs/ecosystem/hadashboard/installation/index.html index ff5a9a950b..b7abe920b1 100644 --- a/docs/ecosystem/hadashboard/installation/index.html +++ b/docs/ecosystem/hadashboard/installation/index.html @@ -344,9 +344,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/ecosystem/hadashboard/reboot/index.html b/docs/ecosystem/hadashboard/reboot/index.html index cc83ba4ada..6a691b66a9 100644 --- a/docs/ecosystem/hadashboard/reboot/index.html +++ b/docs/ecosystem/hadashboard/reboot/index.html @@ -253,9 +253,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/ecosystem/hadashboard/updating/index.html b/docs/ecosystem/hadashboard/updating/index.html index b290b62bae..0d04c8ebf1 100644 --- a/docs/ecosystem/hadashboard/updating/index.html +++ b/docs/ecosystem/hadashboard/updating/index.html @@ -259,9 +259,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/ecosystem/index.html b/docs/ecosystem/index.html index 110d200494..5b642e03c6 100644 --- a/docs/ecosystem/index.html +++ b/docs/ecosystem/index.html @@ -251,9 +251,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/ecosystem/ios/devices_file/index.html b/docs/ecosystem/ios/devices_file/index.html index 3f5b935216..24cda6a43d 100644 --- a/docs/ecosystem/ios/devices_file/index.html +++ b/docs/ecosystem/ios/devices_file/index.html @@ -251,9 +251,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/ecosystem/ios/index.html b/docs/ecosystem/ios/index.html index 8439f6ac9d..2735c40074 100644 --- a/docs/ecosystem/ios/index.html +++ b/docs/ecosystem/ios/index.html @@ -290,9 +290,24 @@ Currently, the app is only available via a closed beta. It will be on the App St
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/ecosystem/ios/integration/index.html b/docs/ecosystem/ios/integration/index.html index 61075c6743..0295b8fb0a 100644 --- a/docs/ecosystem/ios/integration/index.html +++ b/docs/ecosystem/ios/integration/index.html @@ -258,9 +258,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/ecosystem/ios/location/index.html b/docs/ecosystem/ios/location/index.html index 0ee0544282..6b2121a852 100644 --- a/docs/ecosystem/ios/location/index.html +++ b/docs/ecosystem/ios/location/index.html @@ -267,9 +267,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/ecosystem/ios/notifications/actions/index.html b/docs/ecosystem/ios/notifications/actions/index.html index 73f8ba385a..296c6b00a4 100644 --- a/docs/ecosystem/ios/notifications/actions/index.html +++ b/docs/ecosystem/ios/notifications/actions/index.html @@ -372,9 +372,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/ecosystem/ios/notifications/architecture/index.html b/docs/ecosystem/ios/notifications/architecture/index.html index 1241ec4bfe..ff890f33ed 100644 --- a/docs/ecosystem/ios/notifications/architecture/index.html +++ b/docs/ecosystem/ios/notifications/architecture/index.html @@ -254,9 +254,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/ecosystem/ios/notifications/attachments/index.html b/docs/ecosystem/ios/notifications/attachments/index.html index 9fef3aa2cb..198da006c3 100644 --- a/docs/ecosystem/ios/notifications/attachments/index.html +++ b/docs/ecosystem/ios/notifications/attachments/index.html @@ -300,9 +300,24 @@ To expand a notification on 3D Touch devices simply force touch any notification
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/ecosystem/ios/notifications/basic/index.html b/docs/ecosystem/ios/notifications/basic/index.html index d4e8de98f9..71baf6e796 100644 --- a/docs/ecosystem/ios/notifications/basic/index.html +++ b/docs/ecosystem/ios/notifications/basic/index.html @@ -294,9 +294,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/ecosystem/ios/notifications/content_extensions/index.html b/docs/ecosystem/ios/notifications/content_extensions/index.html index 02dd8569b2..be34c4b46b 100644 --- a/docs/ecosystem/ios/notifications/content_extensions/index.html +++ b/docs/ecosystem/ios/notifications/content_extensions/index.html @@ -288,9 +288,24 @@ The notification content is a real time MJPEG stream of a camera (assuming the c
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/ecosystem/ios/notifications/index.html b/docs/ecosystem/ios/notifications/index.html index b8ce87fc71..a094344c25 100644 --- a/docs/ecosystem/ios/notifications/index.html +++ b/docs/ecosystem/ios/notifications/index.html @@ -252,9 +252,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/ecosystem/ios/notifications/privacy_security_rate_limits/index.html b/docs/ecosystem/ios/notifications/privacy_security_rate_limits/index.html index 24ae579728..2ac5e6fc6f 100644 --- a/docs/ecosystem/ios/notifications/privacy_security_rate_limits/index.html +++ b/docs/ecosystem/ios/notifications/privacy_security_rate_limits/index.html @@ -256,9 +256,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/ecosystem/ios/notifications/requesting_location_updates/index.html b/docs/ecosystem/ios/notifications/requesting_location_updates/index.html index f116d7b859..46131c7880 100644 --- a/docs/ecosystem/ios/notifications/requesting_location_updates/index.html +++ b/docs/ecosystem/ios/notifications/requesting_location_updates/index.html @@ -265,9 +265,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/ecosystem/ios/notifications/sounds/index.html b/docs/ecosystem/ios/notifications/sounds/index.html index 43f443daf7..f8cbb97a91 100644 --- a/docs/ecosystem/ios/notifications/sounds/index.html +++ b/docs/ecosystem/ios/notifications/sounds/index.html @@ -420,9 +420,24 @@ US-EN-Morgan-Freeman-Wife-Is-Arriving.wav
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/ecosystem/nginx/index.html b/docs/ecosystem/nginx/index.html index dba4f834b4..7266c9f50f 100644 --- a/docs/ecosystem/nginx/index.html +++ b/docs/ecosystem/nginx/index.html @@ -345,9 +345,24 @@ sudo ln ../sites-available/hass default
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/ecosystem/notebooks/api/index.html b/docs/ecosystem/notebooks/api/index.html index 52f37ddc53..7cd5cf37ee 100644 --- a/docs/ecosystem/notebooks/api/index.html +++ b/docs/ecosystem/notebooks/api/index.html @@ -251,9 +251,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/ecosystem/notebooks/database/index.html b/docs/ecosystem/notebooks/database/index.html index e071d678fa..0691804c48 100644 --- a/docs/ecosystem/notebooks/database/index.html +++ b/docs/ecosystem/notebooks/database/index.html @@ -251,9 +251,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/ecosystem/notebooks/graph/index.html b/docs/ecosystem/notebooks/graph/index.html index d80d913489..f34258058f 100644 --- a/docs/ecosystem/notebooks/graph/index.html +++ b/docs/ecosystem/notebooks/graph/index.html @@ -251,9 +251,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/ecosystem/notebooks/index.html b/docs/ecosystem/notebooks/index.html index 06745451fd..7f177fdd8c 100644 --- a/docs/ecosystem/notebooks/index.html +++ b/docs/ecosystem/notebooks/index.html @@ -256,9 +256,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/ecosystem/notebooks/installation/index.html b/docs/ecosystem/notebooks/installation/index.html index 99a726a429..dc92021f5e 100644 --- a/docs/ecosystem/notebooks/installation/index.html +++ b/docs/ecosystem/notebooks/installation/index.html @@ -276,9 +276,24 @@ Certain notebooks hosted in the + + + + + + + Tor Onion Service Configuration - Home Assistant + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + + + Home Assistant + +
    +
    + +
    +
    +
    +
    +
    +
    +
    +
    +
    Edit this page on GitHub
    +
    +

    + Tor Onion Service Configuration +

    +
    +
    +

    This is an example about how you can configure Tor to provide secure remote access to your Home Assistant instance as an Onion site, through Tor’s Hidden Service feature. With this enabled, you do not need to open your firewall ports or setup HTTPS to enable secure remote access.

    +

    This is useful if you want to have:

    +
      +
    • Access your Home Assistant instance remotely without opening a firewall port or setting up a VPN
      • +
    • Don’t want to or know how to get an SSL/TLS certificate and HTTPS configuration setup
      • +
    • Want to block attackers from even being able to access/scan your port and server at all
      • +
    • Want to block anyone from knowing your home IP address and seeing your traffic to your Home Assistant
      • +
    +

    Background and Contact

    +

    This configuration is part of an effort to apply strong cryptography technologies (like Onion Routing and End-to-End Encryption) to technology we increasingly depend on in our day to day lives. Just like when WhatsApp enabled end-to-end encryption messaging for everyone, every home automation and IoT platform should do the same, because A) the technology is all there, freely licensed and open-source and B) up to this point, all the commercial manufacturers have been doing a horrific job with security.

    +

    You can learn more about how Tor can be used to secure home automation and IoT platforms through this short set of slides on the Internet of Onion Things

    +

    Hidden Services and Onion Sites

    +

    Tor allows clients and relays to offer hidden services. That is, you can offer a web server, SSH server, etc., without revealing your IP address to its users. In fact, because you don’t use any public address, you can run a hidden service from behind your firewall. Learn more about Hidden Services on the Tor Project website.

    +

    Onion sites are websites that run on a Tor Hidden Service node. “dot onion” sites are an IETF recognized special use domain name.

    +

    Setting up Tor on your Home Assistant

    +

    First, install Tor. On a Debian-based system, you can install the package easily:

    +
    $ sudo apt-get install tor
+
    +
    +

    You can find more instructions for downloading and installing Tor on other platforms on the Tor Project Download Page.

    +

    Next, modify Tor’s main configuration file /etc/tor/torrc to include the following lines:

    +
    ############### This section is just for location-hidden services ###
+
+## Once you have configured a hidden service, you can look at the
+## contents of the file ".../hidden_service/hostname" for the address
+## to tell people.
+...
+HiddenServiceDir /var/lib/tor/homeassistant/
+HiddenServicePort 80 127.0.0.1:8123
+HiddenServiceAuthorizeClient stealth haremote1
+...
+
    +
    +

    The “stealth” entry above ensures traffic to and from your Home Assistant instance over Tor, is hidden even from other nodes on the Tor network. The haremote1 value is a generic client name entry that you can modify as you please.

    +

    Then, restart Tor:

    +
    $ sudo /etc/init.d/tor restart
+
    +
    +

    Then read the new generated authentication cookie from the Tor-generated hostname file:

    +
    $ sudo more /var/lib/tor/homeassistant/hostname
+
    +
    +

    The output of that command should look something like this, but with your own unique “dot onion” domain and authentication cookie:

    +
    abcdef1234567890.onion ABCDEF1122334455667789 # client: haremote1
+
    +
    +

    You are now done with the Home Assistant Tor server configuration. Make sure your Home Assistant instance is running, and now you can move to client configuration.

    +

    Tor Client Access Setup

    +

    Using this setup, you can access your Home Assistant instance over Tor from your laptop or mobile device, using Tor Browser and other software.

    +

    Add the authentication cookie to your torrc client configuration on your laptop or mobile device. Using the sample values from above, it would look like this:

    +
    HidServAuth abcdef1234567890.onion ABCDEF1122334455667789
+
    +
    +

    For Tor Browser on Windows, Mac or Linux, you can find the torrc file here: <tor browser install directory>/Browser/TorBrowser/Data/Tor/torrc-defaults

    +

    Once you have added the entry, restart the browser, and then browse to the “dot onion” site address to connect to your Home Assistant instance.

    +

    For Orbot: Tor on Android, add it in Orbot -> Menu -> Settings to the “Torrc Custom Config” entry. Restart Orbot, and then use the Orfox browser app, and browse to the “dot onion” site name to access your Home Assistant instance. You can also use Orbot’s VPN mode, to enable Tor access from any application on your device, such as Tasker or Owntracks.

    +

    On iOS, we have not fully tested this yet, but you should be able to add custom torrc entries on Onion Browser, Red Onion or TOBY browsers, all available in the iTunes App Store.

    +

    Some More Advanced Ideas

    +

    With this configuration, only you can access your Home Assistant instance Onion site through Tor, and no one else. You can share the authentication cookie with multiple devices and users, or you can generate a unique one for each - up to you! If you have multiple, say for an industrial, business or corporate configuration, this would provide an easy way to revoke access to a specific user or device.

    +

    If you always access your Home Assistant instance via Tor, you can easily run this on an isolated “IoT” network segment at your install site, keeping your internal home network traffic separate from any potentially compromised devices (like cheap “smart” lightbulbs with backdoors!).

    +

    You could also use Tor as a means to connect your Home Assistant instance to a remote device, sensor or other service that you do not want to or connect provide a direct, open IP connection to. Again, Tor provides authenticated and confidential routing (aka “privacy and encryption”) by default, without having to setup TLS/SSL or VPN. It is just important to secure IoT nodes within your network, as it is to secure remote access!

    +

    As mentioned, with Orbot on Android, you can enable a “full device” VPN mode, that allows any app you have to tunnel through Tor, even if it is not Tor or proxy aware. This means you should be able to enter your “dot onion” Onion site address into any app you want to access to your Home Assistant instance, and it should work.

    +

    This configuration was provided by @n8fr8 (github, twitter) of the Guardian Project and Tor Project. You can send questions, feedback and ideas to support@guardianproject.info.

    +
    +
    + +
    +
    + + + + diff --git a/docs/frontend/browsers/index.html b/docs/frontend/browsers/index.html index a73f5f9024..d3939807e9 100644 --- a/docs/frontend/browsers/index.html +++ b/docs/frontend/browsers/index.html @@ -461,9 +461,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/frontend/index.html b/docs/frontend/index.html index 222218782e..eec7066bfe 100644 --- a/docs/frontend/index.html +++ b/docs/frontend/index.html @@ -256,9 +256,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/frontend/mobile/index.html b/docs/frontend/mobile/index.html index 88adcd52af..eeda9368db 100644 --- a/docs/frontend/mobile/index.html +++ b/docs/frontend/mobile/index.html @@ -270,9 +270,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/frontend/webserver/index.html b/docs/frontend/webserver/index.html index 6a30f0ef2c..0a83bd40cf 100644 --- a/docs/frontend/webserver/index.html +++ b/docs/frontend/webserver/index.html @@ -274,9 +274,24 @@ Nmap done: 1 IP address (1 host up
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/hassbian/common-tasks/index.html b/docs/hassbian/common-tasks/index.html index 04ffdc3536..d9a789f12b 100644 --- a/docs/hassbian/common-tasks/index.html +++ b/docs/hassbian/common-tasks/index.html @@ -337,9 +337,24 @@ Log in as the pi account and execute the
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/hassbian/customization/index.html b/docs/hassbian/customization/index.html index b4ef7e043d..43e311549e 100644 --- a/docs/hassbian/customization/index.html +++ b/docs/hassbian/customization/index.html @@ -258,9 +258,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/hassbian/index.html b/docs/hassbian/index.html index ac8dca67a0..25d9e3768c 100644 --- a/docs/hassbian/index.html +++ b/docs/hassbian/index.html @@ -257,9 +257,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/hassbian/installation/index.html b/docs/hassbian/installation/index.html index 96fb14ebae..4c6cd59432 100644 --- a/docs/hassbian/installation/index.html +++ b/docs/hassbian/installation/index.html @@ -270,9 +270,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/hassbian/integrations/index.html b/docs/hassbian/integrations/index.html index d0bcbdb0a8..d46485e597 100644 --- a/docs/hassbian/integrations/index.html +++ b/docs/hassbian/integrations/index.html @@ -312,9 +312,24 @@ To enable One Wire support add the following line to the end of pi account and execute the
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/index.html b/docs/index.html index 3d36487c4a..7286a276cc 100644 --- a/docs/index.html +++ b/docs/index.html @@ -291,9 +291,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/installation/archlinux/index.html b/docs/installation/archlinux/index.html index 316bf896ab..680b9d2eba 100644 --- a/docs/installation/archlinux/index.html +++ b/docs/installation/archlinux/index.html @@ -264,9 +264,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/installation/armbian/index.html b/docs/installation/armbian/index.html index 6bfc6c50ee..a582e3bc59 100644 --- a/docs/installation/armbian/index.html +++ b/docs/installation/armbian/index.html @@ -260,9 +260,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/installation/centos/index.html b/docs/installation/centos/index.html index 8b6eca0d77..7ec4239d45 100644 --- a/docs/installation/centos/index.html +++ b/docs/installation/centos/index.html @@ -288,9 +288,24 @@ WantedBy=multi-user.target
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/installation/docker/index.html b/docs/installation/docker/index.html index d6c69464d0..d42e913bc6 100644 --- a/docs/installation/docker/index.html +++ b/docs/installation/docker/index.html @@ -304,9 +304,24 @@ netsh interface portproxy add v4tov4 listenaddress=0.0.0.0 listenport=8123 conne
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/installation/fedora/index.html b/docs/installation/fedora/index.html index 5e4dd51340..14f63a78b9 100644 --- a/docs/installation/fedora/index.html +++ b/docs/installation/fedora/index.html @@ -259,9 +259,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/installation/index.html b/docs/installation/index.html index d4a04c5539..901ffc3d5c 100644 --- a/docs/installation/index.html +++ b/docs/installation/index.html @@ -327,9 +327,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/installation/macos/index.html b/docs/installation/macos/index.html index a982f76282..927d7a3391 100644 --- a/docs/installation/macos/index.html +++ b/docs/installation/macos/index.html @@ -257,9 +257,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/installation/python/index.html b/docs/installation/python/index.html index 8fe471e9d5..c2d2931a0c 100644 --- a/docs/installation/python/index.html +++ b/docs/installation/python/index.html @@ -267,9 +267,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/installation/raspberry-pi-all-in-one/index.html b/docs/installation/raspberry-pi-all-in-one/index.html index c8d9f86f65..346fd33a78 100644 --- a/docs/installation/raspberry-pi-all-in-one/index.html +++ b/docs/installation/raspberry-pi-all-in-one/index.html @@ -352,9 +352,24 @@ Don’t check the USB box regardless of using a USB based device.
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/installation/raspberry-pi/index.html b/docs/installation/raspberry-pi/index.html index 553f329bdd..ac32a479d3 100644 --- a/docs/installation/raspberry-pi/index.html +++ b/docs/installation/raspberry-pi/index.html @@ -296,9 +296,24 @@ Since this account is only for running Home Assistant the extra arguments of Integration with other apps -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/installation/synology/index.html b/docs/installation/synology/index.html index b755dd0240..e6df9cd270 100644 --- a/docs/installation/synology/index.html +++ b/docs/installation/synology/index.html @@ -451,9 +451,24 @@ That’s it… you’re all set to go

  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/installation/troubleshooting/index.html b/docs/installation/troubleshooting/index.html index 3b7d8657be..39b35d1d46 100644 --- a/docs/installation/troubleshooting/index.html +++ b/docs/installation/troubleshooting/index.html @@ -292,9 +292,24 @@ chrome -> settings -> site settings -> storage -> search for your UR
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/installation/updating/index.html b/docs/installation/updating/index.html index d964656495..413786cb11 100644 --- a/docs/installation/updating/index.html +++ b/docs/installation/updating/index.html @@ -275,9 +275,24 @@ The upgrade process differs depending on the installation you have, so please re
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/installation/vagrant/index.html b/docs/installation/vagrant/index.html index 80d56b1808..85a8cc760c 100644 --- a/docs/installation/vagrant/index.html +++ b/docs/installation/vagrant/index.html @@ -308,9 +308,24 @@ This command will only restart the Home Assistant process inside the Vagrant VM,
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/installation/virtualenv/index.html b/docs/installation/virtualenv/index.html index 1c5ebbabd1..f4964f605f 100644 --- a/docs/installation/virtualenv/index.html +++ b/docs/installation/virtualenv/index.html @@ -329,9 +329,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/installation/windows/index.html b/docs/installation/windows/index.html index 82b31e4395..5286a305ef 100644 --- a/docs/installation/windows/index.html +++ b/docs/installation/windows/index.html @@ -261,9 +261,24 @@ The Microsoft Windows platform is not a primary target to install home Assistant
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/mqtt/birth_will/index.html b/docs/mqtt/birth_will/index.html index f810ea8d46..f1cea79d91 100644 --- a/docs/mqtt/birth_will/index.html +++ b/docs/mqtt/birth_will/index.html @@ -281,9 +281,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/mqtt/broker/index.html b/docs/mqtt/broker/index.html index 9cd2c94832..ed97dc1cf2 100644 --- a/docs/mqtt/broker/index.html +++ b/docs/mqtt/broker/index.html @@ -372,9 +372,24 @@ Home Assistant will automatically load the correct certificate if you connect to
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/mqtt/certificate/index.html b/docs/mqtt/certificate/index.html index d1d2511a92..196b23f414 100644 --- a/docs/mqtt/certificate/index.html +++ b/docs/mqtt/certificate/index.html @@ -263,9 +263,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/mqtt/discovery/index.html b/docs/mqtt/discovery/index.html index 97bbd5d032..f8c4729752 100644 --- a/docs/mqtt/discovery/index.html +++ b/docs/mqtt/discovery/index.html @@ -288,9 +288,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/mqtt/index.html b/docs/mqtt/index.html index 0bc553ced0..fd0331a4ed 100644 --- a/docs/mqtt/index.html +++ b/docs/mqtt/index.html @@ -268,9 +268,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/mqtt/logging/index.html b/docs/mqtt/logging/index.html index 182aed9789..f35724d297 100644 --- a/docs/mqtt/logging/index.html +++ b/docs/mqtt/logging/index.html @@ -258,9 +258,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/mqtt/processing_json/index.html b/docs/mqtt/processing_json/index.html index bd57f89237..d844369376 100644 --- a/docs/mqtt/processing_json/index.html +++ b/docs/mqtt/processing_json/index.html @@ -286,9 +286,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/mqtt/service/index.html b/docs/mqtt/service/index.html index 446add8f84..4b1c2add20 100644 --- a/docs/mqtt/service/index.html +++ b/docs/mqtt/service/index.html @@ -263,9 +263,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/mqtt/testing/index.html b/docs/mqtt/testing/index.html index f826be520d..41f4b4b6a7 100644 --- a/docs/mqtt/testing/index.html +++ b/docs/mqtt/testing/index.html @@ -282,9 +282,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/scripts/conditions/index.html b/docs/scripts/conditions/index.html index 3bd01a4626..859d68d7c6 100644 --- a/docs/scripts/conditions/index.html +++ b/docs/scripts/conditions/index.html @@ -379,9 +379,24 @@ Time condition windows can span across the midnight threshold. In the example ab
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/scripts/index.html b/docs/scripts/index.html index f95a3ba4c9..d35cf48785 100644 --- a/docs/scripts/index.html +++ b/docs/scripts/index.html @@ -322,9 +322,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/scripts/service-calls/index.html b/docs/scripts/service-calls/index.html index 6b6a94eef8..a1a4ba8a65 100644 --- a/docs/scripts/service-calls/index.html +++ b/docs/scripts/service-calls/index.html @@ -302,9 +302,24 @@ Service Data: {Integration with other apps -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/tools/dev-tools/index.html b/docs/tools/dev-tools/index.html index 7733256ba0..04879b4e3a 100644 --- a/docs/tools/dev-tools/index.html +++ b/docs/tools/dev-tools/index.html @@ -291,9 +291,24 @@ Screenshot of Home Assistant’s Developer Tools.
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/tools/hass/index.html b/docs/tools/hass/index.html index 1f8a0b4b8c..fb7b97951c 100644 --- a/docs/tools/hass/index.html +++ b/docs/tools/hass/index.html @@ -280,9 +280,24 @@ optional arguments:
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/tools/index.html b/docs/tools/index.html index 6bd6bcd912..061c33967c 100644 --- a/docs/tools/index.html +++ b/docs/tools/index.html @@ -251,9 +251,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/tools/scripts/index.html b/docs/tools/scripts/index.html index 4e97227148..a59e5e1141 100644 --- a/docs/tools/scripts/index.html +++ b/docs/tools/scripts/index.html @@ -272,9 +272,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/z-wave/controllers/index.html b/docs/z-wave/controllers/index.html index 0184e3f05b..dbaa839219 100644 --- a/docs/z-wave/controllers/index.html +++ b/docs/z-wave/controllers/index.html @@ -303,9 +303,24 @@ Upon first run, the zwave component will
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/z-wave/device-specific/index.html b/docs/z-wave/device-specific/index.html index 01a8833c2c..5b7f1c482a 100644 --- a/docs/z-wave/device-specific/index.html +++ b/docs/z-wave/device-specific/index.html @@ -344,9 +344,24 @@ Make sure you copy the newly saved zwcfg_[home_i
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/z-wave/index.html b/docs/z-wave/index.html index ae8273c2ea..ff573b870f 100644 --- a/docs/z-wave/index.html +++ b/docs/z-wave/index.html @@ -511,9 +511,24 @@ Depending on what’s plugged into your USB ports, the name found above may chan
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/docs/z-wave/settings/index.html b/docs/z-wave/settings/index.html index 6ad3dd47ce..add1a02f40 100644 --- a/docs/z-wave/settings/index.html +++ b/docs/z-wave/settings/index.html @@ -262,9 +262,24 @@
  • Integration with other apps
    • -
  • NGINX
    • +
  • + Remote access + +
    • +
  • + Certificates + +
  • scenegen
  • Synology
    • +
  • Backup to GitHub
    • diff --git a/sitemap.xml b/sitemap.xml index 5e389478f6..d62ed99d13 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -2593,15 +2593,9 @@ https://home-assistant.io/cookbook/configuration_yaml_by_geekofweek/ -https://home-assistant.io/cookbook/apache_configuration/ - - https://home-assistant.io/cookbook/configuration_yaml_by_cbulock/ -https://home-assistant.io/cookbook/tor_configuration/ - - https://home-assistant.io/cookbook/configuration_yaml_by_gstevenson/ @@ -2629,9 +2623,6 @@ https://home-assistant.io/cookbook/configuration_yaml_by_instagraeme/ -https://home-assistant.io/cookbook/tls_self_signed_certificate/ - - https://home-assistant.io/cookbook/configuration_yaml_by_mertenats/ @@ -2650,9 +2641,6 @@ https://home-assistant.io/cookbook/configuration_yaml_by_cy1701/ -https://home-assistant.io/cookbook/githubbackup/ - - https://home-assistant.io/cookbook/sonos_say/ @@ -2662,9 +2650,6 @@ https://home-assistant.io/cookbook/automation_telegram_presence_alert/ -https://home-assistant.io/cookbook/tls_domain_certificate/ - - https://home-assistant.io/cookbook/configuration_yaml_by_jjmontesl/ @@ -2818,12 +2803,18 @@ https://home-assistant.io/docs/installation/vagrant/ +https://home-assistant.io/docs/ecosystem/apache/ + + https://home-assistant.io/docs/frontend/browsers/ https://home-assistant.io/docs/configuration/secrets/ +https://home-assistant.io/docs/ecosystem/tor/ + + https://home-assistant.io/docs/ecosystem/notebooks/api/ @@ -2863,6 +2854,9 @@ https://home-assistant.io/docs/configuration/securing/ +https://home-assistant.io/docs/ecosystem/certificates/tls_self_signed_certificate/ + + https://home-assistant.io/docs/frontend/webserver/ @@ -2914,6 +2908,9 @@ https://home-assistant.io/docs/configuration/group_visibility/ +https://home-assistant.io/docs/ecosystem/backup/backup_github/ + + https://home-assistant.io/docs/configuration/packages/ @@ -2929,6 +2926,9 @@ https://home-assistant.io/docs/mqtt/ +https://home-assistant.io/docs/ecosystem/certificates/tls_domain_certificate/ + + https://home-assistant.io/docs/installation/armbian/ @@ -3029,62 +3029,62 @@ https://home-assistant.io/demo/frontend.html -2017-03-25T16:16:17+00:00 +2017-03-25T18:20:12+00:00 https://home-assistant.io/demo/index.html -2017-03-25T16:16:17+00:00 +2017-03-25T18:20:12+00:00 https://home-assistant.io/demo/panels/ha-panel-dev-event.html -2017-03-25T16:16:17+00:00 +2017-03-25T18:20:12+00:00 https://home-assistant.io/demo/panels/ha-panel-dev-info.html -2017-03-25T16:16:17+00:00 +2017-03-25T18:20:12+00:00 https://home-assistant.io/demo/panels/ha-panel-dev-service.html -2017-03-25T16:16:17+00:00 +2017-03-25T18:20:12+00:00 https://home-assistant.io/demo/panels/ha-panel-dev-state.html -2017-03-25T16:16:17+00:00 +2017-03-25T18:20:12+00:00 https://home-assistant.io/demo/panels/ha-panel-dev-template.html -2017-03-25T16:16:17+00:00 +2017-03-25T18:20:12+00:00 https://home-assistant.io/demo/panels/ha-panel-history.html -2017-03-25T16:16:17+00:00 +2017-03-25T18:20:12+00:00 https://home-assistant.io/demo/panels/ha-panel-iframe.html -2017-03-25T16:16:17+00:00 +2017-03-25T18:20:12+00:00 https://home-assistant.io/demo/panels/ha-panel-logbook.html -2017-03-25T16:16:17+00:00 +2017-03-25T18:20:12+00:00 https://home-assistant.io/demo/panels/ha-panel-map.html -2017-03-25T16:16:17+00:00 +2017-03-25T18:20:12+00:00 https://home-assistant.io/googlef4f3693c209fe788.html -2017-03-25T16:16:17+00:00 +2017-03-25T18:20:12+00:00 https://home-assistant.io/static/fonts/roboto/DESCRIPTION.en_us.html -2017-03-25T16:16:17+00:00 +2017-03-25T18:20:12+00:00 https://home-assistant.io/static/fonts/robotomono/DESCRIPTION.en_us.html -2017-03-25T16:16:17+00:00 +2017-03-25T18:20:12+00:00 https://home-assistant.io/static/mdi-demo.html -2017-03-25T16:16:17+00:00 +2017-03-25T18:20:12+00:00