diff --git a/source/developers/helpers.markdown b/source/developers/helpers.markdown index 3aeac28dd3f..390bf17b242 100644 --- a/source/developers/helpers.markdown +++ b/source/developers/helpers.markdown @@ -9,11 +9,10 @@ sharing: true footer: true --- -There are a bunch of online services which can help you if you are developing for Home Assistant or maintaining platforms/components. Some are directly connected to Pull Requests and the repositories itself, others are only publishing details and updates in our [gitter.im](https://gitter.im/home-assistant/home-assistant/devs) chatroom. +There are a bunch of online services which can help you if you are developing for Home Assistant or maintaining components. Some of these are directly connected to Pull Requests and the repositories, while others publish details and updates in our [Gitter.im](https://gitter.im/home-assistant/home-assistant/devs) chatroom. - [Coveralls](https://coveralls.io/github/home-assistant/home-assistant) - [Travis CI](https://travis-ci.org/home-assistant/home-assistant) - [gemnasium](https://gemnasium.com/github.com/home-assistant/home-assistant) - [Requires.io](https://requires.io/github/home-assistant/home-assistant/requirements/?branch=dev) - [Pivotal Tracker](https://www.pivotaltracker.com/n/projects/1250084) - diff --git a/source/getting-started/android.markdown b/source/getting-started/android.markdown index b2244fdd605..2ef656adf82 100644 --- a/source/getting-started/android.markdown +++ b/source/getting-started/android.markdown @@ -9,15 +9,15 @@ sharing: true footer: true --- -Home Assistant is not available on the Play Store or App Store. Instead, Home Assistant leverages the new [manifest.json support](https://w3c.github.io/manifest/) to allow Mobile devices to add the web application to your homescreen as if it was a native application. +Home Assistant is not available on the Play Store or App Store. Instead, Home Assistant leverages the new W3C [manifest.json](https://w3c.github.io/manifest/) support, allowing mobile devices to add the "web app" to your homescreen as if it was native. On Android: 1. Open Chrome 2. Navigate to your Home Assistant instance - 3. Click on the menu icon (three vertical dots) - 4. Click on Add to Homescreen - 5. A dialog will popup, click on Add + 3. Tap on the Menu icon (three vertical bars) + 4. Tap on Add to Homescreen + 5. A dialog will popup; tap on Add

@@ -27,6 +27,6 @@ On iOS: 1. Open Safari 2. Navigate to your Home Assistant instance - 3. Click on the share icon in the middle of the toolbar (on the bottom) - 4. Click on Add to Home Screen - 5. A dialog will popup, click on Add + 3. Tap on the Share icon in the middle of the bottom toolbar + 4. Tap on "Add to Home Screen" + 5. A dialog will popup; tap on Add diff --git a/source/getting-started/automation.markdown b/source/getting-started/automation.markdown index dea2435fd7e..435039e1937 100644 --- a/source/getting-started/automation.markdown +++ b/source/getting-started/automation.markdown @@ -9,15 +9,15 @@ sharing: true footer: true --- -When all your devices are set up it's time to put the cherry on the pie: automation. Home Assistant offers [a few built-in automations](/components/#automation) but mainly you'll be using the automation component to set up your own rules. +When all your devices are set up, it's time to put the cherry on the pie: automation. Home Assistant offers [a few built-in automations](/components/#automation) – but you'll be using the automation component to set up your own rules, for the most part. -Home Assistant offers a wide range of automations. In the next few pages we'll try to guide you through all the different possibilities and options. Besides this documentation there are also a couple of people who have made their automation configurations [publicly available][cookbook-config]. +Home Assistant offers a wide range of automation configurations. In the next few pages,, we'll try to guide you through all the different possibilities and options. Besides this documentation, there are also a couple of people who have made their automations [publicly available][cookbook-config]. [cookbook-config]: /cookbook/#example-configurationyaml ### {% linkable_title Automation basics %} -Before you can go ahead and create your own automations, it's important to learn the basics. To explore the basics, let's have a look at the following example home automation rule: +Before you can go ahead and create your own automations, it's important to learn the basics. To explore these, let's have a look at the following example home automation rule: ```text (trigger) When Paulus arrives home @@ -27,19 +27,19 @@ Before you can go ahead and create your own automations, it's important to learn The example consists of three different parts: a trigger, a condition and an action. -The first line is the trigger of the automation rule. Triggers describe events that should trigger the automation rule. In this case it is a person arriving home, which can be observed in Home Assistant by observing the state of Paulus changing from 'not_home' to 'home'. +The first line is the **trigger** of the automation rule. Triggers describe events that should trigger the automation rule. In this case, it is a person arriving home, which can be observed in Home Assistant by observing the state of Paulus changing from 'not_home' to 'home'. -The second line is the condition part of the automation rule. Conditions are optional tests that can limit an automation rule to only work in your specific use cases. A condition will test against the current state of the system. This includes the current time, devices, people and other things like the sun. In this case we only want to act when the sun has set. +The second line is the **condition**. Conditions are optional tests that can limit an automation rule to only work in your specific use cases. A condition will test against the current state of the system. This includes the current time, devices, people and other things like the sun. In this case, we only want to act when the sun has set. -The third part is the action which will be performed when a rule is triggered and all conditions are met. For example, it can turn a light on, set the temperature on your thermostat or activate a scene. +The third part is the **action**, which will be performed when a rule is triggered and all conditions are met. For example, it can turn a light on, set the temperature on your thermostat or activate a scene.

-The difference between a condition and a trigger can be confusing as they are very similar. Triggers look at the actions, while conditions look at the results: turning a light on vs a light being on. +The difference between a condition and a trigger can be confusing as they are very similar. Triggers look at the actions, while conditions look at the results: turning a light on versus a light being on.

### {% linkable_title Exploring the internal state %} -Automation rules interact directly with the internal state of Home Assistant so you'll need to familiarize yourself with it. Home Assistant exposes it's current state via the developer tools which are available at the bottom of the sidebar in the frontend. The icon will show all currently available states. An entity can be anything. A light, a switch, a person and even the sun. A state consists of the following parts: +Automation rules interact directly with the internal state of Home Assistant, so you'll need to familiarize yourself with it. Home Assistant exposes its current state via the developer tools. These are available at the bottom of the sidebar in the frontend. The icon will show all currently available states. An entity can be anything. A light, a switch, a person and even the sun. A state consists of the following parts: | Name | Description | Example | | ---- | ----- | ---- | diff --git a/source/getting-started/autostart-macos.markdown b/source/getting-started/autostart-macos.markdown index c61bf57331d..d0c5798665e 100644 --- a/source/getting-started/autostart-macos.markdown +++ b/source/getting-started/autostart-macos.markdown @@ -1,7 +1,7 @@ --- layout: page -title: "Autostart on OS X" -description: "Instructions how to setup Home Assistant to launch on OS X." +title: "Autostart on macOS" +description: "Instructions how to setup Home Assistant to launch on Apple macOS." date: 2015-9-1 22:57 sidebar: true comments: false @@ -9,7 +9,7 @@ sharing: true footer: true --- -Setting up Home Assistant to run as a background service is simple. OS X will start it on boot and make sure it's always running. +Setting up Home Assistant to run as a background service is simple; macOS will start Home Assistant on boot and make sure it's always running. To get Home Assistant installed as a background service, run: diff --git a/source/getting-started/basic.markdown b/source/getting-started/basic.markdown index f9b4d69fada..f8cb5b33cc6 100644 --- a/source/getting-started/basic.markdown +++ b/source/getting-started/basic.markdown @@ -9,7 +9,7 @@ sharing: true footer: true --- -By default Home Assistant will try to detect your location and will automatically select a temperature unit and time zone based on your location. You can overwrite this by adding the following information to your `configuration.yaml`: +By default, Home Assistant will try to detect your location from IP address geolocation. Home Assistant will automatically select a temperature unit and time zone based on this location. You can overwrite this by adding the following information to your `configuration.yaml`: ```yaml homeassistant: @@ -35,7 +35,7 @@ homeassistant: ### {% linkable_title Password protecting the web interface %} -The first thing you will want to add is a password for the web interface. Use your favourite text editor to open `configuration.yaml` and edit the `http` section: +First, you'll want to add a password for the Home Assistant web interface. Use your favourite text editor to open `configuration.yaml` and edit the `http` section: ```yaml http: @@ -43,26 +43,24 @@ http: ```

-If you are planning to expose your Home Assistant instance to the internet and don't set a password then your installation could be accessed by everybody. +If you decide to expose your Home Assistant instance to the internet and forget to set a password, your installation could be accessed by everybody.

-See the [HTTP component documentation](/components/http/) for more options like HTTPS encryption. +See the [HTTP component documentation](/components/http/) for more options, such as the use of HTTPS encryption. ### {% linkable_title Setting up your phone or tablet %} -Home Assistant runs as a self-hosted web application and contains support to be added to your home screen. If you're on Android you can follow [the visual guide]({{site_root}}/getting-started/android/). For other devices, open Home Assistant on your mobile browser and tap the add to home screen option. - +Home Assistant runs as a self-hosted web application and can be pinned to your home screen (with the new W3C standard). If you're on Android, follow [the visual guide]({{site_root}}/getting-started/android/). For other devices, open Home Assistant on your mobile browser and tap the "Add to Home Screen" (or similar) option. ### {% linkable_title Remote access %} -To make Home Assistant accessible while away from home, you will have to make it accessible. +If you're interested in logging in to Home Assistant while away, you'll have to make your instance remotely accessible. -The most common approach is to set up port forwarding from your router to port 8123 on the computer that is hosting Home Assistant. Instructions on how to do this can be found by searching ` port forwarding instructions`. +The most common approach is to set up port forwarding from your router to port 8123 on the computer that is hosting Home Assistant. General instructions on how to do this can be found by searching ` port forwarding instructions`. -The problem with making a port accessible is that some Internet service providers will only offer dynamic IPs. This can cause you to be unable to access Home Assistant while away. You can solve this by using a free Dynamic DNS service like [DuckDNS](https://www.duckdns.org/). +A problem with making a port accessible is that some Internet Service Providers only offer dynamic IPs. This can cause you to lose access to Home Assistant while away. You can solve this by using a free Dynamic DNS service like [DuckDNS](https://www.duckdns.org/). -Just putting a port up is not secure. You should definitely consider encrypting your traffic if you are accessing your Home Assistant installation remotely. For details please check the [Set up encryption using Let's Encrypt](/blog/2015/12/13/setup-encryption-using-lets-encrypt/) blog post. +Remember: just putting a port up is not secure. You should definitely consider encrypting your traffic if you are accessing your Home Assistant installation remotely. For details please check the [set up encryption using Let's Encrypt](/blog/2015/12/13/setup-encryption-using-lets-encrypt/) blog post. If you want the very best security, check out [the instructions how to use Tor to access your home](/cookbook/tor_configuration/). ### [Next step: Setting up devices »](/getting-started/devices/) - diff --git a/source/getting-started/securing.markdown b/source/getting-started/securing.markdown index bfbf52aaf21..9ed36dc13f7 100644 --- a/source/getting-started/securing.markdown +++ b/source/getting-started/securing.markdown @@ -9,17 +9,17 @@ sharing: true footer: true --- -One of the reasons to use Home Assistant is that it's not depending on cloud services. Even if you are only using Home Assistant in your local network, you should consider securing your instance. +One major advantage of Home Assistant is that it's not dependent on cloud services. Even if you're only using Home Assistant on a local network, you should take steps to secure your instance. ### {% linkable_title Checklist %} - [Protect your web interface with a password](https://home-assistant.io/getting-started/basic/#password-protecting-the-web-interface) - Secure your host. Sources could be [Red Hat Enterprise Linux 7 Security Guide](https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux/7/pdf/Security_Guide/Red_Hat_Enterprise_Linux-7-Security_Guide-en-US.pdf), [CIS Red Hat Enterprise Linux 7 Benchmark](https://benchmarks.cisecurity.org/tools2/linux/CIS_Red_Hat_Enterprise_Linux_7_Benchmark_v1.0.0.pdf), or the [Securing Debian Manual](https://www.debian.org/doc/manuals/securing-debian-howto/index.en.html). -- Restrict network access to your device. Set `PermitRootLogin no` in your sshd config (usually `/etc/ssh/sshd_config`) and to use keys for authentication instead of passwords. -- Don't run Home Assistant as root. +- Restrict network access to your devices. Set `PermitRootLogin no` in your sshd config (usually `/etc/ssh/sshd_config`) and to use SSH keys for authentication instead of passwords. +- Don't run Home Assistant as root – consider the Principle of Least Privilege. - Keep your [secrets](/topics/secrets/) safe. -Additional points if you want to allow remote access: +If you want to allow remote access, consider these additional points: - Protect your communication with [TLS](/blog/2015/12/13/setup-encryption-using-lets-encrypt/) - Protect your communication with [Tor](/cookbook/tor_configuration/) diff --git a/source/getting-started/updating.markdown b/source/getting-started/updating.markdown index 0da8ad75536..cceed8df558 100644 --- a/source/getting-started/updating.markdown +++ b/source/getting-started/updating.markdown @@ -18,18 +18,18 @@ $ pip3 install --upgrade homeassistant Different installation methods as [HASSbian](/getting-started/installation-raspberry-pi-image/#update-home-assistant-on-hassbian), [Raspberry Pi All-In-One Installer](/getting-started/installation-raspberry-pi-all-in-one/#upgrading), [Vagrant](/getting-started/installation-vagrant/), or [Virtualenv](/getting-started/installation-virtualenv/#upgrading-home-assistant) may have an alternative way for updating Home Assistant. -After updating, restart Home Assistant for the changes to take effect. This means that you have to restart `hass` itself or the [autostarting](/getting-started/autostart/) daemon if you use any. +After updating, you must restart Home Assistant for the changes to take effect. This means that you will have to restart `hass` itself or the [autostarting](/getting-started/autostart/) daemon (if applicable)

- The upgrade needs to be run as the same user as the installation was done to avoid permission errors. + To avoid permission errors, the upgrade must be run as the same user as the installation was completed.

[BRUH automation](http://www.bruhautomation.com) has created [a tutorial video](https://www.youtube.com/watch?v=tuG2rs1Cl2Y) explaining how to upgrade Home Assistant. #### {% linkable_title Run a specific version %} -It can happen that a version doesn't play well with your hardware setup. If that's the case you can downgrade to a previous release. +In the event that a Home Assistant version doesn't play well with your hardware setup, you can downgrade to a previous release: ```bash $ pip3 install homeassistant==0.XX.X @@ -37,10 +37,10 @@ $ pip3 install homeassistant==0.XX.X #### {% linkable_title Run the development version %} -If you want to stay on top of the development of Home Assistant then you can upgrade to the `dev` branch. +If you want to stay on the bleeding-edge Home Assistant development branch, you can upgrade to `dev`.

- This can result in an unstable system, loss of data, etc. etc. + The "dev" branch is likely to be unstable. Potential consequences include loss of data and instance corruption.

```bash