Skip to content
How to install

How backups work

A backup is a full copy of one site, its files and its database, kept on the server that hosts the site. The panel takes backups on a schedule, before risky changes, and whenever you ask. Each scheduled run also backs up the panel’s own database.

Backups → All backups listing every site's backups, a deleted site's included
Backups → All backups listing every site's backups, a deleted site's included

Each backup is a folder under <backup location>/<slug>/, named after the time it was taken, in UTC. It holds four files, and a databases folder when the site has databases added to it:

File Holds
db.sql.gz The site’s database, dumped in one consistent transaction
files.tar.gz The site’s wordpress/ folder, its config/ folder and site.json
manifest.json The site’s name, domains, PHP and WordPress versions, language and databases. For a PHP site, also its web root
sha256sums Checksums of the archive and every dump, checked before every restore
databases/<name>.sql.gz Each database added to the site, dumped the same way

A container app’s files.tar.gz holds its data folders, the mounts kept in backups and site.json instead, and its manifest.json names the image it ran. No secret of the app’s is in either.

A PHP site without a database has no db.sql.gz. An added database that is not on the server, because someone dropped it, is left out of the backup with a warning in its log. The panel archives the files while the site keeps running. These files are enough to rebuild the site without the panel, as Manual recovery shows.

Kind Shown as Taken Kept
Scheduled scheduled By the backup schedule, and by backup or update schedules of your own The newest 10 per site, within the keep period
Manual manual Back up now on the site’s Backups tab Until you delete it
Final, taken on deletion final When you delete a site, unless you switch it off Until you delete it
Before an update pre_update Before an update, as the site’s Back up before updates says Until the keep period ends, or you delete it
Before a restore pre_restore Before every restore Until the keep period ends, or you delete it
Server move move At both ends of a move to another server Until the keep period ends, or you delete it
Import import Once an imported site is up Until the keep period ends, or you delete it
Panel database panel After each scheduled run, of the panel’s own database The newest 10, within the panel’s keep period

Keep last N scheduled backups per site in Settings → Backups sets the retention. The nightly housekeeping removes the older ones. A scheduled backup with a complete offsite copy gives up its local files instead, and stays listed as remote only.

Since 0.3.0-beta.3 The keep period is off until you set it, for every site, for the panel or for one site. The nightly housekeeping then deletes the backups older than that, but never a site’s newest. Delete old backups shows how, and how to delete old ones now.

Schedule (cron) in Settings → Backups sets the scheduled run, every day at 03:00 by default, on the panel server’s clock. Each run backs up every running site and every connected site hosted elsewhere, then the panel’s own database. To leave one site out of that run, switch off Include this site in the periodic backups on its Backups tab. Every other kind is still taken for it.

Pausing Scheduled backups under Automations → Schedules stops the run for every site. Before any backup starts, the panel checks for free space of one and a half times the site’s size, and the backup fails without it.

Backups → All backups lists every backup on every server, newest first. Filter it by Site, Kind and, with several servers, Server. A site’s own Backups tab lists that site’s.

The backups of a deleted site stay. Deleted sites above the list names those sites, and their rows say deleted. Their final and manual backups stay until you delete them. The other kinds follow retention and the keep period in Settings → Backups, as every site’s do. To bring such a site back, create a site with the same name on the server its backup is on. Then restore the backup from the new site’s Backups tab.

A backup stays on the server where it was taken, even after its site moves. A download comes from that server, and a restore has to run there. So a backup left behind by a move cannot be restored onto the moved site, unless it has an offsite copy. Fetch back then brings it onto the site’s current server. One offsite destination serves every server: each server uploads its own backups.

A site hosted elsewhere is backed up through WPL7 Connect, onto the server chosen as Keep backups on. That server keeps a copy of the site’s files, and each backup copies only what changed since the one before. The backup holds the same four files. files.tar.gz holds the site’s wordpress folder, wp-config.php included. db.sql.gz is read in pages while the site keeps serving, not in one transaction. Such a backup is restored by hand, as Restore and download shows.

  • A backup reads the files while the site serves visitors. A file changed meanwhile may not match the database dump.
  • A stopped site is not backed up on schedule.
  • A backup restores onto a site of the same name only. There is no restore into a new site under another name.
  • The panel’s SSH key is not in the panel’s own backup. Keep a copy of /srv/panel/ssh somewhere else.
  • Only scheduled backups and panel snapshots are kept to a number. Manual and final backups are never deleted by age.