A backup plan defines when a backup runs, what it contains, where it goes and how many backups are kept. This article explains the tile Backup plans and the form of a plan, field by field.
Most fields are optional
A plan only needs a target and has to be switched on. Everything else has a default: daily, everything, Max. backups 7, snapshot on. You can adjust every field, but your website gets its backup even if you do not.
The tile is on the Backup page. In the Compact view the button Schedule backup shows it; in the Extended view it is always visible. The Overview page shows the same plans read-only; Manage plans leads from there to here.
The first plan is created with the first target
When you create your first target, the plugin creates the plan “Daily backup”. It backs up everything to this target every day at a random time; Max. backups is set to 7. The plan is paused until you switch it on. It is a plan like any other: you can rename, change and delete it.
The tile at a glance
- Add plan opens the form for a new plan.
- The switch shows whether the plan is active or paused. A click toggles it.
- The first line shows the name of the plan, the rhythm with the start time and the targets, for example “Daily backup · Daily at 03:00 · Local folder 1”.
- More … opens the menu of the plan.
- Next run shows the day and time at which the plan starts next.
- The last line shows the time zone of the website. All times in the tile are given in this time zone.
| The tile shows | Meaning |
|---|---|
| No plan yet | There is a target, but no plan. Add plan opens the form. |
| There is no target yet. Add one on the Targets page first. | A plan needs a target. In this situation Add plan takes you to the Targets page. |
| a red message and Reload | The tile did not get the plans from the server. The message gives the cause; Reload tries again. |
Active and paused
An active plan starts at its next run on its own. A paused plan does not start on its own: the pause affects the schedule. A paused plan can still be run by hand.
| The row shows | Meaning | What you can do |
|---|---|---|
| Switch on active, below it Next run with a date | The plan runs according to the schedule. | nothing |
| Switch on paused, below it Paused, no backups are scheduled. | The schedule is on hold. Every new plan starts out in this state. | Switch the plan on. |
| no target in the first line, below it Paused: the plan has no target. Choose a target to switch it on. | The target of the plan was removed. The plugin has paused the plan. | Choose a target in the form, save, and switch the plan on afterwards. |
| yellow line with a warning triangle, for example “SFTP 1: Disconnected” | The target of the plan is not usable. The reason follows the name: not tested yet, test failed, Disconnected or, in general, not usable. | Fix the target on the Targets page, or choose another one in the form. |
| Does not run on schedule: without cloneworx Backup Pro only one plan runs on schedule, currently “…”. or Does not run on schedule: the rhythm of this plan needs cloneworx Backup Pro. | The plan is switched on but does not run on schedule, because cloneworx Backup Pro is missing or its licence is not valid. | What you can do is described in Integrate cloneworx Backup Pro: installation and requirements. |
An active plan with a target that is not usable still runs at its scheduled time. The backup then ends with an error or a warning, which you see in the list of backups. So in this case the plan does not silently skip its run.
Switch on a plan
A plan can only be switched on with a usable target, that is a target whose last connection test succeeded. Otherwise the switch stays on paused:
- The switch stays on paused.
- The yellow line names the target that is not usable and the reason.
- Switching on needs at least one usable target.
When you switch a plan on, the plugin recalculates the next run, starting from now. A plan that was paused for weeks therefore does not start the moment you switch it on.
After you switch the plan on, the dialog window Attention appears: A website that has no visitor around its times makes no backups. Therefore set up a system cron: The link Start backups on time: set up a system cron below it opens the guide in a new tab. OK closes the dialog window.
The next run
- All times are given in the time zone of the website, even if your browser is in another time zone.
- The plugin recalculates the next run from the rhythm every time. The time of day therefore does not shift when the clocks change between summer time and winter time. A time that does not exist in the night of the change moves forward; in the hour that occurs twice, the plan runs only once.
- A scheduled time counts as kept if a task source triggers the website within one hour after that time, for example a visitor or a system cron. Later it counts as missed: nothing starts, and the plan moves on to its next regular time.
- Only one job runs at a time. If a plan is due while another job is running, it starts right after it.
More on this: Schedule backups automatically and Start backups on time: set up a system cron.
The tile in the Extended view
- After the next run, the second line additionally shows the last run, what is backed up, Max. backups and the snapshot.
| Detail | Meaning |
|---|---|
| Last run | Date and time of the last backup of this plan, whether it was started by the schedule or by hand. Before the first run it reads no run yet. |
| Missed run: … | Shown after the last run if the plan missed a scheduled time after it. The message gives the missed time. |
| The last run could not start: … | Shown instead of the last run if the plan was due and the backup could not be started. The reason follows the colon: the working folder in the uploads directory could not be created or written (no space, or no permission), the database refused the entry of the job (a table of the plugin is missing or not writable) or the job could not be prepared (…). It is followed by Run the plan by hand; the log has the details. The plan moves on to its next scheduled time. The same information is shown in red in the list of plans on the Overview page. |
| What is backed up | everything or the chosen areas. |
| Max. backups | The number entered in the plan. For a plan with tiers it says Retention by age. |
| Snapshot | Shown if the plan backs up the database as a snapshot. |
The “More …” menu
- More … opens the menu.
- Edit opens the form with the values of the plan.
- Run now starts a backup right away with the content and the target of this plan.
- Delete deletes the plan after a confirmation prompt.
Run now also works for a paused plan. The backup belongs to the plan and counts as its last run. It does not shift the next scheduled run. If a job is already running, nothing starts, and the page reports in red A job is already running. If the plan has no usable target, the page reports The backup could not be started: … with the reason.
The form
Add plan and Edit open the form in the tile. As long as it is open, the tile does not show the list of plans. Below Name, Rhythm and Time there are groups. A group is collapsed until you click Edit to its right; Show less collapses it again.
- Name is your name for the plan. The field is required.
- Rhythm defines how often the plan runs.
- Time consists of two dropdown menus: hour and minute.
- Targets and rotation are the targets of the plan.
- 3-2-1 status: shows with three lamps how far the targets of the plan follow the 3-2-1 rule.
- Edit expands the group.
- Save saves the plan and closes the form.
- Cancel closes the form without saving.
Name
The plugin suggests a name, for example “Backup plan 2”. You can use any name of up to 100 characters that no other plan has; upper and lower case are not distinguished. If you rename a plan, the list of backups also shows the new name for its backups.
Rhythm
You choose the rhythm from a fixed list. The default is Daily. Depending on the rhythm, the form shows different fields for the time:
| Rhythm | Fields for the time | How it reads in the tile |
|---|---|---|
| PROEvery 5 minutes, Every 10 minutes, Every 15 minutes, Every 30 minutes | none | Every … minutes |
| Every hour | Minute | Every hour at minute … |
| Every 2 hours, Every 4 hours, Every 6 hours, Every 12 hours | Minute | Every … hours at minute … |
| Daily | Time | Daily at … |
| Weekly | Weekday and Time | Weekly on … at … |
| Monthly | Day of the month and Time | Monthly on day … at … or Monthly on the last day at … |
- Rhythm is set to Weekly here.
- Weekday appears only with this rhythm. The seven days from Monday to Sunday are available; the default is Monday.
- Time applies to the chosen weekday.
- Rhythms in hours: instead of the time you choose only the Minute. The runs start at midnight and follow each other at the interval of the rhythm. Every 6 hours with minute 15 means: 00:15, 06:15, 12:15 and 18:15, plus the random offset of the plan.
- Monthly: Day of the month offers the days 1 to 28 and Last day of the month. The default is the 1st.
- Backups by hand: For backups by hand with a fixed scope and a fixed target, keep a plan paused and start it with Back up now or with Run now in the menu of the plan. A paused plan never runs by itself and is never overdue.
PRORhythms under one hour
This feature belongs to cloneworx Backup Pro: Installation · Order
With cloneworx Backup Pro, Rhythm also offers Every 5 minutes, Every 10 minutes, Every 15 minutes and Every 30 minutes. Without the extension these entries are grey in the list with a lock and the badge PRO and cannot be selected.
- Every 5 minutes is the shortest rhythm.
- Every 30 minutes is the longest rhythm under one hour.
These rhythms have no fields for the time and no random offset. The runs start at midnight and follow each other at the interval of the rhythm: Every 15 minutes means 00:00, 00:15, 00:30 and so on. When you choose one of these rhythms, the dialog Attention appears:
- Attention is the title of the dialog.
- Backups every 5, 10, 15 or 30 minutes require a system cron. The scheduler built into WordPress cannot always guarantee this rhythm.
- Start backups on time: set up a system cron opens the guide in a new tab.
- The second paragraph strongly recommends backing up only the database at this rhythm: file backups this often can put so much load on the server that the website becomes noticeably slower for visitors. This paragraph is not shown when the plan backs up only the database.
- OK closes the dialog.
With cloneworx Backup Pro, WP-Cron triggers the plugin every 5 minutes instead of every 15 minutes. Without visitors, nothing runs even then; that is why the system cron is needed: Start backups on time: set up a system cron. More about the feature: Backups every 5 to 30 minutes.
Time
You choose the hour from 00 to 23, the minute in steps of 15 minutes: 00, 15, 30 or 45. For a new plan the plugin suggests a random time.
Each plan adds a fixed offset of 0 to 14 minutes to the chosen time. The plugin sets it at random when the plan is created and keeps it, even when you change the time. 03:15 becomes 03:22, for example. The reason is the load on the server: without the offset, all websites on a server that chose the same time would start in the same minute. The term Time, which has a dotted underline, shows a tooltip about this.
- When you edit a plan, the heading shows the name of the plan.
- Starts at … is shown next to the time when you edit a plan and says when the saved plan actually starts: its time plus the offset. The text changes only after saving.
- Save saves the changes.
If you change rhythm, day or time, the plugin recalculates the next run.
Targets and rotation
The group lists the targets of the plan. Only usable targets can be selected. A target that is not usable is grey in the list, with the note not usable. A target the plan already has stays in the plan, even if it is no longer usable. For a new plan the first usable target is preselected. The free version allows one target per plan: there the group is a dropdown menu, and below it is the Pro marker 3-2-1 gold standard and rotation.
3-2-1 status: is always shown in the title line of the group, even when the group is collapsed and also in the free version. The three lamps stand for the 3-2-1 rule: three copies of your data on at least two kinds of storage, one of them in a different building. When the mouse pointer is on a lamp, a tooltip says what the lamp counts.
| Lamp | Green | Yellow | Red |
|---|---|---|---|
| Copies: … copies | three or more targets | two targets | one target |
| Kinds of storage: … kinds of storage | two or more kinds | – | one kind |
| Off-site: … off-site | at least one target off-site | none certainly off-site, but one target with off-site: location not specified | no target off-site |
- Kinds of storage: the file system of the server (Local folder), a server reached over a protocol (FTP, SFTP, WebDAV), an object storage (Amazon S3, S3-compatible) and a cloud service (Google Drive, Dropbox).
- Off-site: Amazon S3, Google Drive and Dropbox always count as off-site, a local folder never does. For FTP, SFTP, WebDAV and S3-compatible storage, the field Location of the target on the Targets page decides: The “Targets” page.
The tooltip on the underlined term Targets and rotation reads: 3-2-1 rule: three copies of your data on at least two kinds of storage media, one of them in a different building. Rotation: each storage target can be used at a different frequency to achieve a rotation.
PROSeveral targets and 3-2-1 gold standard
This feature belongs to cloneworx Backup Pro: Installation · Order
With cloneworx Backup Pro a plan can have as many targets as you like, and every further target gets a rule. Edit expands the group:
- The term Targets and rotation, which has a dotted underline, shows a tooltip about the 3-2-1 rule.
- 3-2-1 status: with the three lamps.
- One line per target with its name and kind: local, remote, remote, off-site or remote, location not specified.
- The first target receives every run: its rule Every run (…) with the rhythm of the plan cannot be changed.
- The rule of a further target.
- Remove target takes the target out of the plan.
- Add target … adds a further target to the plan.
- Show less collapses the group.
You can choose Every run (…) and every span that is longer than the rhythm of the plan: Every 10 minutes, Every 15 minutes, Every 30 minutes, Every hour, Every 2 hours, Every 4 hours, Every 6 hours, Every 12 hours, Daily, Weekly and Monthly. For a daily plan these are Weekly and Monthly. With a span, the target receives only the first run of each span; with Weekly that is the first run of each week. The spans in hours count from midnight.
An example: a daily plan backs up to a local folder and to an SFTP server in another data centre, both with every run, and to an object storage only the first run of each week. That makes three copies on three kinds of storage, two of them off-site. Max. backups and the retention tiers apply per target: with 7, the object storage keeps the backups of seven weeks. More about the feature: The 3-2-1 rule - the gold standard for backups.
Additional groups in the Extended view
- Targets and rotation appears in both views.
- What is backed up is the content of the plan.
- Retention sets how many backups are kept per target.
- Back up the database as a snapshot is a switch for the export of the database.
- Edit expands a group.
In the Compact view the form does not show the groups What is backed up and Retention or the switch. A new plan gets the defaults there: everything, Max. backups 7, snapshot on. For an existing plan the values stay as they are. When you save, open groups stay open; if the plugin rejects a value, the group with the error opens.
What is backed up
- Database is the tables of the database that belong to this website.
- wp-content is everything in the folder wp-content that does not belong to plugins, themes, must-use plugins or uploads: language files, drop-ins, folders of other plugins.
- WordPress core is the folders wp-admin and wp-includes and the files that WordPress brings along in the root folder.
- Must-use plugins is the folder of the must-use plugins.
- Plugins is the folder of the plugins.
- Themes is the folder of the themes.
- Uploads is the folder of the uploads.
- Root folder is everything in the folder of the WordPress core except WordPress itself and wp-content, for example .htaccess and robots.txt. If WordPress lives in its own subfolder with its own address, the files of the web root belong to it as well: its index.php, .htaccess, robots.txt and verification files.
The default is everything. At least one checkbox must be selected. The terms wp-content and Root folder have a dotted underline and show in a tooltip what belongs to them. Exclusion rules and the setting to back up only the structure of a table apply to the whole website and thus to every plan. More about this: Define what gets backed up.
The file wp-config.php is never part of a backup: it contains the authentication keys and salts of the website. A restore leaves the wp-config.php of this website as it is.
PROExceptions for this plan
This feature belongs to cloneworx Backup Pro: Installation · Order
In the expanded group What is backed up, below the checkboxes, you find the line Exceptions for this plan with the number of rules of this plan, for example none or 1 rule. Edit opens a text field; Show less collapses it again. When the form opens, the text field is always collapsed.
- Exceptions for this plan with the number of rules of this plan.
- Show less collapses the text field.
- The text field for the rules of this plan, one rule per line. Above it: One rule per line, in addition to the exclusions under Settings/Exclusions. Rules as in .gitignore, relative to the roots of this plan, for example wp-uploads/**/*.jpg for all JPG files anywhere in the uploads.
The rules apply in addition to the exclusions on the Settings page and only to this plan. They have the same forms as there and refer to the areas of this plan: wp-uploads/**/*.jpg excludes all JPG files anywhere in the uploads. This way a daily plan can leave out the images that a monthly plan backs up. A plan can have at most 50 rules of its own. They are saved when you click Save in the form.
A backup remembers the rules that applied to it. A restore of this backup does not touch the entries on the website that these rules match.
If the plugin rejects a rule, the reason appears below the text field: Line …: … names the line and the reason, for example only one * is allowed. The reasons are the same as for the exclusions: The “Settings” page. It rejects more than 50 rules with At most … rules per plan. More about the feature: Exceptions for a single plan.
Retention
The group sets how many backups are kept per target. Max. backups accepts values from 1 to 99; the default is 7. The term has a dotted underline, and its tooltip reads: How many valid backups stay per target. When a new backup is complete and checked, the oldest beyond this number is deleted. Backups are counted per plan and per target. Locked backups are not counted. More about this: Define how many backups are kept.
PRORetention by age
This feature belongs to cloneworx Backup Pro: Installation · Order
With cloneworx Backup Pro, the group Retention shows four tiers below Max. backups. Instead of a fixed number, backups are then kept in steps according to their age: all of the most recent ones, and of the older ones one per day, week or month. Without the extension, the Pro marker Retention by age is shown next to Max. backups.
- Max. backups stays at 0 as long as a tier is set.
- Every run sets for how many hours every run of the plan is kept.
- Daily keeps the first run of each calendar day; the number says for how many days.
- Weekly keeps the first run of each week; the number says for how many weeks.
- Monthly keeps the first run of each calendar month; the number says for how many months.
- Each tier keeps one backup per span, as far back as given; 0 switches the tier off. Older backups fall away.
- The preview shows for each target how many backups are kept with these values, for example “SFTP 1: all 24 runs from 2 hours, 7 daily, 3 weekly, 12 monthly: 46 backups”.
- Show as chart opens the dialog Retention with the chart for this target.
- Number or tiers: if you set a tier, Max. backups jumps to 0. If you enter a number, all tiers jump to 0. If all five values are 0, the plugin does not save the plan.
- Each tier counts on its own: a backup is kept as soon as one of the tiers keeps it. The newest backup is always kept.
- Per target: the tiers apply to each target separately. If the rule of a target means it only receives the first run of each week, there are no daily backups at that target.
- Preview: the preview calculates from the rhythm, the rule of the target and the tiers how many backups are kept from now on. The backups already at the target are not part of the calculation. The chart shows the same on a time axis with sections for hours, days, weeks, months and years.
- After the purchase: a plan with a number behaves exactly as before after cloneworx Backup Pro is installed, until you edit and save the retention.
An example with a diagram is in Retention by age.
If cloneworx Backup Pro is missing or its licence is no longer valid, a plan with tiers stays switched on, but every run ends with an error and backs up nothing: The plan uses retention by age, but cloneworx Backup Pro is not active or its licence is not valid. Nothing was backed up: without cloneworx Backup Pro the backups of this plan would never be deleted. To make the plan run again, open it in the form, enter a number above 0 under Max. backups and click Save. The form does not pause the plan, and Cancel leaves it as it is.
Back up the database as a snapshot
The switch has a group of its own. It is switched on by default. The term has a dotted underline, and its tooltip reads: All tables are read as of the same moment, even if the export takes several steps. InnoDB only. A plugin update that wants to change a table during the export waits until it is done. Because of this waiting time the snapshot can be switched off per plan.
PROEncrypt backups
This feature belongs to cloneworx Backup Pro: Installation · Order
The switch encrypts every backup of the plan at all its targets. It is below Back up the database as a snapshot. Before that you set up the recovery key on the Settings page in the Backup encryption tile. If encryption is not ready, the reason is shown in red below the switch, and a run of the plan ends with an error; the plugin then never writes an unencrypted backup. Without cloneworx Backup Pro or without a valid licence the Pro marker is shown in this place.
- Encrypt backups
Step by step: Encrypt backups.
Saving and errors on the form
A new plan is paused after saving. Switch it on in the tile if you want it to run on schedule. When you edit a plan, the form saves only what you changed. If the plugin rejects a value, the form stays open, and the error is shown at the field:
- This name is already in use.
- Enter a number from 1 to 99 under Max. backups.
| Message | Field | What you can do |
|---|---|---|
| This name is already in use. | Name | Choose a name that no other plan has. |
| This name is too long. | Name | Shorten the name to 100 characters or fewer. |
| The name contains characters the database cannot store (for example an emoji). | Name | Use a name without such characters. |
| This field is required. | Name, Targets and rotation, What is backed up | Enter a name, choose a target or choose at least one area. |
| This value is out of range. | Max. backups | Enter a number from 1 to 99. Without cloneworx Backup Pro an empty field counts as an error. |
| Enter a number from 1 to 99 under Max. backups. | Retention | All five values are 0. Enter a number or set a tier. |
| This target is not usable yet: test its connection on the Targets page. | Targets and rotation | Test the target on the Targets page, or choose another one. |
| This target does not exist any more. | Targets and rotation | Choose another target. |
PROSeveral active plans
This feature belongs to cloneworx Backup Pro: Installation · Order
In the free version you create as many plans as you like; one of them runs on schedule, and every plan has one target. With cloneworx Backup Pro every plan that is switched on runs on schedule.
- One plan on schedule: if a plan is switched on in the free version, the Pro marker with a lock and PRO covers the switch of every paused plan. The tooltip of the marker reads More than one active plan: cloneworx Backup Pro. Back up now and Run now still work for every plan, also for a paused one. The plugin never pauses a plan by itself.
If the plugin refuses to switch a plan on, the tile names the reason: Only one plan runs on schedule. Pause the plan “…” first. More about the feature: Several active plans.
Delete a plan
- Cancel closes the confirmation prompt. The plan is kept.
- Delete deletes the plan.
The confirmation prompt Delete plan names the plan: Delete the plan “…”? Backups it made stay.
- The backups of the plan stay at their targets and in the list, with the name of the plan.
- The plugin no longer deletes these backups on its own: what the plan created is kept until you delete it by hand.
- If you delete all plans, the plugin creates a first plan again with the next target you add.
See also
- The “Backup” page
- Schedule backups automatically
- Define what gets backed up
- Define how many backups are kept
- Manage backup plans with WP-CLI
On the command line
WP-CLI not set up yet? How to install WP-CLI.
Everything the tile can do also works with WP-CLI. You refer to a plan by its ID, for example plan-1, or by its name. You refer to the target of a plan by its ID. Here too, a new plan is paused until you switch it on with resume. You manage several targets, the rule per target, rhythms under one hour, the exceptions, the retention by age and the encryption of a plan with wp pro-plan: Manage backup plans with WP-CLI.
# Show all backup plans with state and next run wp cloneworx-backup plan list # Create a backup plan: daily, at 03:15, to the target local-1 wp cloneworx-backup plan add --target=local-1 --rhythm=daily --time=03:15 --name="Nachts" # Enable the backup plan wp cloneworx-backup plan resume "Nachts" # Change the time and Max. backups wp cloneworx-backup plan edit "Nachts" --time=04:30 --retention=14 # Three targets for the plan, local-1 receives every run wp pro-plan edit "Nachts" --targets=local-1,sftp-1,amazon-s3-1 # Back up only the database every 15 minutes wp pro-plan add --targets=sftp-1 --rhythm=15m --roots=db --name="Datenbank" # Pause the backup plan wp cloneworx-backup plan pause "Nachts" # Run a backup plan now wp cloneworx-backup plan run "Daily backup" # Delete the backup plan; its backups are kept wp cloneworx-backup plan remove "Nachts" # Show the exceptions of all plans wp pro-plan list # Create a daily plan without JPG files of the uploads wp pro-plan add --targets=local-1 --rhythm=daily --time=03:15 --name="Ohne Bilder" --exclusions="wp-uploads/**/*.jpg" # Replace the exceptions of a plan wp pro-plan edit "Nachts" --exclusions="wp-uploads/**/*.jpg,wp-uploads/**/*.png" # Remove the exceptions of a plan wp pro-plan edit "Nachts" --exclusions="" # Set the retention by age wp pro-plan edit "Datenbank" --age=run:2,daily:7,weekly:4,monthly:12