4.5 KiB
title, description, related
| title | description | related | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 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).
Validating the configuration
After changing configuration or automation files, you can check if the configuration is valid. A configuration check is also applied automatically when you reload the configuration or when you restart Home Assistant.
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
Reloading the configuration to apply changes
For configuration changes to become effective, the configuration must be reloaded. 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 without needing to restart Home Assistant.
-
Under Settings, select the three dots menu (top right), select Restart Home Assistant > Quick reload.
-
If you find that your changes were not applied, you need to restart.
- Select Restart Home Assistant.
- Note: This interrupts automations and scripts.
