When downloading from backup page, backup is decrypted #37324

c0ffeeca7 · 2025-02-06T07:42:56Z

Proposed change

Type of change

Spelling, grammar or other readability improvements (current branch).
Adjusted missing or incorrect information in the current documentation (current branch).
Added documentation for a new integration I'm adding to Home Assistant (next branch).
- I've opened up a PR to add logos and icons in Brands repository.
Added documentation for a new feature I'm adding to Home Assistant (next branch).
Removed stale or deprecated documentation.

Additional information

Link to parent pull request in the codebase:
Link to parent pull request in the Brands repository:
This PR fixes or closes issue: fixes #

Checklist

This PR uses the correct branch, based on one of the following:
- I made a change to the existing documentation and used the current branch.
- I made a change that is related to an upcoming version of Home Assistant and used the next branch.
The documentation follows the Home Assistant documentation standards.

Summary by CodeRabbit

Documentation
- Updated the backup download guide to clarify that backups are decrypted in real time during the download process, ensuring a seamless experience when accessing backup data regardless of its source.

netlify · 2025-02-06T07:43:28Z

✅ Deploy Preview for home-assistant-docs ready!

Name	Link
🔨 Latest commit	`44e3ef1`
🔍 Latest deploy log	https://app.netlify.com/sites/home-assistant-docs/deploys/67a4695c44e3bd00083e8b68
😎 Deploy Preview	https://deploy-preview-37324--home-assistant-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

coderabbitai · 2025-02-06T07:45:15Z

📝 Walkthrough

Walkthrough

A documentation update was made to the backups instructions. The change adds a new line that clarifies the backup download process: when a backup is downloaded from the Home Assistant interface, it is decrypted on the fly. This information now explicitly states that the process—applicable to all backup locations, including Home Assistant Cloud—allows users to view the data using their preferred archive tool. No changes were made to the underlying functionality or public API declarations.

Changes

File	Change Summary
`source/_includes/.../backups.md`	Added a line clarifying that backup downloads include on-the-fly decryption, allowing users to access decrypted data using their preferred archive tool.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f322f6c and 44e3ef1.

📒 Files selected for processing (1)

source/_includes/common-tasks/backups.md (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

source/_includes/common-tasks/backups.md

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?

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

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)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

source/_includes/common-tasks/backups.md (1)

102-103: Clarify On-the-Fly Decryption in Backup Download Process

The newly added sentence clearly explains that when downloading a backup from the Home Assistant interface, the backup is decrypted on the fly—even for backups from Home Assistant Cloud. This additional detail enhances user understanding of the backup download process. As a minor suggestion, you might consider briefly noting any implications (e.g., performance considerations with large backups) if applicable to further inform users.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6ce7a21 and f322f6c.

📒 Files selected for processing (1)

source/_includes/common-tasks/backups.md (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (3)

GitHub Check: Redirect rules - home-assistant-docs
GitHub Check: Header rules - home-assistant-docs
GitHub Check: Pages changed - home-assistant-docs

source/_includes/common-tasks/backups.md

home-assistant · 2025-02-06T07:47:59Z

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

Co-authored-by: Franck Nijhof <[email protected]>

frenck

Thanks, @c0ffeeca7 👍

Oh! and good morning! ☕

../Frenck

c0ffeeca7 · 2025-02-06T08:34:47Z

Thanks 😄

When downloading from backup page, backup is decrypted

f322f6c

home-assistant bot added the current This PR goes into the current branch label Feb 6, 2025

coderabbitai bot reviewed Feb 6, 2025

View reviewed changes

frenck requested changes Feb 6, 2025

View reviewed changes

source/_includes/common-tasks/backups.md Outdated Show resolved Hide resolved

home-assistant bot marked this pull request as draft February 6, 2025 07:47

Update source/_includes/common-tasks/backups.md

44e3ef1

Co-authored-by: Franck Nijhof <[email protected]>

c0ffeeca7 marked this pull request as ready for review February 6, 2025 07:48

home-assistant bot requested a review from frenck February 6, 2025 07:48

frenck approved these changes Feb 6, 2025

View reviewed changes

frenck merged commit 67f0b28 into current Feb 6, 2025
9 checks passed

frenck deleted the decryption-on-download branch February 6, 2025 07:53

github-actions bot locked and limited conversation to collaborators Feb 7, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

When downloading from backup page, backup is decrypted #37324

When downloading from backup page, backup is decrypted #37324

Uh oh!

c0ffeeca7 commented Feb 6, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

netlify bot commented Feb 6, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Feb 6, 2025 •

edited

Loading

Walkthrough

Changes

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

home-assistant bot commented Feb 6, 2025

Uh oh!

frenck left a comment

Uh oh!

Uh oh!

c0ffeeca7 commented Feb 6, 2025

Uh oh!

Uh oh!

Uh oh!

When downloading from backup page, backup is decrypted #37324

When downloading from backup page, backup is decrypted #37324

Uh oh!

Conversation

c0ffeeca7 commented Feb 6, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed change

Type of change

Additional information

Checklist

Summary by CodeRabbit

Uh oh!

netlify bot commented Feb 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for home-assistant-docs ready!

Uh oh!

coderabbitai bot commented Feb 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

home-assistant bot commented Feb 6, 2025

Uh oh!

frenck left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

c0ffeeca7 commented Feb 6, 2025

Uh oh!

Uh oh!

c0ffeeca7 commented Feb 6, 2025 •

edited by coderabbitai bot

Loading

netlify bot commented Feb 6, 2025 •

edited

Loading

coderabbitai bot commented Feb 6, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)