Backup Integration

Overview

The Backup integration is what lets WoowTech package up your configuration and data so you can restore it later — whether you're moving to new hardware, recovering from a mistake, or simply keeping a safety net. Most people set their backups up once through the user interface and let WoowTech handle the rest on a schedule, but the integration also exposes actions you can fire from automations and scripts when you want finer control over timing.

You'll find the main controls under Settings > System > Backups, where you choose what gets included, where copies are stored, how many are kept, and whether they're encrypted.

Actions

The integration ships two actions for kicking off a backup from automations or scripts.

backup.create_automatic

This runs a backup using the policy you've already defined in Settings > System > Backups — the same included items, storage destinations, retention count, and password you configured there. It takes no parameters of its own, because every setting comes from your saved backup configuration. This is the action to reach for when you simply want your normal, fully-configured backup to run at a moment you choose.

backup.create

This produces a quick, no-frills backup and is only available on Core and Container installations. It writes to local storage only, always rolls the database into the archive, and creates the copy without a password. Like the automatic action, it accepts no extra options.

Triggering backups from automations

Nightly backup with your saved settings

If you've already configured automatic backups in the UI, this automation just chooses when they run — here, every night at 2:30 AM.

automation:
  - alias: "Run the configured backup overnight"
    triggers:
      - trigger: time
        at: "02:30:00"
    actions:
      - alias: "Start the automatic backup"
        action: backup.create_automatic

Quick local backup on Core or Container

On a Core or Container setup, use backup.create for a fast local snapshot. This example fires one every Sunday morning.

automation:
  - alias: "Weekly local snapshot"
    triggers:
      - trigger: time
        at: "04:00:00"
    conditions:
      - condition: time
        weekday:
          - sun
    actions:
      - alias: "Create a local backup"
        action: backup.create

Backing up before a risky change

A common pattern is to take a backup right before doing something that might need rolling back — for instance, just ahead of installing updates.

automation:
  - alias: "Backup ahead of update install"
    triggers:
      - trigger: state
        entity_id: update.woowtech_core
        attribute: in_progress
        to: true
    actions:
      - alias: "Capture current state first"
        action: backup.create_automatic

Configuration through the UI

Because both actions deliberately keep zero parameters, the substance of a backup is defined in the settings screen rather than in YAML. There you can control:

• What's included — which add-ons, folders, and whether the database is part of the archive.
• Where it's stored — one or more backup locations (agents), such as local storage or a connected cloud/network destination.
• Retention — how many recent backups to keep before older ones are pruned automatically.
• Encryption — whether archives are protected with a password.

When you call backup.create_automatic, all of those choices are applied for you. When you call backup.create, you get the fixed behavior described above instead (local-only, database included, no password).

For a deeper walkthrough of configuring and restoring backups, see the related common-tasks documentation for your installation type.