From 29c320b323c39117c5d3f12e09f01b54ec1231ca Mon Sep 17 00:00:00 2001 From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Date: Fri, 26 Apr 2024 11:51:44 +0200 Subject: [PATCH] General settings: replace section on reloading config by link (#32445) --- source/_docs/configuration.markdown | 33 ++++++++++-------- source/_docs/configuration/basic.markdown | 7 ++-- .../docs/configuration/reload_restart.png | Bin 0 -> 30674 bytes .../configuration/settings_restart_ha.png | Bin 0 -> 25734 bytes 4 files changed, 21 insertions(+), 19 deletions(-) create mode 100644 source/images/docs/configuration/reload_restart.png create mode 100644 source/images/docs/configuration/settings_restart_ha.png diff --git a/source/_docs/configuration.markdown b/source/_docs/configuration.markdown index 66f388bfcc1..1a13dbca13b 100644 --- a/source/_docs/configuration.markdown +++ b/source/_docs/configuration.markdown @@ -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**. - -  - -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**. + +  + +2. If you find that your changes were not applied, you need to restart. + - Select **Restart Home Assistant**. + - Note: This interrupts automations and scripts. + +  diff --git a/source/_docs/configuration/basic.markdown b/source/_docs/configuration/basic.markdown index 9fc13e7f9f0..afac72742f3 100644 --- a/source/_docs/configuration/basic.markdown +++ b/source/_docs/configuration/basic.markdown @@ -13,6 +13,8 @@ As part of the default onboarding process, Home Assistant can detect your locati Screenshot showing the General settings page.
+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  -## 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). diff --git a/source/images/docs/configuration/reload_restart.png b/source/images/docs/configuration/reload_restart.png new file mode 100644 index 0000000000000000000000000000000000000000..662ed31d26123da2fbfcc6cc9b2cf2966613cad7 GIT binary patch literal 30674 zcma&N18`+gxaWIf+qOFC*tTsu>DV?pPCB-2+eyc^jZQkYHK*^~dtbeI^QNYDowIk< z**JUQTi^Qq|0_aKUIGCY7Zv~jAV^7yDgywZpa1{}4m2e2JE7Az7q|1fW*qr_mE(dd|Ij$L)CekVIMcT=ey5&I0`=z7j{z0^rDdG0$+Z&k
zwZ*t4@EC;jxxz^aRaN~AEa-yt?Pt{$br)rW*JWi*Oxie@;+(XG6yyzLMBsfe%+M_m
z25c$^m+V6;y3B_76? D~d*pB1yGo0ocknGP?n|#WXmaWjQml3Sj`5S5+l&;>h;H~+ZEj`;zqYW_jE)*r
zkpKR?FMUnrs~2=Cn+p`AAN=|;-cnI#>6ztE{y6j?5Juj(cax#FX%(F}d#Hi}WtUUz
zOzYZ?T=?n0h)yFPgKcc(xu4?TJ=XKV-O>!_uTBYQQnmO-mLGmo1inQ0=hi;qEa}$*
z3f(_(L};NF+A8_3VC*WMI{ogk5#5MZBXYeQBu3l;OS)9(D@b(W@oiObKYO`f(D>xY
z*YL=2-jvQ*Zk~MDHEpQIWs;C7bkU*2Sj;_{(Tp)=@Q^>y7<6wieS%Pj;dS85-OhTF
zT~_G0kZycx9xTOUs&H|bdi9KcFcV}lqdn`r1i4L><9RkXii{_x%9hQZ8qf8RgexNh
zzbYVfkR?NE(cw14M#qr!E5nhpT-X1DB7OLFesjhmzi+gc<=T(ka?8TPlp!zh2Do1=
z%H~UcF;B$Yr-dwQUAekyA2UwG#cRYC+co5`gYeel5BgmgT5+SLp*S(^l_ZIyek`u3
zwdRL@T};ppQWF?I7)MxUs6CK7!mv@HP~x8MeQ0Qx>e~K${d#k6qe=s^(u$n`r2CJ
zx3