diff --git a/_config.yml b/_config.yml index 3a0c2352dc6..129ff970094 100644 --- a/_config.yml +++ b/_config.yml @@ -128,9 +128,9 @@ social: # Home Assistant release details current_major_version: 0 current_minor_version: 39 -current_patch_version: 2 -date_released: 2017-03-01 +current_patch_version: 3 +date_released: 2017-03-04 # Either # or the anchor link to latest release notes in the blog post. # Must be prefixed with a # and have double quotes around it. -patch_version_notes: "#release-0392---march-1" +patch_version_notes: "#release-0393---march-4" diff --git a/source/_components/binary_sensor.nx584.markdown b/source/_components/binary_sensor.nx584.markdown index b0a7326c8b1..cce9c46eb0f 100644 --- a/source/_components/binary_sensor.nx584.markdown +++ b/source/_components/binary_sensor.nx584.markdown @@ -48,3 +48,4 @@ binary_sensor: 2: opening 4: motion 6: moisture +``` diff --git a/source/_components/climate.honeywell.markdown b/source/_components/climate.honeywell.markdown index 82d7a40f81c..1b7a7465360 100644 --- a/source/_components/climate.honeywell.markdown +++ b/source/_components/climate.honeywell.markdown @@ -21,11 +21,16 @@ climate: platform: honeywell username: YOUR_USERNAME password: YOUR_PASSWORD + scan_interval: 600 ``` +

+Scan interval is expressed in seconds. Omitting scan_interval may result in too-frequent polling and cause you to rate-limited by Honeywell. +

Configuration variables: - **username** (*Required*): The username of an user with access. - **password** (*Required*): The password for your given admin account. -- **away_temperature** (*optional*): Heating setpoint when away mode is on. If omitted it defaults to 16.0 deg C. -- **region** (*optional*): Region identifier (either 'eu' or 'us'). Defaults to 'eu' if not provided. +- **away_temperature** (*Optional*): Heating setpoint when away mode is on. If omitted it defaults to 16.0 deg C. +- **region** (*Optional*): Region identifier (either 'eu' or 'us'). Defaults to 'eu' if not provided. +- **scan_interval**(*Optional*): Scan interval is expressed in seconds. Recommended value of 600 seconds. Default value is 120 seconds. Omitting scan_interval may result in too-frequent polling and cause you to rate-limited by Honeywell. diff --git a/source/_components/device_tracker.asuswrt.markdown b/source/_components/device_tracker.asuswrt.markdown index 27f5281ea75..a49a0663097 100644 --- a/source/_components/device_tracker.asuswrt.markdown +++ b/source/_components/device_tracker.asuswrt.markdown @@ -35,6 +35,7 @@ Configuration variables: - **username** (*Required*: The username of an user with administrative privileges, usually `admin`. - **password** (*Optional*): The password for your given admin account (use this if no SSH key is given). - **protocol** (*Optional*): The protocol (`ssh` or `telnet`) to use. Defaults to `ssh`. +- **port** (*Optional*): SSH port to use. Defaults to `22`. - **mode** (*Optional*): The operating mode of the router (`router` or `ap`). Defaults to `router`. - **ssh_key** (*Optional*): The path to your SSH private key file associated with your given admin account (instead of password). diff --git a/source/_components/sensor.pocketcasts.markdown b/source/_components/sensor.pocketcasts.markdown index 37769f6739f..3a8951443e1 100644 --- a/source/_components/sensor.pocketcasts.markdown +++ b/source/_components/sensor.pocketcasts.markdown @@ -7,6 +7,7 @@ sidebar: true comments: false sharing: true footer: true +logo: pocketcasts.png ha_category: Sensor ha_release: 0.39 --- diff --git a/source/_components/switch.broadlink.markdown b/source/_components/switch.broadlink.markdown index cd7d36aa457..4a56445d2b3 100644 --- a/source/_components/switch.broadlink.markdown +++ b/source/_components/switch.broadlink.markdown @@ -150,7 +150,7 @@ First get or learn all the remotes you want to add on HA in E-Control 1. Download - Get the script from [here](https://github.com/NightRang3r/Broadlink-e-control-db-dump5). + Get the script from [here](https://github.com/NightRang3r/Broadlink-e-control-db-dump). 2. Dump the data from the app diff --git a/source/_components/switch.tplink.markdown b/source/_components/switch.tplink.markdown index 9d70ebb1466..9af82a469d3 100644 --- a/source/_components/switch.tplink.markdown +++ b/source/_components/switch.tplink.markdown @@ -28,7 +28,7 @@ To use your TPLink switch in your installation, add the following to your `confi # Example configuration.yaml entry switch: - platform: tplink - host: IP_ADRRESS + host: IP_ADDRESS ``` Configuration variables: diff --git a/source/_components/telegram_webhooks.markdown b/source/_components/telegram_webhooks.markdown index 1e0d4eeae4f..bad857af22b 100644 --- a/source/_components/telegram_webhooks.markdown +++ b/source/_components/telegram_webhooks.markdown @@ -65,11 +65,13 @@ telegram_webhooks: Telegram webhooks raise an event `telegram.command` with a payload. -```json{ +```json +{ 'command': '/thecommand' 'args': 'strings after command' 'user_id': 12345 } +``` Automation example that realize simple test to command/notify interaction. diff --git a/source/_docs/automation/templating.markdown b/source/_docs/automation/templating.markdown index e1c085ea738..1a9927fc2c4 100644 --- a/source/_docs/automation/templating.markdown +++ b/source/_docs/automation/templating.markdown @@ -12,7 +12,7 @@ redirect_from: /getting-started/automation-templating/ In Home Assistant 0.19 we introduced a new powerful feature: variables in scripts and automations. This makes it possible to adjust your condition and action based on the information of the trigger. -The trigger data made is available during [template](/configuration/templating/) rendering as the `trigger` variable. +The trigger data made is available during [template](/docs/configuration/templating/) rendering as the `trigger` variable. ```yaml # Example configuration.yaml entries @@ -128,4 +128,4 @@ The following tables show the available trigger data per platform. | `trigger.zone` | State object of zone | `trigger.event` | Event that trigger observed: `enter` or `leave`. -[state object]: /configuration/state_object/ +[state object]: /docs/configuration/state_object/ diff --git a/source/_docs/autostart/systemd.markdown b/source/_docs/autostart/systemd.markdown index ff328924626..9dbcdae75e5 100644 --- a/source/_docs/autostart/systemd.markdown +++ b/source/_docs/autostart/systemd.markdown @@ -18,10 +18,14 @@ $ ps -p 1 -o comm= If the preceding command returns the string `systemd`, you are likely using `systemd`. -If you want Home Assistant to be launched automatically, an extra step is needed to setup `systemd`. You need a service file to control Home Assistant with `systemd`. If you are using a Raspberry Pi with Raspbian then replace the `[your user]` with `pi` otherwise use your user you want to run Home Assistant. `ExecStart` contains the path to `hass` and this may vary. Check with `whereis hass` for the location. +If you want Home Assistant to be launched automatically, an extra step is needed to setup `systemd`. A service file is needed to control Home Assistant with `systemd`. The template below should be created using a text editor. Note, root permissions via 'sudo' will likely be needed. The following should be noted to modify the template: -```bash -$ su -c 'cat <> /etc/systemd/system/home-assistant@.service ++ `ExecStart` contains the path to `hass` and this may vary. Check with `whereis hass` for the location. ++ If running Home Assistant in a python virtual environment or a docker, please skip to section below. ++ For most systems, the file is `/etc/systemd/system/home-assistant@[your user].service` with [your user] replaced by the user account that Home Assistant will run as - normally `homeassistant`. For Ubuntu 16.04, the file is `/lib/systemd/system/home-assistant.service` and requires running this command `sudo ln -s /lib/systemd/system/home-assistant.service /etc/systemd/system/home-assistant.service` after file is created. ++ If unfamiliar with command line text editors, `sudo nano -w [filename]` can be used with `[filename]` replaced with the full path to the file. Ex. `sudo nano -w /etc/systemd/system/home-assistant@homeassistant.service`. After text entered, press CTRL-X then press Y to save and exit. + +``` [Unit] Description=Home Assistant After=network.target @@ -33,10 +37,9 @@ ExecStart=/usr/bin/hass [Install] WantedBy=multi-user.target -EOF' ``` -If you've setup Home Assistant in `virtualenv` following our [python installation guide](https://home-assistant.io/getting-started/installation-virtualenv/) or [manual installation guide for raspberry pi](https://home-assistant.io/getting-started/installation-raspberry-pi/), the following template should work for you. +If you've setup Home Assistant in `virtualenv` following our [python installation guide](https://home-assistant.io/getting-started/installation-virtualenv/) or [manual installation guide for raspberry pi](https://home-assistant.io/getting-started/installation-raspberry-pi/), the following template should work for you. If Home Assistant install is not located at `/srv/homeassistant`, please modify the `Enviroment=` and `ExecStart=` lines appropriately. ``` [Unit] @@ -74,18 +77,33 @@ ExecStopPost=/usr/bin/docker rm -f home-assistant-%i WantedBy=multi-user.target ``` -You need to reload `systemd` to make the daemon aware of the new configuration. Enable and launch Home Assistant after that. +You need to reload `systemd` to make the daemon aware of the new configuration. ```bash $ sudo systemctl --system daemon-reload +``` + +To have Home Assistant start automatically at boot, enable the service. + +```bash $ sudo systemctl enable home-assistant@[your user] +``` + +To disable the automatic start, use this command. + +```bash +$ sudo systemctl disable home-assistant@[your user] +``` + +To start Home Assistant now, use this command. +```bash $ sudo systemctl start home-assistant@[your user] ``` -If everything went well, `sudo systemctl start home-assistant@[your user]` should give you a positive feedback. +You can also substitute the `start` above with `stop` to stop Home Assistant, `restart` to restart Home Assistant, and 'status' to see a brief status report as seen below. ```bash -$ sudo systemctl status home-assistant@[your user] -l +$ sudo systemctl status home-assistant@[your user] ● home-assistant@fab.service - Home Assistant for [your user] Loaded: loaded (/etc/systemd/system/home-assistant@[your user].service; enabled; vendor preset: disabled) Active: active (running) since Sat 2016-03-26 12:26:06 CET; 13min ago @@ -99,10 +117,10 @@ $ sudo systemctl status home-assistant@[your user] -l To get Home Assistant's logging output, simple use `journalctl`. ```bash -$ journalctl -f -u home-assistant@[your user] +$ sudo journalctl -f -u home-assistant@[your user] ``` -Because the log can scroll quite quickly, you might want to open a second terminal to view only the errors: +Because the log can scroll quite quickly, you can select to view only the error lines: ```bash -$ journalctl -f -u home-assistant@[your user] | grep -i 'error' +$ sudo journalctl -f -u home-assistant@[your user] | grep -i 'error' ``` diff --git a/source/_docs/hassbian/installation.markdown b/source/_docs/hassbian/installation.markdown index 7d09be5914d..b53a907efa7 100644 --- a/source/_docs/hassbian/installation.markdown +++ b/source/_docs/hassbian/installation.markdown @@ -17,7 +17,7 @@ The easiest way to install Home Assistant on your Raspberry Pi is by using HASSb 3. Ensure your Raspberry Pi has access to the internet. 4. Insert SD card to Raspberry Pi and turn it on. Initial installation of Home Assistant will take about 5 minutes. -These instructions are also available as a [video](https://www.youtube.com/watch?v=iIz6XqDwHEk). +These instructions are also available as a [video](https://www.youtube.com/watch?v=iIz6XqDwHEk). And additioning info is available in this [video](https://www.youtube.com/watch?v=tCGlQSsQ-Mc). After initial boot, you can reach Home Assistant in your browser at [http://hassbian.local:8123]. If you want to login via SSH, the default username is `pi` and password is `raspberry` (please change this by running `passwd`). The Home Assistant configuration is located at `/home/homeassistant/.homeassistant/`. diff --git a/source/_docs/installation.markdown b/source/_docs/installation.markdown index 1db05d07578..604102d383b 100644 --- a/source/_docs/installation.markdown +++ b/source/_docs/installation.markdown @@ -10,9 +10,88 @@ footer: true redirect_from: /getting-started/installation/ --- -Home Assistant provides multiple ways to be installed. If you are a Raspberry Pi owner then the [Hassbian](/docs/hassbian/) is an easy and simple way to run home Assistant. +Home Assistant provides multiple ways to be installed. A requirement is that you have [Python](https://www.python.org/downloads/) installed. For Windows we require at least **Python 3.5** and for other operating systems at least **Python 3.4.2**. -The only requirement is that you have [Python](https://www.python.org/downloads/) installed. For Windows we require at least **Python 3.5** and for other operating systems at least **Python 3.4.2**. +
+ +
+ +
+
Hassbian
+ + +
+ +
+
Rasbian
+ + +
+ +
+
ArchLinux
+ + +
+ +
+
armbian
+ + +
+ +
+
Fedora
+ + +
+ +
+
CentOS/RHEL
+ + +
+ +
+
Windows
+ + +
+ +
+
macOS
+ + +
+ +
+
Synology
+ + +
+ +
+
Docker
+ + +
+ +
+
Vagrant
+ +
+ +Once Home Assistant is installed, execute the following code in a console/terminal to check if the setup was successful: + +```bash +$ hass +``` + +The first start may take a minute or two because the needed packages will be downloaded and installed. The web interface will be served on [http://localhost:8123](http://localhost:8123). + +For more details about `hass`, please refer to the [tools section](/docs/tools/hass/). + +If you're running a Linux-based platform, we suggest you follow the [VirtualEnv instructions](/docs/installation/virtualenv/) to avoid using `root`. It may be needed that you install additional library depending on the platforms/components you want to use. diff --git a/source/_docs/installation/archlinux.markdown b/source/_docs/installation/archlinux.markdown new file mode 100644 index 00000000000..8fa7188f0a7 --- /dev/null +++ b/source/_docs/installation/archlinux.markdown @@ -0,0 +1,31 @@ +--- +layout: page +title: "Installation on ArchLinux" +description: "Installation of Home Assistant on your ArchLinux computer." +date: 2017-03-01 07:00 +sidebar: true +comments: false +sharing: true +footer: true +--- + +[ArchLinux](https://www.archlinux.org/) is a lightweight and flexible Linux distribution. There are official packages optimized for the i686 and x86-64 architectures available. + +Install the needed Python packages. + +```bash +$ sudo pacman -S python +$ sudo pacman -S python-pip +``` + +and Home Assistant itself. + +```bash +$ pip3 install homeassistant +``` + +Home Assistant is part of the [AUR](https://aur.archlinux.org/packages/home-assistant/). This meand that it can be installed directly with `pacman`: + +```bash +$ sudo pacman -S home-assistant +``` diff --git a/source/_docs/installation/armbian.markdown b/source/_docs/installation/armbian.markdown index 3dfa57fb3f4..d7b53d7ed2e 100644 --- a/source/_docs/installation/armbian.markdown +++ b/source/_docs/installation/armbian.markdown @@ -11,9 +11,15 @@ footer: true [armbian](https://www.armbian.com) runs on a wide-variety of [ARM development boards](https://www.armbian.com/download/). Currently there are around 50 boards supported inclusive the OrangePi family, Cubieboard, Pine64, and Odroid. +Setup Python and `pip` + ```bash $ sudo apt-get update $ sudo apt-get install python3-dev python3-pip ``` -Now you can follow the [generic instructions](/docs/installation/python/). +Install Home Assistant. + +```bash +$ pip3 install homeassistant +``` diff --git a/source/_docs/installation/centos.markdown b/source/_docs/installation/centos.markdown new file mode 100644 index 00000000000..21ffd270130 --- /dev/null +++ b/source/_docs/installation/centos.markdown @@ -0,0 +1,62 @@ +--- +layout: page +title: "Installation on CentOS/RHEL" +description: "Installation of Home Assistant on your CentOS/RHEL computer." +date: 2017-03-01 07:00 +sidebar: true +comments: false +sharing: true +footer: true +--- + +To run Python 3.x on [CentOS](https://www.centos.org/) or RHEL (Red Hat Enterprise Linux), [Software Collections](https://www.softwarecollections.org/en/scls/rhscl/rh-python34/) needs to be activated first. + +There are effort in progress to bring Python 3.4 to [Extra Packages for Enterprise Linux (EPEL)](https://fedoraproject.org/wiki/EPEL) which will allow you to follow the [Fedora Instructions](/docs/installation/fedora/). + +### {% linkable_title Using Software Collections %} + +First of all install the software collection repository as root. For example, on CentOS: + +```bash +$ yum install centos-release-scl +``` + +Then install the Python 3.5 package: + +```bash +$ yum install rh-python35 +``` + +Once installed, switch to your homeassistant user (if you've set one up), enable the software collection and check that it has set up the new version of Python: + +```bash +$ scl enable rh-python35 bash +$ python --version +Python 3.5.1 +``` + +You will be in a command shell set up with Python 3.5 as your default version. The virtualenv and pip commands will be correct for this version, so you can now create a virtual environment and install home assistant following the main [instructions](https://home-assistant.io/docs/installation/virtualenv/#step-4-set-up-the-virtualenv). + +You will need to enable the software collection each time you log on before you activate your virtual environment. + +### {% linkable_title Systemd with Software Collections %} + +To autostart homeassistant using systemd follow the main [instructions](https://home-assistant.io/docs/autostart/systemd/) and adjust the template as follows: + +``` +[Unit] +Description=Home Assistant +After=network.target + +[Service] +Type=simple +User=homeassistant +# Make sure the virtualenv Python binary is used +Environment=VIRTUAL_ENV="/srv/homeassistant" +Environment=PATH="$VIRTUAL_ENV/bin:$PATH" +# ExecStart using software collection: +ExecStart=/usr/bin/scl enable rh-python35 -- /srv/homeassistant/bin/hass -c "/home/homeassistant/.homeassistant" + +[Install] +WantedBy=multi-user.target +``` diff --git a/source/_docs/installation/fedora.markdown b/source/_docs/installation/fedora.markdown new file mode 100644 index 00000000000..fca60e4b9bb --- /dev/null +++ b/source/_docs/installation/fedora.markdown @@ -0,0 +1,25 @@ +--- +layout: page +title: "Installation on Fedora" +description: "Installation of Home Assistant on your Fedora computer." +date: 2017-03-01 07:00 +sidebar: true +comments: false +sharing: true +footer: true +--- + +[Fedora](https://fedoraproject.org) is an operating system based on the Linux kernel, developed by the community-supported Fedora Project. There are releases for x86 and x86_64 including ARM and other architectures. + +Install the development package of Python. + +```bash +$ sudo dnf -y install python3-devel +``` + +and Home Assistant itself. + +```bash +$ pip3 install homeassistant +``` + diff --git a/source/_docs/installation/macos.markdown b/source/_docs/installation/macos.markdown new file mode 100644 index 00000000000..25b3706db7c --- /dev/null +++ b/source/_docs/installation/macos.markdown @@ -0,0 +1,22 @@ +--- +layout: page +title: "Installation on macOS" +description: "Installation of Home Assistant on your macOS system." +date: 2017-03-01 07:00 +sidebar: true +comments: false +sharing: true +footer: true +--- + +[macOS](http://www.apple.com/macos/) is available by default on Apple computer. If you run a different operating system, please refer to the other section of the documentation. + +To run Home Assistant on macOS you need to install Python first. Download Python from https://www.python.org/downloads/mac-osx/ and follow the instructions of the installer. + +Open a terminal and install Home Assistant. + +```bash +$ pip3 install homeassistant +``` + +Check this [video](https://www.youtube.com/watch?v=hej6ipN86ls) for the installation on macOS. diff --git a/source/_docs/installation/troubleshooting.markdown b/source/_docs/installation/troubleshooting.markdown index b78544b025a..9db877b45dc 100644 --- a/source/_docs/installation/troubleshooting.markdown +++ b/source/_docs/installation/troubleshooting.markdown @@ -38,9 +38,6 @@ On a Debian system, install the Python 3 YAML library by `sudo apt-get install p #### {% linkable_title distutils.errors.DistutilsOptionError: must supply either home or prefix/exec-prefix -- not both %} This is a known issue if you're on a Mac using Homebrew to install Python. Please follow [these instructions](https://github.com/Homebrew/brew/blob/master/docs/Homebrew-and-Python.md#note-on-pip-install---user) to resolve it. -#### {% linkable_title CentOS and Python 3 %} -To run Python 3.x on [CentOS](https://www.centos.org/) or RHEL, [Software Collections](https://www.softwarecollections.org/en/scls/rhscl/rh-python34/) needs to be activated. - #### {% linkable_title No access to the frontend %} In newer Linux distributions (at least Fedora > 22/CentOS 7) the access to a host is very limited. This means that you can't access the Home Assistant frontend that is running on a host outside of the host machine. Windows and macOS machines may also have issues with this. diff --git a/source/_docs/installation/vagrant.markdown b/source/_docs/installation/vagrant.markdown index 2ab59b2019e..8616b286fb3 100644 --- a/source/_docs/installation/vagrant.markdown +++ b/source/_docs/installation/vagrant.markdown @@ -10,7 +10,7 @@ footer: true redirect_from: /getting-started/installation-vagrant/ --- -A `Vagrantfile` is available into `virtualization/vagrant` folder for quickly spinning up a Linux virtual machine running Home Assistant. This can be beneficial for those who want to experiment with Home Assistant and/or developers willing to easily test local changes and run test suite against them. +A `Vagrantfile` is available into `virtualization/vagrant` folder for quickly spinning up a Linux virtual machine running Home Assistant. This can be beneficial for those who want to experiment with Home Assistant and/or developers willing to easily test local changes and run test suite against them. In the same `virtualization/vagrant` folder there's also a `provision.sh` shell script which provides an easy way to interact with the Home Assistant instance running within the Vagrant VM.

Vagrant is intended for testing/development only. It is NOT recommended for permanent installations. @@ -18,7 +18,7 @@ Vagrant is intended for testing/development only. It is NOT recommended for perm ## {% linkable_title Install Vagrant %} -You must have [Vagrant](https://www.vagrantup.com/downloads.html) and [Virtualbox](https://www.virtualbox.org/wiki/Downloads) installed on your workstation. +You must have [Vagrant](https://www.vagrantup.com/downloads.html) and [Virtualbox](https://www.virtualbox.org/wiki/Downloads) installed on your workstation. Vagrant and Virtualbox support all the main platforms, including Windows, MacOS and Linux. ## {% linkable_title Get Home Assistant source code %} @@ -44,46 +44,57 @@ $ git config --global core.autocrlf input ## {% linkable_title Create the Vagrant VM and start Home Assistant %} ```bash -$ vagrant up +$ ./provision.sh setup ``` -This will download and start a virtual machine using Virtualbox, which will internally setup the development environment necessary to start Home Assistant process and run test suite as well. After the VM has started successfully, the Home Assistant frontend will be accessible locally from your browser at [http://localhost:8123](http://localhost:8123) +This will download and start a virtual machine using Virtualbox, which will internally setup the development environment necessary to start Home Assistant. The whole process might take up to 30 minutes to complete, depending on Internet connection speed and workstation resources. After the VM has started successfully, the Home Assistant frontend will be accessible locally from your browser at [http://localhost:8123](http://localhost:8123) ## {% linkable_title Stopping Vagrant %} To shutdown the Vagrant host: ```bash -$ vagrant halt +$ ./provision.sh stop ``` -To start it again, just run `vagrant up` +To start it again: + +```bash +$ ./provision.sh start +``` ## {% linkable_title Restarting Home Assistant process to test changes %} The root `home-assistant` directory on your workstation will be mirrored with `/home-assistant` inside the VM. In `virtualization/vagrant` there's also a `config` folder that you can use to drop configuration files (Check the [Configuration section](/docs/configuration/) in the docmentation for more information about how to configure Home Assistant). -Any changes made to the local directory on your workstation will be available from the Vagrant host, so to apply your changes to the Home Assistant process, just restart it: +Any changes made to the local directory on your workstation will be available from the Vagrant host, so to apply your changes to the Home Assistant process, just restart it using the provided `provision.sh` wrapper script: ```bash -$ touch restart ; vagrant provision +$ ./provision.sh restart ``` +

+This command will only restart the Home Assistant process inside the Vagrant VM, it will not reboot the virtual machine. If that's what you want, the right command is vagrant reload +

+ ## {% linkable_title Run test suite (Tox) %} -To run tests against your changes: +To run tests against the local version of Home Assistant code: ```bash -$ touch run_tests ; vagrant provision +$ ./provision.sh tests ``` ## {% linkable_title Cleanup %} -To completely remove the VM: +To completely remove the VM ```bash -$ rm setup_done ; vagrant destroy -f +$ ./provision.sh destroy ``` -You can now recreate a completely new Vagrant host with `vagrant up` +To completely remove the VM **and** setup a fresh new environment: +```bash +$ ./provision.sh recreate +``` diff --git a/source/_docs/installation/virtualenv.markdown b/source/_docs/installation/virtualenv.markdown index 613b3ecd7c4..7541acba702 100644 --- a/source/_docs/installation/virtualenv.markdown +++ b/source/_docs/installation/virtualenv.markdown @@ -23,12 +23,13 @@ $ sudo apt-get install python-pip python3-dev $ sudo pip install --upgrade virtualenv ``` -### {% linkable_title Step 1: Create a Home Assistant user %} +### {% linkable_title Step 1: Create a Home Assistant user & group %} This step is optional, but it's a good idea to give services like Home Assistant their own user. It gives you more granular control over permissions, and reduces the exposure to the rest of your system in the event there is a security related bug in Home Assistant. This is a reasonably Linux oriented step, and will look different on other operating systems (or even other Linux distributions). ```bash $ sudo adduser --system homeassistant +$ sudo addgroup homeassistant ``` Home Assistant stores its configuration in `$HOME/.homeassistant` by default, so in this case, it would be in `/home/homeassistant/.homeassistant` diff --git a/source/_docs/installation/windows.markdown b/source/_docs/installation/windows.markdown index 5ee4465c0a5..899040bc125 100644 --- a/source/_docs/installation/windows.markdown +++ b/source/_docs/installation/windows.markdown @@ -1,6 +1,6 @@ --- layout: page -title: "Installation on a Windoes system" +title: "Installation on a Windows system" description: "Instructions to install Home Assistant on a Microsoft Windows system." date: 2017-02-23 11:00 sidebar: true diff --git a/source/_includes/asides/docs_navigation.html b/source/_includes/asides/docs_navigation.html index 2b3ee4418a3..5b4ddd810d0 100644 --- a/source/_includes/asides/docs_navigation.html +++ b/source/_includes/asides/docs_navigation.html @@ -5,13 +5,8 @@
  • {% active_link /docs/installation/ Installation %} @@ -117,13 +112,13 @@ {% active_link /docs/ecosystem/ Ecosystem %}