General settings: replace section on reloading config by link (#32445)

This commit is contained in:
c0ffeeca7 2024-04-26 11:51:44 +02:00 committed by GitHub
parent 67a5bd7626
commit 29c320b323
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 21 additions and 19 deletions

View File

@ -8,8 +8,10 @@ related:
title: Storing credentials in `secrets.yaml` file
- docs: /common-tasks/os/#backups
title: Creating and restoring backups
- docs: /integrations/backup
- docs: /integrations/backup/docs/tools/dev-tools/#reloading-the-yaml-configuration
title: Creating backups for Home Assistant Container and Core
- docs: /docs/tools/dev-tools/#reloading-the-yaml-configuration
title: Reloading the YAML configuration from developer tools
---
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.
@ -35,22 +37,9 @@ _If you use {% term "Home Assistant Operating System" %}, you can find `configur
_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`.
1. 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**.
![Reload configuration changes](/images/docs/configuration/reloading_config.png)
2. If the integration is listed, select it to reload the settings.
3. If integration is not listed, you need to restart Home Assistant for changes to take effect:
- [Validate the configuration](#validating-the-configuration). Then, select the **Restart** button.
## Validating the configuration
After changing configuration or automation files, check if the configuration is valid.
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](/installation/#advanced-installation-methods). Check the common tasks for your installation type:
@ -58,3 +47,17 @@ The method for running a configuration check depends on your [installation type]
- [Configuration check on Supervised](/common-tasks/supervised/#configuration-check)
- [Configuration check on Container](/common-tasks/container/#configuration-check)
- [Configuration check on Core](/common-tasks/core/#configuration-check)
## 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.
1. Under **Settings**, select the three dots menu (top right), select **Restart Home Assistant** > **Quick reload**.
![Settings, three dot menu, restart Home Assistant](/images/docs/configuration/settings_restart_ha.png)
2. If you find that your changes were not applied, you need to restart.
- Select **Restart Home Assistant**.
- Note: This interrupts automations and scripts.
![Reload and restart buttons](/images/docs/configuration/reload_restart.png)

View File

@ -13,6 +13,8 @@ As part of the default onboarding process, Home Assistant can detect your locati
Screenshot showing the General settings page.
</p>
The general settings described here are managed by the [Home Assistant Core integration](/integrations/homeassistant/). If you are interested in the services offered by this integration, check out the integration documentation.
## Editing the general settings
To change the general settings that were defined during onboarding, follow these steps:
@ -27,7 +29,4 @@ To change the general settings that were defined during onboarding, follow these
![Setting fields are grayed out because the configuration settings stored in configuration.yaml file](/images/docs/configuration/general-settings-stored-in-config-yaml.png)
## Reload core service
Home Assistant offers a service to reload the core configuration while Home Assistant is running called {% my developer_call_service service="homeassistant.reload_core_config" %}. This allows you to change any of the above sections and see it being applied without having to restart Home Assistant. To call this service, go to the "{% my developer_services %}" tab under {% my developer_services title="Developer Tools" %}, select the {% my developer_call_service service="homeassistant.reload_core_config" %} service and click the "CALL SERVICE" button. Alternatively, you can press the "Location & Customizations" button under {% my server_controls title="Developer Tools > YAML" %}.
5. To apply the changes, follow the steps on [reloading the configuration](/docs/configuration/#reloading-configuration-changes).

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 25 KiB