-
-
Notifications
You must be signed in to change notification settings - Fork 7.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Backups #36651
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Warning Rate limit exceeded@c0ffeeca7 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 20 minutes and 0 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughThe pull request involves updates to two documentation files related to backup and network storage in Home Assistant. The changes focus on improving the clarity, comprehensiveness, and structure of the documentation. The backup documentation has been expanded to provide more detailed guidance on backup processes, including preparation steps, automatic backup configuration, and backup location management. The network storage documentation has been refined to better explain backup usage types, default backup location selection, and added troubleshooting information. Changes
Sequence DiagramsequenceDiagram
participant User
participant HA as Home Assistant
participant Storage as Backup Storage
User->>HA: Configure Backup Settings
HA->>Storage: Set Backup Location
HA->>Storage: Configure Backup Schedule
HA->>Storage: Define Retention Policy
Storage-->>HA: Backup Created
User->>HA: Download/Manage Backups
This sequence diagram illustrates the high-level process of configuring and managing backups in Home Assistant, showing the interactions between the user, Home Assistant, and backup storage. Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (4)
source/_includes/common-tasks/network_storage.md (1)
74-74
: Improve clarity of backup usage type descriptionThe description should clarify that this becomes the default target for the first storage added. Consider rewording for better clarity.
- description: This will become a target. You can use it when creating an automatic or manual backup. The first storage you add of this type becomes your new default target. If you want to change the default target, [check out the documentation below](#change-default-backup-location). + description: "This storage will be available as a backup target for both automatic and manual backups. The first storage you add of this type automatically becomes your default backup target. You can change this later (see [Change default backup location](#change-default-backup-location))."source/_includes/common-tasks/backups.md (3)
3-5
: Grammar improvements neededThe text needs some grammatical refinements for better clarity.
-It is important to regularly back up your Home Assistant setup. You may have spent many hours configuring your system and creating automations. Keep your configurations safe so that you can [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 important to regularly back up your Home Assistant setup. You may have spent many hours configuring your system and creating automations. Keep your configurations safe so you can [restore](#restoring-a-backup) your system (or parts of it) if a rollback is needed or when migrating Home Assistant to new hardware. -Backups are encrypted and stored in a compressed archive file (.tar) and by default, stored locally in the `/backup` directory. +Backups are encrypted and stored in a compressed archive file (.tar) and, by default, stored locally in the `/backup` directory.🧰 Tools
🪛 LanguageTool
[uncategorized] ~5-~5: Possible missing comma found.
Context: ...red in a compressed archive file (.tar) and by default, stored locally in the `/bac...(AI_HYDRA_LEO_MISSING_COMMA)
31-49
: Comprehensive automatic backup setup instructionsThe automatic backup setup instructions are clear and include important considerations about retention and data selection. However, there's a grammatical issue with "backup" usage.
-6. Define the data you want to backup. +6. Define the data you want to back up.🧰 Tools
🪛 LanguageTool
[grammar] ~42-~42: The word “backup” is a noun. The verb is spelled with a space.
Context: ...deleted. 6. Define the data you want to backup. - It is recommended to disable medi...(NOUN_VERB_CONFUSION)
[style] ~45-~45: As an alternative to the over-used intensifier ‘quite’, consider replacing this phrase.
Context: ... restore. - Some add-ons may also be quite large. 7. [Define the location for backups](#...(EN_WEAK_ADJECTIVE)
🪛 Markdownlint (0.37.0)
46-46: null
Link fragments should be valid(MD051, link-fragments)
66-79
: Manual backup instructions need grammatical fixesThe manual backup instructions are clear but contain the same grammatical issue with "backup" usage.
-3. Define the data you want to backup. +3. Define the data you want to back up.🧰 Tools
🪛 LanguageTool
[grammar] ~72-~72: The word “backup” is a noun. The verb is spelled with a space.
Context: ...ackup**. 3. Define the data you want to backup. - It is recommended to disable medi...(NOUN_VERB_CONFUSION)
[style] ~75-~75: As an alternative to the over-used intensifier ‘quite’, consider replacing this phrase.
Context: ... restore. - Some add-ons may also be quite large. 4. Provide a name for the backup. 5. C...(EN_WEAK_ADJECTIVE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (4)
source/images/screenshots/network-storage/backup_locations_all.png
is excluded by!**/*.png
source/images/screenshots/network-storage/backup_select_local_default.png
is excluded by!**/*.png
source/images/screenshots/network-storage/change_backup_dark.png
is excluded by!**/*.png
source/images/screenshots/network-storage/change_backup_light.png
is excluded by!**/*.png
📒 Files selected for processing (2)
source/_includes/common-tasks/backups.md
(3 hunks)source/_includes/common-tasks/network_storage.md
(2 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_includes/common-tasks/backups.md
[uncategorized] ~5-~5: Possible missing comma found.
Context: ...red in a compressed archive file (.tar) and by default, stored locally in the `/bac...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~19-~19: Possible missing comma found.
Context: ...migrate the system to new hardware, for example from a Raspberry Pi Compute Module ...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~42-~42: The word “backup” is a noun. The verb is spelled with a space.
Context: ...deleted. 6. Define the data you want to backup. - It is recommended to disable medi...
(NOUN_VERB_CONFUSION)
[style] ~45-~45: As an alternative to the over-used intensifier ‘quite’, consider replacing this phrase.
Context: ... restore. - Some add-ons may also be quite large. 7. [Define the location for backups](#...
(EN_WEAK_ADJECTIVE)
[uncategorized] ~52-~52: Possible missing comma found.
Context: ...s recommended to keep a copy on another system and ideally also one off-site. #### Ab...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~72-~72: The word “backup” is a noun. The verb is spelled with a space.
Context: ...ackup**. 3. Define the data you want to backup. - It is recommended to disable medi...
(NOUN_VERB_CONFUSION)
[style] ~75-~75: As an alternative to the over-used intensifier ‘quite’, consider replacing this phrase.
Context: ... restore. - Some add-ons may also be quite large. 4. Provide a name for the backup. 5. C...
(EN_WEAK_ADJECTIVE)
🪛 Markdownlint (0.37.0)
source/_includes/common-tasks/backups.md
46-46: null
Link fragments should be valid
(MD051, link-fragments)
🔇 Additional comments (4)
source/_includes/common-tasks/network_storage.md (1)
83-91
: Well-structured default backup location instructionsThe instructions are clear, concise, and include helpful troubleshooting information. The addition of the screenshot enhances user understanding.
source/_includes/common-tasks/backups.md (3)
19-30
: Excellent preparation guidanceThe preparation steps are well-structured and provide valuable guidance for users, especially the addition of database size checking and disk space verification.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~19-~19: Possible missing comma found.
Context: ...migrate the system to new hardware, for example from a Raspberry Pi Compute Module ...(AI_HYDRA_LEO_MISSING_COMMA)
50-64
: Clear backup location documentation with helpful visual aidThe backup location section effectively explains the options and includes a helpful screenshot. The Home Assistant Cloud storage limit is clearly stated.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~52-~52: Possible missing comma found.
Context: ...s recommended to keep a copy on another system and ideally also one off-site. #### Ab...(AI_HYDRA_LEO_MISSING_COMMA)
89-105
: Well-organized download instructionsThe download instructions are comprehensive and provide multiple options with clear steps. The inclusion of file access configuration reference is particularly helpful.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 3
🧹 Nitpick comments (3)
source/_includes/common-tasks/backups.md (3)
Line range hint
3-18
: Consider adding backup size considerations in the introductionThe introduction effectively explains the importance of backups and their contents. Consider adding a note about typical backup sizes or factors that affect backup size (like media files and database size) early in this section, as this information becomes crucial later in the preparation steps.
🧰 Tools
🪛 Markdownlint (0.37.0)
1-1: null
First line in a file should be a top-level heading(MD041, first-line-heading, first-line-h1)
Line range hint
80-88
: Consider enhancing CLI documentationThe CLI section could be more helpful with additional examples and common use cases, such as:
- Creating partial backups
- Specifying backup names with timestamps
- Using backup password protection
Would you like me to provide detailed examples for these scenarios?
🧰 Tools
🪛 Markdownlint (0.37.0)
46-46: null
Link fragments should be valid(MD051, link-fragments)
89-105
: Consider adding security recommendations for backup storageWhile the download instructions are clear, consider adding security recommendations for storing downloaded backups, such as:
- Encrypting external storage devices
- Secure handling of backup files
- Regular verification of downloaded backups
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_includes/common-tasks/backups.md
(3 hunks)
🧰 Additional context used
🪛 Markdownlint (0.37.0)
source/_includes/common-tasks/backups.md
46-46: null
Link fragments should be valid
(MD051, link-fragments)
🔇 Additional comments (2)
source/_includes/common-tasks/backups.md (2)
50-65
: Well-structured backup locations sectionThe section effectively explains different backup location options, including cloud storage limitations and network storage setup. The screenshot addition enhances the user experience.
Line range hint
106-200
: Excellent restoration and migration documentationThe restoration section is comprehensive and well-structured, with clear prerequisites and detailed migration steps. The inclusion of estimated duration and storage capacity requirements is particularly helpful.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, @c0ffeeca7 👍
../Frenck
Proposed change
Type of change
current
branch).current
branch).next
branch).next
branch).Additional information
Checklist
current
branch.next
branch.Summary by CodeRabbit