Skip to content

Configuration

jl0906 edited this page Aug 4, 2026 · 1 revision

Configuration

All options are available from Settings → Devices & services → BackupCheckup → Configure. When the sidebar panel is enabled, administrators can edit the same values on its Settings page.

Runtime and hardware profile

Option Purpose
Runtime profile Selects a complete set of polling, size, and timeout limits.
Adaptive polling Uses a shorter interval during active operations and a longer backoff after repeated failures.

Runtime presets

Value Energy saving Home Assistant appliance Performance Server
Normal polling interval 15 min 10 min 5 min 2 min
Active polling interval 2 min 1 min 1 min 1 min
Error backoff interval 45 min 30 min 20 min 10 min
Failures before backoff 3 3 3 3
Maximum backup download 25 GB 50 GB 100 GB 250 GB
Maximum expanded size 125 GB 250 GB 500 GB 1000 GB
Verification timeout 90 min 60 min 45 min 30 min
Database timeout 20 min 15 min 10 min 10 min
Manual verification cooldown 30 min 15 min 10 min 5 min

The recommended profile is derived from board, architecture, and installation type. It is only a recommendation and is never silently changed later.

Custom runtime values

Option Range Explanation
Normal polling interval 1–60 min Interval for regular inventory and status updates. Shorter values create more activity.
Active polling interval 1–15 min Interval while a backup or verification operation is active. It may not exceed the normal interval.
Error backoff interval 5–240 min Pause after repeated update failures. It may not be shorter than the normal interval.
Failures before backoff 1–10 Consecutive failures required before backoff begins.
Maximum backup download 1–2048 GB Hard limit for a downloaded verification copy. Increase it only for an expected large backup.
Maximum expanded size 1–8192 GB Protects against unexpectedly expanding archives. It must be at least the download limit.
Verification timeout 1–1440 min Maximum duration of structural verification.
Database timeout 1–1440 min Maximum duration of SQLite PRAGMA integrity_check.
Manual verification cooldown 0–1440 min Prevents repeated expensive downloads. 0 disables only the cooldown, not parallel-run protection.

Monitoring policy

Balanced

  • maximum backup age: 4 days
  • size check: automatic
  • fixed minimum size: 1 MB
  • maximum size drop: 50%
  • required storage locations: 1
  • Repair issues: enabled
  • analytics window: 30 days

Strict

  • maximum backup age: 2 days
  • size check: automatic
  • fixed minimum size: 1 MB
  • maximum size drop: 35%
  • required storage locations: 2
  • Repair issues: enabled
  • analytics window: 30 days

Custom monitoring

Option Range Explanation
Maximum backup age 1–365 days The newest backup is stale after this many complete 24-hour periods.
Size check mode Automatic / Fixed minimum / Disabled Automatic compares backups with matching origin and scope. Fixed uses the configured minimum. Disabled suppresses size warnings.
Minimum backup size 0–102400 MB Lower bound for fixed-size checking. Fixed mode requires a value greater than zero.
Maximum size drop 0–100% Allowed reduction compared with a previous comparable backup.
Required storage locations 1–20 Minimum number of storage agents that must contain the newest regular backup.
Home Assistant Repair issues On/Off Creates and removes Repairs for detected problems.
Analytics window 7–365 days Window used for size trends, gaps, and locally observed automatic success rate.

Technical app-update snapshots are recognized separately. They do not affect age, redundancy, size comparison, or automatic integrity verification.

Verification strategy

Strategy Automatically verify new backups Verify SQLite database Use case
Manual No No Lowest load; checks run on demand.
Automatic Yes No Fully reads every newly detected regular backup once.
Deep verification Yes Yes Adds SQLite verification and requires more time and temporary storage.
Custom Stored individual values Stored individual values Appears when panel settings use a non-preset combination.

The manual verification cooldown is also shown in this section. Automatic checks use a bounded retry and backoff mechanism for controlled temporary failures.

Presentation, privacy, and notifications

Option Default Explanation
Entity mode Standard Standard enables primary entities. Expert adds detailed timestamps, checksums, database, and storage-agent entities. User-disabled entities remain disabled.
Expose private backup metadata Off Explicitly exposes native names, IDs, and detailed failure lists in attributes. Most users do not need it.
Sidebar panel Off Registers the Overview, Recovery, Settings, and Live log interface.
Detailed live logging Off Records bounded, privacy-safe activity events for the panel.
Persist live log Off Keeps the bounded journal across restarts. Otherwise it exists only in memory.
Live-log retention 7 days Configurable from 1–30 days. Older entries are removed.
Mobile notifications Off Reports new or changed active problem groups.
Companion App devices Empty One or more enabled Companion App notify targets.
Recovery notifications On Sends an all-clear message after previously reported problems are resolved.

Notifications are not repeated at every poll. BackupCheckup sends again only when the problem set changes.

Runtime Runner options

These values are configured in the Home Assistant app, not in the integration options:

Option Default Range Explanation
maximum_archive_gb 50 GB 1–2048 GB Maximum size of the internally uploaded, already verified archive.
maximum_expanded_gb 250 GB 1–8192 GB Hard limit for the temporary extracted configuration.
runtime_timeout_minutes 20 min 2–60 min Maximum wait for the isolated Home Assistant instance to become ready.

Only one runtime test can run at a time. See Runtime-Runner for details.

Clone this wiki locally