From 486602e07ae8ef776be3393a966ecb9b485c9099 Mon Sep 17 00:00:00 2001 From: Ludeeus Date: Sat, 12 Feb 2022 14:09:01 +0000 Subject: [PATCH 1/3] Add documentation for Backup integration --- source/_integrations/backup.markdown | 29 ++++++++++++++++++++++++++++ source/installation/index.html | 6 ++++-- 2 files changed, 33 insertions(+), 2 deletions(-) create mode 100644 source/_integrations/backup.markdown diff --git a/source/_integrations/backup.markdown b/source/_integrations/backup.markdown new file mode 100644 index 000000000000..ba87ec805bab --- /dev/null +++ b/source/_integrations/backup.markdown @@ -0,0 +1,29 @@ +--- +title: Backup +description: System Health allow you to create backups on Core and Container installations. +ha_category: + - Other +ha_release: 2022.3 +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 installation, this backup file can be used if you migrate to Home Assistant Operating System. + +
+ +If you use Home Assistant Operating System or Home Assistant Supervised, this integration is not for you, you already have [Backup functionaloty with the Supervisor](/common-tasks/os/#backups). + +
+ +## Configuration + +```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" directory in the root of your configuration directory. diff --git a/source/installation/index.html b/source/installation/index.html index 008a6ee51691..ea12af20006a 100644 --- a/source/installation/index.html +++ b/source/installation/index.html @@ -228,8 +228,8 @@

Compare Installation Methods

✅❌❌✅ - Backups - ✅❌❌✅ + Backups + ✅✅1✅1✅ Managed OS @@ -237,4 +237,6 @@

Compare Installation Methods

+1: Backups for Home Assistant Core and Home Assistant Container is provided by the backup integration. + {% include getting-started/next_step.html step="onboarding" link="/getting-started/onboarding" %} From ead2621ad8faab0e03365ba69dec002aaf4d7dde Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Joakim=20S=C3=B8rensen?= Date: Sun, 13 Feb 2022 09:12:58 +0100 Subject: [PATCH 2/3] Apply suggestions from code review Co-authored-by: Paulus Schoutsen --- source/_integrations/backup.markdown | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/source/_integrations/backup.markdown b/source/_integrations/backup.markdown index ba87ec805bab..f9cbbb3a53bc 100644 --- a/source/_integrations/backup.markdown +++ b/source/_integrations/backup.markdown @@ -1,6 +1,6 @@ --- title: Backup -description: System Health allow you to create backups on Core and Container installations. +description: Allow creating backups of container and core installations. ha_category: - Other ha_release: 2022.3 @@ -8,11 +8,11 @@ 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 installation, this backup file can be used if you migrate to Home Assistant Operating System. +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.
-If you use Home Assistant Operating System or Home Assistant Supervised, this integration is not for you, you already have [Backup functionaloty with the Supervisor](/common-tasks/os/#backups). +If you use Home Assistant Operating System or Home Assistant Supervised, [back up functionality is already built-in]](/common-tasks/os/#backups).
From 57b5e7429adc63c81df898ecddf9561a76dbb004 Mon Sep 17 00:00:00 2001 From: Ludeeus Date: Tue, 1 Mar 2022 14:18:18 +0000 Subject: [PATCH 3/3] Adjust version and default config --- source/_integrations/backup.markdown | 6 +++--- source/_integrations/default_config.markdown | 1 + 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/source/_integrations/backup.markdown b/source/_integrations/backup.markdown index f9cbbb3a53bc..758c07ef405b 100644 --- a/source/_integrations/backup.markdown +++ b/source/_integrations/backup.markdown @@ -3,7 +3,7 @@ title: Backup description: Allow creating backups of container and core installations. ha_category: - Other -ha_release: 2022.3 +ha_release: 2022.4 ha_quality_scale: internal ha_domain: backup --- @@ -16,7 +16,7 @@ If you use Home Assistant Operating System or Home Assistant Supervised, [back u -## Configuration +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 @@ -26,4 +26,4 @@ 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" directory in the root of your configuration directory. +The backup files are stored in a new "backups" subdirectory in the root of your configuration directory. diff --git a/source/_integrations/default_config.markdown b/source/_integrations/default_config.markdown index ade52316437c..d31af4f781ba 100644 --- a/source/_integrations/default_config.markdown +++ b/source/_integrations/default_config.markdown @@ -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`)