-
-
Notifications
You must be signed in to change notification settings - Fork 8.3k
Add documentation for Backup integration #21612
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
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
486602e
Add documentation for Backup integration
ludeeus ead2621
Apply suggestions from code review
ludeeus 3d64dfe
Merge branch 'next' of github.com:home-assistant/home-assistant.io in…
ludeeus 57b5e74
Adjust version and default config
ludeeus File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Wonder if we can add a My link that works for both hassio + backup integration.
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.
the frontend handles that, so yes
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.
This route to the documentation not to the instance so not sure it should be here at all. but for other places, we can do it.