Add information on recovery and safe mode (#31427)

* Add information on revocery and safe mode

- Create general troubleshooting section
- Document recovery and safe mode
- Tiny tweaks to recovery integration documentation page
- addresses feedback from #31387

* Rephrase

* Fix typo

* Rephrase

* Apply suggestions from code review

Co-authored-by: Martin Hjelmare <marhje52@gmail.com>

* Fix screenshot

* Amend resolution

* Fix typo

* Apply suggestions from code review

Co-authored-by: Martin Hjelmare <marhje52@gmail.com>

---------

Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
This commit is contained in:
c0ffeeca7 2024-02-26 08:59:55 +01:00 committed by GitHub
parent 3eb4adfab2
commit 3cf05e2511
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 57 additions and 6 deletions

View File

@ -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/)

View File

@ -16,6 +16,10 @@
{% active_link /docs/troubleshooting/ Troubleshooting installation
%}
</li>
<li>
{% active_link /docs/troubleshooting_general/ General troubleshooting
%}
</li>
</ul>
</li>
<li>

View File

@ -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/)

Binary file not shown.

After

Width:  |  Height:  |  Size: 35 KiB