feat: guarantee 100% restore via explicit two-pillar backup model - #3
Merged
Conversation
Make the complete-recovery contract unmissable for new users: - Docs: state plainly that config repo (this add-on) + encrypted HA full backup = 100% restorable, and neither alone is enough. Sharpen the 'what is backed up where' table — name exactly what .storage/ holds (UI-added integrations, logins/tokens, registries, dashboards) and flag what lives outside /config (add-on data, /ssl) that the add-on cannot see. - Security: seed .gitignore now excludes *.token / .google.token so OAuth tokens (e.g. Google Calendar) never leak into the repo. - First bootstrap logs a disaster-recovery warning pointing at full backups. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Signed-off-by: Anil Belur <abelur@linuxfoundation.org>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Goal
Make it guaranteed and obvious that a user following this add-on ends up 100%% restorable — by nailing down the split: important declarative config → the config repo; everything else (secrets,
.storage/, DB, add-ons) → HA full backup (Google Drive). Neither pillar alone can restore HAOS; together they're complete. Prep for the HA-forum launch.Changes
Docs (
DOCS.md).storage/actually holds (UI-added integrations, logins/tokens, device/entity/area registries, UI dashboards) and flags data that lives outside/config(add-on configs/data,/ssl) that the add-on structurally cannot see.Security (
gitops_backup.sh).gitignorenow also excludes*.token/.google.token— OAuth tokens (e.g. Google Calendar) were previously not covered and could land in the repo.Tests
Bumps add-on to 0.2.0.