diff --git a/README.markdown b/README.markdown index e055c8e3369..d3a630cb1ea 100644 --- a/README.markdown +++ b/README.markdown @@ -1,7 +1,7 @@ [](https://discord.gg/CxqDrfU) [](https://travis-ci.org/home-assistant/home-assistant.github.io) [](http://www.krihelinator.xyz) -[](https://opensource.org/licenses/MIT) +[](https://creativecommons.org/licenses/by-nc-sa/4.0/) # Home Assistant website diff --git a/source/_components/climate.mqtt.markdown b/source/_components/climate.mqtt.markdown index 3713b1274c4..03c5808ceb6 100644 --- a/source/_components/climate.mqtt.markdown +++ b/source/_components/climate.mqtt.markdown @@ -7,7 +7,7 @@ sidebar: true comments: false sharing: true footer: true -logo: heat-control.png +logo: mqtt.png ha_category: Climate ha_release: 0.55 ha_iot_class: "Local Polling" diff --git a/source/_components/device_tracker.huawei_router.markdown b/source/_components/device_tracker.huawei_router.markdown index 6fb470ea4fb..6c9647ac3cd 100644 --- a/source/_components/device_tracker.huawei_router.markdown +++ b/source/_components/device_tracker.huawei_router.markdown @@ -7,7 +7,7 @@ sidebar: true comments: false sharing: true footer: true -logo: huawei.png +logo: huawei.svg ha_category: Presence Detection ha_release: 0.51 --- diff --git a/source/_components/device_tracker.unifi_direct.markdown b/source/_components/device_tracker.unifi_direct.markdown index d00d2259646..8c0bda46b8e 100644 --- a/source/_components/device_tracker.unifi_direct.markdown +++ b/source/_components/device_tracker.unifi_direct.markdown @@ -32,11 +32,11 @@ host: required: true type: string username: - description: The username used to connect to your Unifi AP. + description: The SSH device username used to connect to your Unifi AP. required: true type: string password: - description: The password used to connect to your Unifi AP. + description: The SSH device password used to connect to your Unifi AP. required: true type: string {% endconfiguration %} diff --git a/source/_components/hdmi_cec.markdown b/source/_components/hdmi_cec.markdown index 43c95c45ada..758f8d468e9 100644 --- a/source/_components/hdmi_cec.markdown +++ b/source/_components/hdmi_cec.markdown @@ -154,7 +154,7 @@ hdmi_cec: ### {% linkable_title Select Device %} -Call the `hdmi_cec/select_device` service with the name of the device from config or entity_id or physical address"to select it, for example: +Call the `hdmi_cec.select_device` service with the name of the device from config or entity_id or physical address"to select it, for example: ```json {"device": "Chromecast"} @@ -179,15 +179,29 @@ action: ### {% linkable_title Power On %} -Call the `hdmi_cec/power_on` service (no arguments) to power on any devices that support this function. +Call the `hdmi_cec.power_on` service (no arguments) to power on any devices that support this function. + +An Automation action using the example above would look something like this. + +```yaml +action: + service: hdmi_cec.power_on +``` ### {% linkable_title Standby %} -Call the `hdmi_cec/standby` service (no arguments) to place in standby any devices that support this function. +Call the `hdmi_cec.standby` service (no arguments) to place in standby any devices that support this function. + +An Automation action using the example above would look something like this. + +```yaml +action: + service: hdmi_cec.standby +``` ### {% linkable_title Change volume level %} -Call the `hdmi_cec/volume` service with one of following commands: +Call the `hdmi_cec.volume` service with one of following commands: #### {% linkable_title Volume up %} Increase volume three times: @@ -208,7 +222,6 @@ Stop increasing volume: {"up": "release"} ``` - #### {% linkable_title Volume down %} Decrease volume three times: diff --git a/source/_components/notify.html5.markdown b/source/_components/notify.html5.markdown index 194acd9b3af..1adf5f015e1 100644 --- a/source/_components/notify.html5.markdown +++ b/source/_components/notify.html5.markdown @@ -66,7 +66,7 @@ The `html5` platform can only function if all of the following requirements are Assuming you have already added the platform to your configuration: 1. Open Home Assistant in Chrome or Firefox. -2. Assuming you have met all the [requirements](#requirements) above, you should see a new slider in the sidebar labeled Push Notifications. +2. Assuming you have met all the [requirements](#requirements) above, you should see a new slider for Push Notifications through the sidebar Configuration > General. 3. Slide it to the on position. 4. Within a few seconds you should be prompted to allow notifications from Home Assistant. 5. Assuming you accept, that's all there is to it! diff --git a/source/_components/sensor.dublin_bus_transport.markdown b/source/_components/sensor.dublin_bus_transport.markdown index 3b3161cdf10..c44a9f593e6 100644 --- a/source/_components/sensor.dublin_bus_transport.markdown +++ b/source/_components/sensor.dublin_bus_transport.markdown @@ -7,7 +7,7 @@ sidebar: true comments: false sharing: true footer: true -logo: dublin_bus.jpg +logo: dublin_bus.png ha_category: Transport ha_iot_class: "Cloud Polling" ha_release: 0.36 diff --git a/source/_components/switch.command_line.markdown b/source/_components/switch.command_line.markdown index cdb5162ca2a..0c70ae6afca 100644 --- a/source/_components/switch.command_line.markdown +++ b/source/_components/switch.command_line.markdown @@ -21,11 +21,11 @@ To enable it, add the following lines to your `configuration.yaml`: ```yaml # Example configuration.yaml entry switch: - platform: command_line - switches: - kitchen_light: - command_on: switch_command on kitchen - command_off: switch_command off kitchen + - platform: command_line + switches: + kitchen_light: + command_on: switch_command on kitchen + command_off: switch_command off kitchen ``` Configuration variables: diff --git a/source/_docs/configuration/secrets.markdown b/source/_docs/configuration/secrets.markdown index b5feb55b2b4..523bba9c4c4 100644 --- a/source/_docs/configuration/secrets.markdown +++ b/source/_docs/configuration/secrets.markdown @@ -85,7 +85,7 @@ If you launch Home Assistant now, you will be prompted for the keyring password ```bash $ hass -Config directory: /home/fab/.homeassistant +Config directory: /home/homeassistant/.homeassistant Please enter password for encrypted keyring: ``` @@ -97,7 +97,7 @@ Please enter password for encrypted keyring: Using [Credstash](https://github.com/fugue/credstash) is an alternative way to `secrets.yaml`. They can be managed from the command line via the credstash script. -Before using credstash, you need to set up AWS credentials either via the `aws` command line tool, or using environment variables as explained in the [AWS CLI docs](http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html) as well as creating a KMS key named 'credstash' as explained in the [credstash readme](https://github.com/fugue/credstash#setting-up-kms). After that is complete, you can use the provided script to add secrets to your Home Assistant secret store in credstash +Before using credstash, you need to set up AWS credentials either via the `aws` command line tool or using environment variables as explained in the [AWS CLI docs](http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html) as well as creating a KMS key named `credstash` as explained in the [credstash Readme](https://github.com/fugue/credstash#setting-up-kms). After that is complete, you can use the provided script to add secrets to your Home Assistant secret store in credstash. ```bash $ hass --script credstash --help diff --git a/source/_docs/ecosystem/certificates/lets_encrypt.markdown b/source/_docs/ecosystem/certificates/lets_encrypt.markdown index edc5fe6b2b3..2841c355031 100644 --- a/source/_docs/ecosystem/certificates/lets_encrypt.markdown +++ b/source/_docs/ecosystem/certificates/lets_encrypt.markdown @@ -254,7 +254,7 @@ If you did not already log in as the user that currently runs Home Assistant, ch $ sudo su -s /bin/bash hass ``` -Make sure you are in the home directory for the HA user: +Make sure you are in the home directory for the Home Assistant user: ```bash $ cd @@ -269,7 +269,14 @@ $ wget https://dl.eff.org/certbot-auto $ chmod a+x certbot-auto ``` -Now we will run the certbot program to get our ssl certificate. You will need to include your email address and your DuckDNS URL in the appropriate places: +You might need to stop Home Assistant before continuing with the next step. You can do this via the Web-UI or use the following command if you are running on Hassbian: + +```text +$ sudo systemctl stop home-assistant@homeassistant.service +``` + +You can restart Home Assistant after the next step using the same command and replacing `stop` with `start`. +Now we will run the certbot program to get our SSL certificate. You will need to include your email address and your DuckDNS URL in the appropriate places: ```text $ ./certbot-auto certonly --standalone --preferred-challenges http-01 --email your@email.address -d examplehome.duckdns.org @@ -297,13 +304,13 @@ Did all of that go without a hitch? Wahoo! Your Let's Encrypt certificate is now ### {% linkable_title 5 - Check the incoming connection %}
-Following on from Step 4 your SSH will still be in the certbot folder. If you edit your configuration files over SSH you will need to change to your `homeassistant` folder: +Following on from Step 4 your SSH will still be in the certbot folder. If you edit your configuration files over SSH you will need to change to our `homeassistant` folder: ``` $ cd ~/.homeassistant ``` -If you use samba shares to edit your files you can exit your SSH now. +If you use Samba shares to edit your files you can exit your SSH now.
If during step 4 you had to use port 443 instead of port 80 to generate your certificate, you should delete that rule now. @@ -519,7 +526,7 @@ $ ./certbot-auto renew --quiet --no-self-upgrade --standalone --preferred-challe * If you are a ONE-RULE person, replace the `certbot-auto` command above with `~/certbot/certbot-auto renew --quiet --no-self-upgrade --standalone --preferred-challenges tls-sni-01 --tls-sni-01-port 8123 --pre-hook "sudo systemctl stop home-assistant@homeassistant.service" --post-hook "sudo systemctl start home-assistant@homeassistant.service"` -So, now were all set up. We have our secured, remotely accesible HA instance and we're on track for keeping our certificates up to date. But what if something goes wrong? What if the automation didn't fire? What if the cron job forgot to run? What if the dog ate my homework? Read on to set up an alert so you can be notified in plenty of time if you need to step in and sort out any failures. +So, now were all set up. We have our secured, remotely accessible Home Assistant instance and we're on track for keeping our certificates up to date. But what if something goes wrong? What if the automation didn't fire? What if the cron job forgot to run? What if the dog ate my homework? Read on to set up an alert so you can be notified in plenty of time if you need to step in and sort out any failures. ### {% linkable_title 9 - Set up an alert to warn us if something went wrong. %}