Vetrix Docs

Backups

This page appears only if your administrator account has the corresponding permission.

The Backups page manages scheduled database backups for the instance. Each backup configuration pairs a schedule with a destination and a retention policy. From here you create and edit configurations, enable or disable them, run a backup on demand, review the history of past runs, restore from a run, and delete configurations you no longer need.

Where to find it

  • URL: gitvetrix.com/admin/backups
  • Navigation: In the admin area, open the Operations group in the sidebar and select Backups.

Review backup configurations

The Backups list shows one row per configuration, with these columns:

  • Name — the configuration's name, which opens its detail and history page.
  • Cron — the cron expression that drives when the backup runs.
  • Type — the backup type.
  • Destination — the destination the archive is written to.
  • Retention — how long or how many runs are kept.
  • Enabled — a switch that turns the schedule on or off.
  • Last run — a status badge for the most recent run — Running, Success, Failed, or Cancelled — with how long ago it started, or Never when the configuration has not run yet.
  • Actions — Edit, Run now, and a delete button.

Long lists are split into pages. When no configurations exist, the page shows No backup configurations with a button to create the first one.

Create a backup configuration

  1. Select + New backup configuration.
  2. Under Identity, enter a Name.
  3. Under Schedule, enter a Cron expression. This is a five-field expression — minute, hour, day-of-month, month, day-of-week — for example 0 2 * * * to run nightly at 02:00.
  4. Under Backup, choose a Backup type: Full, Incremental (reserved — falls back to full), or Schema only.
  5. Under Destination, choose a Destination type — Local filesystem, S3, Google Cloud Storage, or Azure Blob — and fill in the fields that appear for that destination. Once a configuration is saved you can use Test connection to check the destination is reachable.
  6. Under Retention, set Retention (days) and Retention (run count). Zero disables that dimension of retention.
  7. Under Storage, choose a Compression option and, if you want the destination credentials encrypted at rest, select Encrypt destination config at rest.
  8. Under Notifications, choose Notify on success and Notify on failure.
  9. Select Create backup.

The new configuration appears in the list.

Edit a backup configuration

  1. In the configuration's row, select Edit (or open the configuration and select Edit configuration).
  2. Change any of the fields described above. In edit mode, an Enabled control also appears under Status.
  3. Select Save changes.

Secret destination fields are hidden behind a masked value. To change one, select Replace next to it and enter the new value; leaving it masked keeps the stored value unchanged.

Enable or disable a configuration

In the list, use the Enabled switch in a configuration's row to turn its schedule on or off. A disabled configuration is skipped by the schedule but keeps its history and settings.

Run a backup now

Select Run now in a configuration's row, or on its detail page, to start a backup immediately. The button shows a running state until the run finishes, and the Last run status updates to reflect the result. If a backup is already running for that configuration, a message tells you the button will become available again once it finishes.

View a configuration's run history

Select a configuration's Name to open its detail page. The header repeats the configuration's Cron, Type, Destination, and whether it is Enabled, and offers Run now and Edit configuration. Below, the history table lists each run with these columns:

  • Status — Running, Success, Failed, or Cancelled.
  • Started and Finished — when the run began and ended.
  • Duration — how long the run took.
  • Size — the size of the resulting archive.
  • Triggered by — who started the run, or Scheduler for a scheduled run.
  • Actions — Download and Restore for a successful run.

A failed run shows its error message in a row directly beneath it. When there are no runs yet, the page shows No backup runs yet.

Restore from a backup

Restoring overwrites the current database with the contents of a past run and cannot be undone.

  1. On a successful run's row, select Restore.
  2. In the Restore dialog, read the warning that restoring overwrites current data.
  3. In Expected database name, enter the name of the live database. The restore is rejected if this does not match.
  4. Type the configuration's name to confirm.
  5. Select Restore.

A message reports that the restore has started. If it cannot start, the dialog stays open and shows the reason so you can adjust the expected database name and try again.

Delete a backup configuration

Deleting a configuration removes its schedule permanently. Existing archive files are not deleted.

  1. In the configuration's row, select the delete button (the trash icon).
  2. In the Delete backup configuration dialog, type the configuration's name to confirm.
  3. Select Delete backup to remove it.

If the deletion cannot be completed, the row stays in place and a message shows the reason.