diff --git a/Gemfile b/Gemfile index b29288f0477..3a04804fc3e 100644 --- a/Gemfile +++ b/Gemfile @@ -3,7 +3,7 @@ source 'https://rubygems.org' ruby '> 2.5.0' group :development do - gem 'rake', '13.0.3' + gem 'rake', '13.0.4' gem 'jekyll', '4.2.0' gem 'compass', '1.0.3' gem 'sass-globbing', '1.1.5' diff --git a/Gemfile.lock b/Gemfile.lock index 10155b0de21..ef1288421b4 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,7 +1,7 @@ GEM remote: https://rubygems.org/ specs: - addressable (2.7.0) + addressable (2.8.0) public_suffix (>= 2.0.2, < 5.0) chunky_png (1.4.0) colorator (1.1.0) @@ -86,7 +86,7 @@ GEM rack (2.2.3) rack-protection (2.1.0) rack - rake (13.0.3) + rake (13.0.4) rb-fsevent (0.11.0) rb-inotify (0.10.1) ffi (~> 1.0) @@ -131,7 +131,7 @@ DEPENDENCIES jekyll-time-to-read (= 0.1.2) jekyll-toc (= 0.17.1) nokogiri (= 1.11.7) - rake (= 13.0.3) + rake (= 13.0.4) sass-globbing (= 1.1.5) sassc (= 2.1.0) sinatra (= 2.1.0) diff --git a/source/_docs/automation/services.markdown b/source/_docs/automation/services.markdown index 40e9ceaf90d..74e3f923de8 100644 --- a/source/_docs/automation/services.markdown +++ b/source/_docs/automation/services.markdown @@ -19,7 +19,7 @@ This service disables the automation's triggers, and optionally stops any curren Service data attribute | Optional | Description -|-|- -`entity_id` | no | Entity ID of automation to turn on. Can be a list. `none` or `all` are also accepted. +`entity_id` | no | Entity ID of automation to turn off. Can be a list. `none` or `all` are also accepted. `stop_actions` | yes | Stop any currently active actions (defaults to true). ## Service {% my developer_call_service service="automation.toggle" %} diff --git a/source/_docs/configuration/splitting_configuration.markdown b/source/_docs/configuration/splitting_configuration.markdown index 76cfefbcf7b..1582b8dabac 100644 --- a/source/_docs/configuration/splitting_configuration.markdown +++ b/source/_docs/configuration/splitting_configuration.markdown @@ -189,15 +189,14 @@ That about wraps it up. If you have issues checkout `home-assistant.log` in the configuration directory as well as your indentations. If all else fails, head over to our [Discord chat server][discord] and ask away. -## Debugging multiple configuration files +## Debugging configuration files -If you have many configuration files, the `check_config` script allows you to see how Home Assistant interprets them: +If you have many configuration files, Home Assistant provides a CLI that allows you to see how it interprets them, each installation type has it's own section in the common-tasks about this: -- Listing all loaded files: `hass --script check_config --files` -- Viewing a component's configuration: `hass --script check_config --info light` -- Or all components' configuration: `hass --script check_config --info all` - -You can get help from the command line using: `hass --script check_config --help` +- [Operating System](/common-tasks/os/#configuration-check) +- [Container](/common-tasks/container/#configuration-check) +- [Core](/common-tasks/core/#configuration-check) +- [Supervised](/common-tasks/supervised/#configuration-check) ## Advanced Usage diff --git a/source/_docs/configuration/troubleshooting.markdown b/source/_docs/configuration/troubleshooting.markdown index 399853c9148..b6880bde4a3 100644 --- a/source/_docs/configuration/troubleshooting.markdown +++ b/source/_docs/configuration/troubleshooting.markdown @@ -19,9 +19,12 @@ If you have incorrect entries in your configuration files you can use the config One of the most common problems with Home Assistant is an invalid `configuration.yaml` or other configuration file. -- With Home Assistant OS and Supervised you can use the [`ha` command](/hassio/commandline/#home-assistant): `ha core check`. - - You can test your configuration with Home Assistant Core using the command line with: `hass --script check_config`. If you need to provide the path for your configuration you can do this using the `-c` argument like this: `hass --script check_config -c /path/to/your/config/dir`. - - On Docker you can use `docker exec home-assistant python -m homeassistant --script check_config --config /config` - where `home-assistant` is the name of the container. +- Home Assistant provides a CLI that allows you to see how it interprets them, each installation type has it's own section in the common-tasks about this: + - [Operating System](/common-tasks/os/#configuration-check) + - [Container](/common-tasks/container/#configuration-check) + - [Core](/common-tasks/core/#configuration-check) + - [Supervised](/common-tasks/supervised/#configuration-check) + - The configuration files, including `configuration.yaml` must be UTF-8 encoded. If you see error like `'utf-8' codec can't decode byte`, edit the offending configuration and re-save it as UTF-8. - You can verify your configuration's YAML structure using [this online YAML parser](http://yaml-online-parser.appspot.com/) or [YAML Lint](http://www.yamllint.com/). - To learn more about the quirks of YAML, read [YAML IDIOSYNCRASIES](https://docs.saltstack.com/en/latest/topics/troubleshooting/yaml_idiosyncrasies.html) by SaltStack (the examples there are specific to SaltStack, but do explain YAML issues well). diff --git a/source/_faq/component.markdown b/source/_faq/component.markdown index 4acaa816335..950d2472e22 100644 --- a/source/_faq/component.markdown +++ b/source/_faq/component.markdown @@ -6,4 +6,9 @@ ha_category: Configuration When an integration does not show up, many different things can be the case. Before you try any of these steps, make sure to look at the `home-assistant.log` file and see if there are any errors related to your integration you are trying to set up. -If you have incorrect entries in your configuration files you can use the `check_config` script to assist in identifying them: `hass --script check_config`. +If you have incorrect entries in your configuration files you can use the CLI script to check your configuration, each installation type has it's own section in the common-tasks about this: + +- [Operating System](/common-tasks/os/#configuration-check) +- [Container](/common-tasks/container/#configuration-check) +- [Core](/common-tasks/core/#configuration-check) +- [Supervised](/common-tasks/supervised/#configuration-check) \ No newline at end of file diff --git a/source/_includes/common-tasks/configuration_check.md b/source/_includes/common-tasks/configuration_check.md index 2a5b598083e..4f39fdce11e 100644 --- a/source/_includes/common-tasks/configuration_check.md +++ b/source/_includes/common-tasks/configuration_check.md @@ -8,11 +8,37 @@ ha core check {% elsif page.installation == "container" %} +_If your container name is something other than `homeassistant`, change that part in the examples below._ + +Run the full check: + ```bash docker exec homeassistant python -m homeassistant --script check_config --config /config ``` -_If your container name is something other than `homeassistant`, change that part._ +Listing all loaded files: + +```bash +docker exec homeassistant python -m homeassistant --script check_config --files +``` + +Viewing a component’s configuration ([`light`](/integrations/light) in this example): + +```bash +docker exec homeassistant python -m homeassistant --script check_config --info light +``` + +Or all components’ configuration + +```bash +docker exec homeassistant python -m homeassistant --script check_config --info all +``` + +You can get help from the command line using: + +```bash +docker exec homeassistant python -m homeassistant --script check_config --help +``` {% elsif page.installation == "core" %} @@ -30,10 +56,36 @@ _If your container name is something other than `homeassistant`, change that par 3. Run the configuration check + Run the full check: + ```bash hass --script check_config ``` + Listing all loaded files: + + ```bash + hass --script check_config --files + ``` + + Viewing a component’s configuration ([`light`](/integrations/light) in this example): + + ```bash + hass --script check_config --info light + ``` + + Or all components’ configuration + + ```bash + hass --script check_config --info all + ``` + + You can get help from the command line using: + + ```bash + hass --script check_config --help + ``` + 4. When that is complete restart the service for it to use the new files. {% endif %} diff --git a/source/_includes/installation/container/alternative.md b/source/_includes/installation/container/alternative.md index 1c64f54da5f..549f72836b4 100644 --- a/source/_includes/installation/container/alternative.md +++ b/source/_includes/installation/container/alternative.md @@ -54,7 +54,7 @@ Remark: to update your Home Assistant on your Docker within Synology NAS, you ju - Wait until the system-message/-notification comes up, that the download is finished (there is no progress bar) - Move to "Container"-section - Stop your container if it's running -- Right-click on it and select "Action"->"Clear". You won't lose any data, as all files are stored in your configuration-directory +- Right-click on it and select "Action"->"Reset". You won't lose any data, as all files are stored in your configuration-directory - Start the container again - it will then boot up with the new Home Assistant image Remark: to restart your Home Assistant within Synology NAS, you just have to do the following: @@ -136,4 +136,4 @@ That will tell Home Assistant where to look for our Z-Wave radio. ```yaml device_tracker: - platform: bluetooth_tracker -``` \ No newline at end of file +``` diff --git a/source/_includes/installation/core.md b/source/_includes/installation/core.md index a61f904d716..c4fa43e4199 100644 --- a/source/_includes/installation/core.md +++ b/source/_includes/installation/core.md @@ -86,6 +86,8 @@ hass You can now reach your installation via the web interface on `http://homeassistant.local:8123`. +If this address doesn't work you may also try `http://localhost:8123` or `http://X.X.X.X:8123` (replace X.X.X.X with your machines’ IP address). +