From 8c1aad514fcba7115181c7c1bf174760d870cfc1 Mon Sep 17 00:00:00 2001 From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Date: Thu, 11 Apr 2024 14:47:47 +0200 Subject: [PATCH] Backup: cosmetic tweaks (#32269) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Backup: cosmetic tweaks * Style tweak * Oxford comma! * Apply suggestions from code review Co-authored-by: Joakim Sørensen * Update source/_includes/common-tasks/backups.md Co-authored-by: Joakim Sørensen * Remove comment about not backing up add-ons. it is a workaround when moving to smaller systems only * Update source/_includes/common-tasks/backups.md Co-authored-by: Joakim Sørensen --------- Co-authored-by: Joakim Sørensen --- source/_includes/common-tasks/backups.md | 8 ++++++-- source/_includes/common-tasks/update.md | 8 ++++---- 2 files changed, 10 insertions(+), 6 deletions(-) diff --git a/source/_includes/common-tasks/backups.md b/source/_includes/common-tasks/backups.md index d5d2c4b121a..1d8d64dcbf3 100644 --- a/source/_includes/common-tasks/backups.md +++ b/source/_includes/common-tasks/backups.md @@ -1,6 +1,8 @@ ## Backups -Backup of your Home Assistant and add-on data and configuration. They are stored in a compressed archive file (.tar). Backups are made from the backups panel under {% my supervisor_backups title="**Settings** > **System** > **Backups**" %}. There is also a service available that allows you to trigger the creation of a backup from an automation. By default, backups are stored locally in the `/backup` directory. +Backup of your Home Assistant, add-on data, and configuration. Backups are used to [restore](#restoring-a-backup) a system or parts of it if a rollback is needed or to migrate your Home Assistant to new hardware. It is good practice to create a backup before updating. + +Backups are made from the backups panel under {% my supervisor_backups title="**Settings** > **System** > **Backups**" %}. There is also a [service](/integrations/hassio/#service-hassiobackup_full) available that allows you to trigger the creation of a backup from an automation. Backups are stored in a compressed archive file (.tar) and by default, stored locally in the `/backup` directory. A full backup includes the following directories: @@ -26,7 +28,9 @@ A partial backup consists of any number of the above default directories and ins 1. Go to {% my supervisor_backups title="**Settings** > **System** > **Backups**" %} in the UI. 2. Select the **Create backup** button in the lower right. 3. Provide a name for the backup. -4. Choose full or partial. +4. Choose **Full backup** or **Partial backup**. + - If you choose **Partial backup**, make sure to select Home Assistant and all the folders and add-ons you want to backup or migrate. + - Note that the number of add-ons increases the size of the backup as well as the time it takes to restore from that backup. 5. Optionally, enable password protection. 6. Select **Create** to begin the backup. diff --git a/source/_includes/common-tasks/update.md b/source/_includes/common-tasks/update.md index e4f924d7008..1df848b0d29 100644 --- a/source/_includes/common-tasks/update.md +++ b/source/_includes/common-tasks/update.md @@ -5,7 +5,7 @@ Best practice for updating a Home Assistant installation: 1. Backup your installation{% if page.installation == "os" or page.installation == "supervised" %}, using the backup functionality Home Assistant offers{% endif %}. 2. Check the release notes for backward-incompatible changes on [Home Assistant release notes](/blog/categories/core/). Be sure to check all release notes between the version you are running and the one you are upgrading to. Use the search function in your browser (`CTRL + f` / `CMD + f`) and search for **Backward-incompatible changes**. {% if page.installation == "os" or page.installation == "supervised" %} -3. Select "Create backup before updating" in case you encounter an issue that requires a rollback. +3. Select **Create backup before updating** in case you encounter an issue that requires a rollback. 4. Update Home Assistant. 5. Review persistent notifications and log to see if there are any issues with your configuration that need to be addressed. {% endif %} @@ -19,9 +19,9 @@ To update Home Assistant Core when you run Home Assistant {{ page.installation_n - title: Using the UI content: | - 1. Open your Home Assistant UI - 2. Navigate to the Settings panel - 3. On the top you will be presented with an update notification + 1. Open your Home Assistant UI. + 2. Navigate to the **Settings** panel. + 3. On the top you will be presented with an update notification. _If you do not see that notification you can click the overflow menu in the top right and select "Check for updates"._