diff --git a/source/_docs/troubleshooting_general.markdown b/source/_docs/troubleshooting_general.markdown new file mode 100644 index 00000000000..e50d69b8245 --- /dev/null +++ b/source/_docs/troubleshooting_general.markdown @@ -0,0 +1,43 @@ +--- +title: "General troubleshooting" +description: "General troubleshooting information" +--- + +This page provides some information about more generic troubleshooting topics. + +## Home Assistant went into recovery mode + +### Symptom: Home Assistant is in recovery mode + +On top of the page you see a red banner. On the **Overview** page, you see a **Recovery mode** notification. + +![image](/images/docs/troubleshooting/recovery_mode_active.png) + +### Description + +When Home Assistant is in recovery mode, there was an issue with the configuration. + +Recovery mode loads a minimum set of integrations to allow troubleshooting the configuration. Recovery mode will use the parts of the configuration that was used the last time Home Assistant started successfully. You can still see the user interface, the settings, and add-ons. + +### Resolution + +You need to identify the issue in the configuration files and fix it there. The issue could be caused by something as simple as an invalid YAML file. + +- If you are running Home Assistant Operating System, you can install an add-on such as VS code to edit the configuration file if needed. +- If you are still logged in, you can [edit your configuration](/docs/configuration/#editing-configurationyaml). + - In the Home Assistant user interface, open the add-on you usually use and edit the configuration file. +- Restart Home Assistant. +- If you are locked out because you forgot your password, you cannot edit the configuration file from the user interface. Follow the steps to [reset your password](/docs/locked_out/). + +## Restarting Home Assistant in safe mode + +If your Home Assistant is acting up and you cannot identify a root cause, you can use **Safe mode** to narrow down the number of possible causes. +Safe mode loads Home Assistant Core, but no custom integrations, no custom cards, and no custom themes. If the issue does not persist in Safe mode, the issue is not with Home Assistant Core. Before reporting an issue, check if the issue persists in Safe mode. + +To enable Safe mode, go to **Settings** > **System** > **Restart Home Assistant** (top right) > **Restart Home Assistant in safe mode**. + +## Related topics + +- [Editing your configuration](/docs/configuration/#editing-configurationyaml) +- [Recovery mode integration](/integrations/recovery_mode/) +- [Resetting your password](/docs/locked_out/) \ No newline at end of file diff --git a/source/_includes/asides/docs_navigation.html b/source/_includes/asides/docs_navigation.html index b41064061be..75f70720df2 100644 --- a/source/_includes/asides/docs_navigation.html +++ b/source/_includes/asides/docs_navigation.html @@ -16,6 +16,10 @@ {% active_link /docs/troubleshooting/ Troubleshooting installation %} +
  • + {% active_link /docs/troubleshooting_general/ General troubleshooting + %} +
  • diff --git a/source/_integrations/recovery_mode.markdown b/source/_integrations/recovery_mode.markdown index 22be87e3534..79080165524 100644 --- a/source/_integrations/recovery_mode.markdown +++ b/source/_integrations/recovery_mode.markdown @@ -10,19 +10,23 @@ ha_quality_scale: internal ha_integration_type: system --- -The `recovery_mode` integration is an internally used integration by the +The **Recovery mode** integration is an internal integration used by the Home Assistant Core. -You don't have to configure it in any way since it is automatically always +You don't have to configure it since it is automatically always available when Home Assistant needs it. If, during startup, Home Assistant has problems reading your configuration, -it will still continue to start using bits and pieces from the configuration -of the last time it did start. +it will still continue to start using parts of the configuration +from the last time Home Assistant did start. -When this happens, Home Assistant will start in "Recovery mode" using this -integration. In this mode, nothing is loaded, but it does give you access to +When this happens, Home Assistant will start in **Recovery mode** using this +integration. In this mode, no user configured integrations are loaded, but it does give you access to the Home Assistant frontend, settings and add-ons. This gives you the possibility to correct the issue and restart Home Assistant to re-try. + +## Related topics + +- [General troubleshooting](/docs/troubleshooting_general/) \ No newline at end of file diff --git a/source/images/docs/troubleshooting/recovery_mode_active.png b/source/images/docs/troubleshooting/recovery_mode_active.png new file mode 100644 index 00000000000..ed08e8a5515 Binary files /dev/null and b/source/images/docs/troubleshooting/recovery_mode_active.png differ