a8d577f012
* Configuration reload and validate: style tweaks * Apply suggestions from code review Co-authored-by: Klaas Schoute <klaas_schoute@hotmail.com> --------- Co-authored-by: Klaas Schoute <klaas_schoute@hotmail.com>
4.3 KiB
title, description
| title | description |
|---|---|
| Configuration.yaml | Configuring Home Assistant via text files. |
While you can configure most of Home Assistant directly from the user interface under {% my config %}, some parts need you to edit configuration.yaml. This file contains {% term integrations %} to be loaded along with their configurations. Throughout the documentation you will find snippets that you can add to your configuration file to enable specific functionality.
If you run into trouble while configuring Home Assistant, refer to the configuration troubleshooting page and the configuration.yaml examples.
Editing configuration.yaml
The easiest option to edit configuration.yaml is to use the {% my supervisor_addon title="Studio Code Server add-on" addon="a0d7b954_vscode" %}. This add-on runs VS Code, which offers live syntax checking and auto-fill of various Home Assistant entities. See here for details. If unavailable on your system, use {% my supervisor_addon title="File Editor add-on" addon="core_configurator" %} instead. Again, details can be found here.
If you prefer to use a file editor on your computer, use the {% my supervisor_addon title="Samba add-on" addon="core_samba" %} to access the files as a network share. More details can be found here.
The path to your configuration directory can be found in the Home Assistant {% term frontend %} by going to {% my system_health title="Settings > System > Repairs > System information from the top right menu" %}
Right under the version you are running, you will find what path Home Assistant has loaded the configuration from.
If you use {% term "Home Assistant Container" %}, you can find configuration.yaml in the config folder that you mounted in your container.
If you use {% term "Home Assistant Operating System" %}, you can find configuration.yaml in the /config folder of the installation.
If you use {% term "Home Assistant Core" %} , you can find configuration.yaml in the config folder passed to the hass command (default is ~/.homeassistant).
Reloading configuration changes
Most integrations in Home Assistant that do not interact with {% term devices %} or {% term services %} can reload changes made to their configuration in configuration.yaml.
-
To reload configuration changes, go to {% my server_controls title="Developer Tools > YAML" %} and scroll down to the YAML configuration reloading section (alternatively, hit "c" anywhere in the UI and search for "reload").
- You are presented with a list of integrations, such as Automations or Conversation.
-
If the integration is listed, select it to reload the settings.
-
If integration is not listed, you need to restart Home Assistant for changes to take effect:
- Validate the configuration. Then, select the Restart button.
Validating the configuration
After changing configuration or automation files, check if the configuration is valid.
The method for running a configuration check depends on your installation type. Check the common tasks for your installation type:
- Configuration check on Operating System
- Configuration check on Supervised
- Configuration check on Container
- Configuration check on Core