The check reads a backup the way a restore would read it, and writes nothing back while doing so. Afterwards you know whether the backup is readable and complete.
What you need
- a backup that is stored at one target or more. A failed or aborted backup has no copy; the entry for checking is not available for it.
- a moment in which no other job is running.
Step 1: Start the check
Open the Backup page. In the Backups list, click More … in the row of the backup, then Check backup. The Recent backups tile on the Overview page and the list of backups on the Restore page have the same menu.
- Restore
- Check backup starts the check.
- Lock backup protects the backup from deletion.
- Download only appears for a backup that is stored at a local target.
- Log
- Delete backup
Step 2: Follow the progress
The check runs as a job, like a backup. The Backup tile shows the progress; on the Overview, the status tile does.
- The progress begins with Checking backup. The checked amount and the remaining time follow.
- Abort check stops the check at the next step.
- At the start, it reads this instead of the time: calculating the remaining time ….
- If the backup is stored at several targets, the plugin checks every copy. The line then shows the count: Backup … of ….
- The plugin reads a local folder in place. From an external target it fetches one part after the other into its work folder, checks it and deletes it there again.
Step 3: Read the result
At the end, a message appears below the tile.
| Message | Meaning |
|---|---|
|
green Backup checked: readable and complete. |
Everything is fine, at every checked target. |
|
green Backup checked: encrypted, readable and complete. |
The backup is encrypted. Everything is fine, at every checked target. |
|
red Check: the backup is damaged or incomplete. The log names the parts. |
At one target or more, the backup failed the check. What that means is explained below. |
|
yellow Check: a target could not be reached; the backup there was not checked. |
The backup therefore does not count as damaged. Test the connection on the Targets page and check again. |
|
yellow A backup could not be checked: it is compressed and this PHP lacks zlib. |
The backup does not count as damaged because of this. |
|
yellow Check: a backup is encrypted and this website has no key for it. Its files are complete; its content was not read. Enter the recovery key in the menu of the backup and check again. |
The files are checked, the content is not. How to enter the recovery key: Encrypt backups. |
|
yellow Check: a backup is encrypted. Its files are complete; its content was not read, because cloneworx Backup Pro is not active. |
Activate cloneworx Backup Pro and check again. |
|
yellow A backup could not be checked: it is encrypted and this PHP cannot decrypt it (sodium is missing). |
The backup does not count as damaged because of this. |
|
yellow Check aborted. |
You aborted the check. |
|
red Check failed. |
The check itself failed. The log shows the reason. |
- Check: the backup is damaged or incomplete. The log names the parts.
- Log opens the log of the check.
A target could not be reached
If the plugin cannot reach a target, the yellow message shows the target and the cause.
- Check: a target could not be reached; the backup there was not checked.
- The line shows the target that could not be reached, and the cause.
- Below it is the original message; for an SFTP target, the message of the SSH library.
- Log opens the log of the check.
Confirming an unknown backup as correct
This website knows the state of a backup only if it wrote the backup itself and remembered its info file while doing so. A backup that was found again at a target, imported from a file or written with an earlier version of the plugin is unknown to the website: it cannot tell whether the backup was changed or replaced before the website first saw it.
If the check of a single unknown backup finds nothing, the dialog window Unknown backup opens: This backup was written with an earlier version of cloneworx Backup. At that time this website did not remember what the backup must look like. So this website cannot check whether the backup was changed or replaced at the storage target. Only confirm the backup as correct if you trust the storage target.
- Confirm backup as correct: the website remembers the info file as it is at the target at that moment. The confirmation is permanent. The website reports every later change as damage.
- Cancel: the website remembers nothing. The backup stays unknown.
- The check of all backups of a target on the Targets page does not ask.
- The pre-check of a restore, the import of a backup from a file and adding backups that were found again to the list ask the same question.
The mark in front of the date
After a check with a result, the backup has a mark in front of the date in the list: a green tick or a red cross.
- A green dot is in front of a complete backup.
- The green tick in front of the date means: checked, readable and complete.
- A yellow dot is in front of a backup with warnings.
- The padlock in front of the date marks a locked backup.
- PROThe key in front of the date marks an encrypted backup. More about this: Encrypt backups.
- A red dot is in front of a failed backup.
- The red cross in front of the date means: the check found the backup damaged or incomplete.
- A grey dot is in front of an aborted backup.
- If you point the mouse pointer at the mark, a tooltip shows the date of the last check: Checked on …: readable and complete. or Check on …: damaged or incomplete.
- If the backup is stored at several targets, the mark shows the worst result.
- If a target could not be reached, there is no new result for that target.
- The coloured dot does not change with the check. It describes how the backup went.
What is checked
The plugin checks the backup at every target where it is stored:
- Every file of the backup is at the target and has the expected size.
- The info file of the backup is valid.
- Every part has the size and the checksum that the info file states.
- Every block can be read and unpacked. The number of entries and the amount of data match the info file.
- The entries in the parts are the same as those named in the list of files of the backup.
- The info file at the target is the one this website remembered for this backup. If not, the backup has been changed or replaced at the target: the check reports the backup as damaged, and a restore does not start. The log then reads the info file at the target is not the one this website stored for this backup; the backup has been changed or replaced there
The database is part of it: every table is an entry of the backup.
What a damaged backup means
- The result applies to the target where the backup failed the check. There it no longer counts for Max. backups.
- The plugin never deletes a damaged backup automatically. It stays until you delete it by hand: Delete a backup.
- A restore reads only from a target where the backup is complete. If there is no such target any more, Restore, Lock backup and Download are missing from the menu.
- If the notification On errors and warnings is switched on, the plugin sends an email after a check with a finding.
- If a later check finds nothing any more, the backup counts as complete at this target again.
Open the log of the check: it lists the affected parts. Then create a new backup with Back up now.
If something does not work
| Message | What you can do |
|---|---|
| A job is already running. | Wait until the running job has finished, then start the check again. |
| The backup could not be started: … | The check did not start. The reason follows the colon. Show global log opens the global log. |
Good to know
- Backups are not checked on a schedule. The plugin already checks every part while writing it; the check by hand is meant for cases of doubt.
- You check all backups of a target in one go on the Targets page with Check the backups at this target.
See also
- Check backups at a target and clean up leftovers
- Read the log
- Restore the website from a backup
- The “Backup” page
- Create and manage backups with WP-CLI
On the command line
WP-CLI not set up yet? How to install WP-CLI.
The check also works with WP-CLI. You specify a backup by its job name; backup list shows it at the start of every line. The result shows one line per target.
# Show backups with job name, status and targets wp cloneworx-backup backup list # Check a backup at all its targets wp cloneworx-backup backup check <Job> # Check only the copy at one target wp cloneworx-backup backup check <Job> --targets=local-1 # Start the check and leave it to the website wp cloneworx-backup backup check <Job> --background