On the Backup page you start backups, set up backup plans and see all backups of your website. This article explains the page from top to bottom: every tile, every column and every entry in the menu.
The page at a glance
- Backup is the menu item of the page, in the WordPress menu under cloneworx.
- The tile Backup shows what was backed up last and where to, the last run and the next backup.
- Back up now starts a backup right away according to one of your backup plans.
- Schedule backup shows the tile Backup plans. The button is only available in the Compact view.
- Backups is the list of all backups, the newest first.
- More … opens the menu of a backup with all actions.
- Show more adds up to seven further backups to the list.
- Extended switches to the view with all details. The choice applies to all pages of the plugin.
Messages about an action appear below the tile Backup. A green message closes by itself; yellow and red ones stay until you close them. More on this: Progress, messages and log.
As long as the page is open, it reads the state again every 60 seconds. If a scheduled backup starts during that time, the page shows its progress.
The “Backup” tile
- The first line shows what the last finished backup contained and which target it went to, for example “Database, Files, WordPress core → SFTP 1”. As long as there is no backup, it says No backup yet.
- Last run shows the time, size and duration of this backup. If it did not go smoothly, the status follows: With warnings or Failed. A failed backup has no size.
- Next backup shows the earliest next run of all active plans. Without an active plan it says not scheduled yet.
- Back up now is the highlighted button as soon as a plan is active.
- Schedule backup is highlighted as long as no plan is active.
An aborted backup does not change the first two lines: they keep showing the last backup that ended complete, with warnings or with an error.
A time of today, yesterday or tomorrow is given in words in this tile, for example “today, 12:11” or “tomorrow, 03:00”. The lists always show the full date.
What “Back up now” does
The page checks the situation in the order of the table:
| Situation | What happens |
|---|---|
| No target is usable. | Nothing starts. The page reports in yellow No usable target yet. Set one up on the Targets page. and takes you to the Targets page. |
| There is no plan. | Nothing starts. The page reports in yellow No backup plan yet. Create a plan first. and shows the tile Backup plans. |
| There is one plan. | The backup of this plan starts right away. |
| There are several plans. | The dialog window Which plan? shows one button per plan with the name of the plan. A click starts the backup of this plan. |
| The target of the plan that is to run is not usable. | Nothing starts. The page reports in red The backup could not be started: … with the reason, for example The plan has no usable target. Show global log in the message opens the global log. |
The plan may be paused: the pause only affects the schedule. The backup belongs to the plan that started it. Step by step: Create a backup right now.
Progress and aborting
- The first line now shows what the running backup contains and which target it goes to.
- The progress display shows the phase, the number of entries, the amount and the remaining time.
- Abort backup stops the backup at the next step.
- Back up now is blocked as long as a job is running.
- The line appears for every backup, even if the schedule or the command line started it.
- You can close the page: the backup keeps running. When you come back, the page shows its state again.
- After Abort backup the tile reads Abort requested; the job stops at the next step. The backup then removes what it has already transferred to the targets.
- Only one job runs at a time. A check and the deletion of a backup are jobs too and show their progress here.
At the end the result appears as a message below the tile:
- green Backup complete.
- yellow Backup complete with warnings. It is followed by the number and kind of warnings.
- yellow Backup aborted.
- red Backup failed. It is followed by the reason. What to do then: When a backup fails or ends with warnings.
In every yellow and red message after a backup, Log opens the log of this backup.
After every valid backup the plugin deletes the backups at its targets that exceed Max. backups and cleans up leftovers of aborted jobs. The lines Deleting outdated backups and Cleaning up leftovers appear only if something is actually deleted. Afterwards the page reports, for example, One old backup deleted.
The “Backup plans” tile
- Schedule backup shows the tile Backup plans below the tile Backup.
- Dismiss hides the tile again. Your plans stay as they are.
The tile shows for each plan a switch, the name, the rhythm, the target and the next run. Here you create plans, switch them on, edit and delete them. In the Extended view the tile is always visible. Every field is explained in Backup plans: tile and form.
The list of backups
- Date shows the day and time of the backup. The small triangle shows that the list is sorted by this column.
- Size is the size of the backup. For a failed or aborted backup there is a dash.
- Targets lists the targets of the backup by name.
- Type shows Full for a valid backup, otherwise the status: Failed, Aborted or Running. If the backup left out another WordPress installation inside the website, the line below reads Not backed up: another WordPress installation in …. Install the plugin there as well; see the log.
- More … opens the menu of the backup.
- Show more adds up to seven further rows.
The date of a row is the end of the backup, or the start for a running backup. For an imported backup it is the time of the import; the row is sorted by the start of the original backup. More on this: Import a backup from a file.
The list shows seven backups. Show more and, to its right, Show all are only there as long as there are further backups. Show all shows all backups at once. If the list has more than seven rows, Show less goes back to the first seven. After an action from the menu of a backup the list keeps its length. When the progress and the message of an action are at the top of the page, the view scrolls to the top: after Check backup and after a confirmed deletion. Before the first backup the tile reads No backups yet.
If the list is too narrow for all columns, it hides the column Plan first, then the column Size. If that is still not enough, the list can be scrolled sideways in its tile.
Sorting
A click on the heading of a column sorts the list by this column. A second click on the same heading reverses the order; the triangle shows the direction.
- The default is Date, the newest backup first.
- The first click on another column sorts in ascending order. Only Date begins with the newest backup.
- All backups are sorted, not only the rows that are currently visible.
- Targets sorts by the names of the targets, Plan by the names of the plans. Backups for which the Plan column shows imported, manual or reclaimed come before all plans in this order when the sorting is ascending, and after all plans in reverse order when it is descending. (The Plan column is shown in the Extended view; the three words are explained in the section “The Extended view”.)
- Type sorts by the status, in this order: running, complete, with warnings, failed, aborted.
The symbols in the list
- A green dot means: the backup is complete.
- A green tick in front of the date means: the last check found the backup readable and complete.
- A yellow dot means: the backup is complete with warnings.
- A lock in front of the date means: the backup is locked.
- PROA key in front of the date means: the backup is encrypted. More about this: Encrypt backups.
- A red dot means: the backup failed.
- A red cross in front of the date means: the last check found the backup damaged or incomplete.
- A grey dot means: the backup was aborted.
- The dot describes how the backup went. Tick and cross describe the result of the last check. A row can therefore have a green dot and a red cross.
- If the backup is stored at several targets, the symbol shows the worst result of the last checks.
- A running backup has a spinning ring instead of the dot. With the default sorting, the newest backup first, it is the first row of the list. Its column Size shows a dash.
- Lock, tick and cross show a tooltip when the mouse pointer is on them or you reach them with the keyboard. The tooltip on the lock reads: Locked: this backup is never deleted automatically and is not counted for “Max. backups”. It can only be deleted by hand after “Unlock backup”. The tooltips on the tick and the cross say when the check was made: Checked on …: readable and complete. or Check on …: damaged or incomplete.
The “More …” menu
- Restore leads to the Restore page and opens the preparation for exactly this backup there.
- Check backup reads the backup at every target where it is stored, the way a restore would read it. Nothing is written back.
- Lock backup protects the backup from deletion. For a locked backup the entry is called Unlock backup.
- Download gives you the backup as one tar file. The entry is only available if the backup is stored completely at a local target.
- Log opens the dialog window Log with the log of this backup.
- Delete backup deletes the backup, after a confirmation prompt, at every target where it is stored.
Which entries the menu shows depends on the backup:
| Backup | Entries in the menu |
|---|---|
| The backup is running. | Log |
| Valid backup, complete at one target or more | Restore, Check backup, Lock backup or Unlock backup, Download for a local copy, Log, Delete backup |
| Valid backup, no longer complete at any target, damaged at one target or more | Check backup, Log, Delete backup |
| Failed or aborted | Log, Delete entry |
A valid backup is a backup that is complete or complete with warnings. The menu is the same in both views and on the Overview page.
- Checking runs as a job, with progress and Abort check in the tile Backup. The result appears as a message below the tile and as a symbol in front of the date. More on this: Check a backup.
- Enter recovery key is an additional entry in the menu of an encrypted backup for which this website has no key. More about this: Encrypt backups.
- Locking takes effect immediately, without a confirmation dialog. A locked backup is never deleted automatically and is not counted for Max. backups. More on this: Protect a backup from deletion.
- Downloading starts the download in the browser; the page stays open. A backup that is stored only at an external target can be fetched with your own access to that target, for example with an FTP program. More on this: Download a backup.
- The log is kept for as many days as set on the Settings page. After that, the dialog window says that there is no log for this backup any more. More on this: Read the log.
If a job is already running, the page does not start a second one. After Check backup or the deletion of a backup it then reports in red A job is already running.
Delete a backup
Delete backup first opens a confirmation prompt. It shows the date of the backup and its targets. When it opens, the plugin checks at every target whether the backup is still stored there. While it is checking, the confirmation prompt reads Checking the targets …, and Delete cannot be clicked yet. If the check fails, it reads in red The targets could not be checked: … Deleting stays locked until the check succeeds. Check again repeats it.
- The text says which backup is deleted and at which target.
- Cancel closes the confirmation prompt. The backup is kept.
- Delete deletes the backup at every target where it is stored.
If the backup is the last valid backup at one of its targets, the confirmation prompt warns in red:
- Attention! This is the last valid backup of this website at this target. After it there is none.
- Delete is still possible.
| Confirmation prompt | When | What happens |
|---|---|---|
| Delete backup? | The backup is stored at one target or more. | After Delete a job deletes the files at every target. Meanwhile the tile Backup reads Deleting backup. Once the job has deleted the backup at every target, the page reports Backup deleted. |
| Delete backup? with a red warning | At one target of the backup no other valid backup would remain. If this applies to several targets, the warning names them. | As above. Afterwards you no longer have a valid backup at this target. |
| Delete backup? with This backup is locked. Unlock it first; then it can be deleted. | The backup is locked. | The confirmation prompt offers only Cancel. Choose Unlock backup in the menu first. |
| Delete backup? with a red line for each affected target: At “…” the backup no longer exists., The target “…” does not answer. or The target “…” was removed. | A target no longer has the backup, does not answer or was removed. | Only then does the confirmation prompt show the checkbox Only remove the entry from the list; nothing is deleted at the targets. The checkbox is already ticked if there is a red line for every target of the backup. With the checkbox ticked, the entry disappears from the list immediately after Delete, without a job; the plugin deletes nothing at the targets, and the page reports Entry removed. What happens without the checkbox is described in Delete a backup. |
| Delete entry? | The backup failed or was aborted: nothing is stored at any target. | After Delete the row disappears from the list immediately. The page reports Entry removed. |
Deletion happens at every target
The plugin deletes the files of the backup at all targets where it is stored. Exceptions: at a target that was removed, and at a target whose folder belongs to another installation according to the catalog, it deletes nothing. With the checkbox Only remove the entry from the list; nothing is deleted at the targets. ticked, it does not delete at any target. When its last copy is deleted, the backup disappears from the list. Lock a backup that you want to keep in any case.
If the deletion fails at a target or you abort it, the message at the end is red:
- The backup could not be deleted at every target. See the log. means: the backup has been deleted at one or more targets, but not at one or more others. The backup stays in the list, but only with the targets at which it was not deleted.
- The backup could not be deleted. See the log. means: the backup has not been deleted at any target, or the deletion was aborted or ended with an error.
The log of the backup is kept as long as logs are kept. Step by step, including what you can do after a red message: Delete a backup.
PRODelete several backups at once
This feature belongs to cloneworx Backup Pro: Installation · Order
At the bottom left below the list there is Select several. A click puts a checkbox in front of every backup that can be deleted; locked and running backups have none. Select all selects the rows the list currently shows. Delete selected opens a confirmation prompt, first checks the targets of the selected backups and then deletes the backups in one go. Without cloneworx Backup Pro the Pro marker is shown in this place. Step by step: Delete several backups at once.
PROEncrypted backups
This feature belongs to cloneworx Backup Pro: Installation · Order
A plan can encrypt its backups; the switch Encrypt backups is in the form of the plan. An encrypted backup has a key in front of its date in the list. You set up the recovery key on the Settings page in the Backup encryption tile. Step by step: Encrypt backups.
The Extended view
- In this view Next backup is also followed by the name of the plan. Here the tile has only the button Back up now.
- Backup plans is always visible. Every row additionally shows the last run, what is backed up, Max. backups and the snapshot.
- Three filters narrow down the list: by plan, by target and by status.
- Hide details is the tooltip on the arrow: the arrow collapses the list.
- Plan is an additional column with the plan that started the backup. For a backup without a plan it reads manual. If the import from a file added the backup to the list as a new entry, it reads imported; if the plugin found the backup again at a target and added it as a new entry, it reads reclaimed.
- Targets and space is an additional tile. The tile is collapsed when you open the page.
- Compact switches back.
The list Backups and the tile Targets and space can be collapsed and expanded in this view with a click on the title row or on the arrow. The arrow always shows what the next click does. The list is expanded when you open the page.
The filters of the list
| Filter | Choices |
|---|---|
| Plan | All, each of your plans with its name, manual for backups without a plan, imported and reclaimed for backups for which the Plan column shows this word |
| Target | All, every target with its name, including a removed one |
| Status | All, Running, Complete, With warnings, Failed, Aborted |
The filters are combined: the list shows what matches all three. If no backup matches, it reads No backups match the filter.
The “Targets and space” tile
- Hide details is the tooltip on the arrow: the arrow collapses the tile again.
- The name of the target. The tile shows every configured target in one row; it does not show removed targets.
- The number of valid backups stored at this target. Locked backups are counted here.
- The space these backups take at the target.
- The free space at the target. The tile knows it only for local folders; otherwise it shows a dash.
- For each backup plan the number of backups in relation to Max. backups, for example “Daily backup 7 / 7”. manual stands for backups without a plan. If the plan no longer exists, there is a dash after the slash.
- The number per plan is counted the way the plugin counts when deleting old backups: only backups that are stored completely at this target, and no locked ones. This number can therefore be smaller than the number of backups at the target.
- For backups whose Plan column in the list shows imported or reclaimed, the tile uses the same word. These backups have a dash after the slash: the plugin never deletes these backups automatically.
- The tile recalculates after every job, after locking, after unlocking and after deleting an entry.
- If the tile is too narrow for all columns, it hides the numbers per plan first, then the free space, and finally the used space. If that is still not enough, the table can be scrolled sideways in the tile.
The same tile is also shown in the Extended view of the Targets page. How the plugin counts and when it deletes is explained in Define how many backups are kept.
See also
- Backup plans: tile and form
- Create a backup right now
- Progress, messages and log
- When a backup fails or ends with warnings
- Create and manage backups with WP-CLI
On the command line
WP-CLI not set up yet? How to install WP-CLI.
Everything this page can do also works with WP-CLI. There you refer to a backup by its job name; backup list shows it at the start of every line. The command line has no filters and no sorting for the list: backup list always shows the newest backups first, 20 by default, up to 100 with --limit.
# Show the state of the website and the latest backup wp cloneworx-backup status # Run a backup plan now wp cloneworx-backup plan run "Daily backup" # Show the 50 most recent backups wp cloneworx-backup backup list --limit=50 # Check a backup wp cloneworx-backup backup check <Job> # Lock a backup wp cloneworx-backup backup lock <Job> # Unlock the backup wp cloneworx-backup backup unlock <Job> # Write a backup to the server as a tar file wp cloneworx-backup backup download <Job> --to=backup.tar # Delete a backup everywhere after the confirmation prompt wp cloneworx-backup backup delete <Job> # Show what exceeds “Max. backups” wp cloneworx-backup retention list