| docs

Appearance

Backups ​

Backups holds the snapshots taken of your hosting account. You browse a snapshot like a file tree, and restore what you need out of it: files, a database, a mailbox, or a single mail folder.

Overview ​

URL: /client/backups

Open it from Files > Backups in the sidebar.

The header states when the Last backup ran, when the Next scheduled backup is due, and the Retention your provider set. Whether you can restore yourself is also your provider's decision: when self-service restore is switched off for your account, the page says restores are handled by your provider, and support can run them for you.

When backups are not set up ​

Since panel 1.9.0, the Backups page is shown whenever your hosting plan includes backups, even when no backups are being made for your account. The page then says why, instead of listing snapshots:

  • Backups are not set up for your account yet - your provider has not assigned a backup policy to your account.
  • Backups are paused for your account - your provider has a backup policy for your account, but it is switched off.
  • Backups are switched off for your account - your provider has excluded your account from backups.

In each case no backups are being made, and Backup now and the restore actions are not available. Contact your provider to have backups switched on.

Choosing a restore point ​

Restore point lists the snapshots, newest first, each with its date and size. Pick one, and the file browser below fills with the contents of your home directory as it was at that moment.

  • Folders are listed first, then files, each group alphabetically.
  • Load more pages through a large folder.
  • Search finds a file by name inside the selected snapshot. Type at least three characters.

Restoring files ​

Tick what you need in the browser, then use one of the restore actions:

  • Restore selected - put the selected files and folders back where they came from. Existing files with the same names are overwritten.
  • Restore as copy or Restore copy to home directory - place a copy in the restored-files folder of your home directory instead, so nothing in place is touched.
  • Restore entire home directory - put the whole snapshot back.

A restore runs in the background. Recent restores below the browser lists what has run and how it ended. A restore can only start from a restore point the page listed.

Note: Restores are rate limited. When one is already running, or one finished a moment ago, the page names the wait before the next one can start.

Restoring a database ​

Database dumps in this snapshot lists the database dumps the snapshot holds.

  • Restore copy to home directory - download the dump into your home directory, to inspect or import yourself.
  • Restore into the database - import the dump back into the database it came from. The current contents of that database are saved to ~/backups first, so an import you did not want can be undone.

Restoring mail ​

Two actions restore mail out of the selected snapshot. Both are available once a restore point is picked.

Restore mailbox ​

Restore mailbox brings a mailbox back from the snapshot.

  • Mailbox - the mailboxes the snapshot holds. One that no longer exists on the server is marked (deleted).
  • New password - required when the mailbox was deleted. The mailbox is recreated with this password before its messages are restored.

A mailbox that still exists keeps its password and receives the messages the snapshot holds and it currently lacks. Restored mail is handed back to the mail server, so the mailbox opens with its messages in place.

Restore mail folder as a new folder ​

Restore mail folder as a new folder brings back a single folder without touching the mailbox as it stands.

  • Mailbox - the mailbox the folder belongs to.
  • Folder - the folder to restore.

The messages are restored into a new folder named Restored-<date>-<folder>, after the date of the snapshot. Nothing in the mailbox is overwritten, and you can pick individual messages out of the new folder in your mail client. Restore the same folder from two snapshots and each restore gets a folder of its own.

Starting a backup ​

Backup now takes a snapshot on demand. You are asked to confirm.

The header shows how many manual backups you have left today. When the daily allowance is used up, the page says so, and the scheduled backup still runs as normal. A backup already in progress has to finish before another can start.

When a backup does not start, the notification says why and what to do. When the server is busy with other backups, try again in a few minutes.