jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-23 17:27:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Config check: add steps how to check from UI (#32351)

Browse Source
This commit is contained in:
c0ffeeca7 2024-04-17 16:40:00 +02:00 committed by GitHub
parent 014695f5df
commit 73cb3fb99b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 22 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
source/_includes/common-tasks/configuration_check.md
View File

@ -2,12 +2,28 @@
{% if page.installation == "os" or page.installation == "supervised" %}
After changing configuration or automation files, check if the configuration is valid before restarting Home Assistant Core.
## To run a configuration check from the UI
1. Go to {% my profile title="your user profile" %} and enable **Advanced Mode**.
2. Go to {% my server_controls title="**Developer tools** > **YAML**" %} and in the **Configuration validation** section, select the **Check configuration** button.
- This is to make sure there are no syntax errors before restarting Home Assistant.
- It checks for valid YAML and valid config structures.
3. If you need to do a more comprehensive configuration check, [run the check from the CLI](#to-run-a-configuration-check-from-the-cli).
## To run a configuration check from the CLI
Use the following command to check if the configuration is valid. The command line configuration check validates the YAML files and checks for valid config structures, as well as some other elements.
```bash
ha core check
```
{% elsif page.installation == "container" %}
After changing configuration files, check if the configuration is valid before restarting Home Assistant Core.
_If your container name is something other than `homeassistant`, change that part in the examples below._
Run the full check:
@ -42,19 +58,21 @@ docker exec homeassistant python -m homeassistant --script check_config --help
{% elsif page.installation == "core" %}
1. Switch to the user that is running Home Assistant
After changing configuration files, check if the configuration is valid before restarting Home Assistant Core.
1. Switch to the user that is running Home Assistant.
```bash
sudo -u homeassistant -H -s
```
2. Activate the virtual environment that Home Assistant is running in
2. Activate the virtual environment that Home Assistant is running in.
```bash
source /srv/homeassistant/bin/activate
```
3. Run the configuration check
3. Run the configuration check.
Run the full check:
@ -86,6 +104,6 @@ docker exec homeassistant python -m homeassistant --script check_config --help
hass --script check_config --help
```
4. When that is complete restart the service for it to use the new files.
4. When that is complete, restart the service for it to use the new files.
{% endif %}