Add documentation for Backup integration (#21612)

Co-authored-by: Paulus Schoutsen <balloob@gmail.com>
This commit is contained in:
Joakim Sørensen 2022-03-21 10:48:44 +01:00 committed by GitHub
parent 1129992661
commit 6acb64eff9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 34 additions and 2 deletions

View File

@ -0,0 +1,29 @@
---
title: Backup
description: Allow creating backups of container and core installations.
ha_category:
- Other
ha_release: 2022.4
ha_quality_scale: internal
ha_domain: backup
---
The Backup integration allow you to create and download backups for your Home Assistant Core and Home Assistant Container installations. This backup file can be used if you migrate to Home Assistant Operating System.
<div class="note">
If you use Home Assistant Operating System or Home Assistant Supervised, [back up functionality is already built-in]](/common-tasks/os/#backups).
</div>
This integration is by default enabled, unless you've disabled or removed the [`default_config:`](/integrations/default_config/) line from your configuration. If that is the case, the following example shows you how to enable this integration manually:
```yaml
# Example configuration.yaml entry
backup:
```
You need to restart Home Assistant after you add this configuration.
When it has started up again you will find a new "Backup" entry in the main menu (**Configuration** -> **Backup**).
The backup files are stored in a new "backups" subdirectory in the root of your configuration directory.

View File

@ -11,6 +11,7 @@ ha_quality_scale: internal
This integration is a meta-component and configures a default set of integrations for Home Assistant to load. The integrations that will be loaded are:
- [Automation](/integrations/automation/) (`automation`)
- [Backup](/integrations/backup/) (`backup`)
- [Home Assistant Cloud](/integrations/cloud/) (`cloud`)
- [Configuration](/integrations/config/) (`config`)
- [Counter](/integrations/counter/) (`counter`)

View File

@ -228,8 +228,8 @@ toc: true
<td></td><td></td><td></td><td></td>
</tr>
<tr>
<td><a href="/common-tasks/supervised/#backups" target="_blank">Backups</a></td>
<td></td><td></td><td></td><td></td>
<td><a href="/common-tasks/os/#backups" target="_blank">Backups</a></td>
<td></td><td><sup>1</sup></td><td><sup>1</sup></td><td></td>
</tr>
<tr>
<td>Managed OS</td>
@ -237,4 +237,6 @@ toc: true
</tr>
</table>
<sub>1: Backups for Home Assistant Core and Home Assistant Container is provided by the <a href="/integrations/backup" target="_blank"><code>backup</code> integration</a>.</sub>
{% include getting-started/next_step.html step="onboarding" link="/getting-started/onboarding" %}