No description
  • Python 67.4%
  • JavaScript 21.2%
  • HTML 11%
  • Dockerfile 0.4%
Find a file
2026-09-01 17:32:12 +02:00
docs/images FOXHASS-011: round README logo 2026-09-01 15:02:04 +02:00
foxforge_proton_backup FOXHASS-014: stream backup imports to Supervisor 2026-09-01 17:32:12 +02:00
.gitignore FOXHASS-001: add Proton Backup foundation 2026-08-31 15:34:30 +02:00
README.md FOXHASS-012: import backups from Proton Drive 2026-09-01 16:14:43 +02:00
repository.yaml FOXHASS-001: add Proton Backup foundation 2026-08-31 15:34:30 +02:00

FoxHass Backup

FoxHass Backup fox logo


What it does

FoxHass Backup creates Home Assistant backups through the Supervisor API and copies them to Proton Drive.

Local backup first. Proton Drive as the protected second copy.

Features

  • Create Home Assistant backups through the Supervisor backup API.
  • Upload copies to Proton Drive with Proton's official Drive CLI.
  • Install and verify the recommended Proton Drive CLI directly from FoxHass.
  • Connect Proton Drive through its browser/device login flow.
  • Keep encrypted-vault unlock state only in memory after unlock.
  • Schedule protected backups every 1, 2, 3, 4, 7, 14, or 30 days.
  • Show Proton status, CLI status, vault state, retention, and the next scheduled run.
  • Use Home Assistant ingress for the FoxHass dashboard.

Requirements

  • Home Assistant OS or a supervised installation with app support.
  • aarch64, amd64, or armv7.
  • A Proton account with Proton Drive access.
  • Internet access for CLI installation, authentication, and uploads.
  • Enough local storage for at least one full Home Assistant backup.

Installation

  1. Add the FoxHass Backup repository to Home Assistant's app store.
  2. Install FoxHass Backup.
  3. Start the app and open it from the Home Assistant sidebar.
  4. Keep the default retention values initially unless you have a specific backup policy.
Option Default Meaning
Proton folder Home Assistant Backups Folder in Proton Drive for FoxHass backup copies.
Daily backups kept 7 Number of recent daily restore points to retain.
Weekly backups kept 4 Number of weekly restore points to retain.
Monthly backups kept 6 Number of monthly restore points to retain.

First-time setup

1. Install Proton Drive CLI

Choose Install Proton CLI in FoxHass Backup.

Leave Auto-detect (recommended) selected unless you specifically need another build. FoxHass downloads the official Proton Drive CLI and verifies it before installation.

2. Connect Proton Drive

Choose Connect Proton Drive.

FoxHass opens Proton's browser login flow. If the browser does not open automatically, the dashboard displays a clickable Proton login URL. Complete authentication in the browser and return to FoxHass.

The Proton Drive card should then show a green status dot and Connected.

3. Unlock the encrypted vault

Choose Unlock vault and enter the vault passphrase.

For safety, the unlocked vault state is kept only in memory. After FoxHass Backup or Home Assistant restarts, unlock the vault again before creating a protected backup or relying on scheduled backups.

4. Create the first protected backup

Choose Create backup now.

FoxHass creates a local Home Assistant backup first, then uploads the protected second copy to Proton Drive. Confirm that it appears in the selected Proton Drive folder before relying on the schedule.

Automatic backups

Choose Schedule backups to enable automatic protected backups.

You can choose:

  • Whether the schedule is enabled
  • An interval of 1, 2, 3, 4, 7, 14, or 30 days
  • A daily run time

The dashboard shows the next planned run. A scheduled backup is safely skipped when the schedule is disabled, Proton Drive is disconnected, or the encrypted vault has not been unlocked after an app restart.

Restore

Choose Restore from Proton in FoxHass Backup to list the protected FoxHass backups in the configured Proton Drive folder.

FoxHass downloads the selected backup to private temporary storage, verifies its size, and imports it into Home Assistant. It does not start a restore automatically.

Open Home Assistant's standard backup tools to inspect the imported backup and decide whether to restore it. Periodically test that you can import and restore a backup successfully.

Security model

  • FoxHass Backup uses Proton's official Drive CLI.
  • Proton authentication uses Proton's browser/device login flow.
  • The encrypted vault passphrase is not stored in app options, logs, or normal persistent state.
  • Vault unlock state is intentionally lost after an app restart.
  • The local Home Assistant backup is created before the Proton Drive transfer starts.
  • Proton Drive is an additional recovery layer, not the only backup.

Troubleshooting

Symptom What to check
Proton CLI shows Not installed Use Install Proton CLI with Auto-detect selected.
Proton Drive shows Not connected Choose Connect Proton Drive and complete browser login.
Scheduled backup is skipped after a restart Use Unlock vault again, then confirm Proton Drive is connected.
The next run is wrong Open Schedule backups and confirm interval, time, and enabled state.
A backup did not reach Proton Drive Check FoxHass logs, internet access, Proton status, and available Proton Drive storage.

Development

Before committing changes, run the relevant checks:

python3 -m py_compile foxforge_proton_backup/rootfs/app/app.py
node --check foxforge_proton_backup/rootfs/app/app.js
git diff --check
git status --short

Project status

FoxHass Backup is actively evolving. Always verify a new version with a manual protected backup before relying on automatic scheduling.


License

Project license information will be added later.


Responsible Use

FoxHass Backup is intended for personal use and for Home Assistant systems where the user owns or has permission to control the connected hardware and backup data.

Please respect applicable laws, account ownership, device ownership, and privacy when connecting FoxHass Backup to Home Assistant and Proton Drive.

Users are responsible for ensuring that they have permission to access, back up, and restore the connected systems and data.


Credits

Built with ❤️ for Lanx by NodeFox 🦊

Maintained by Eddie Nielsen

Learn. Adopt. Survive. Share.