Snapshot Backup Plugin for WordPress

- by

I’ve just finished writing a new WordPress Plugin which creates a Snapshot Backup of your entire website: that’s your Database, current WP Core, all your Themes, Plugins and Uploads. The resulting single archive file is then uploaded to an FTP repository of your choice.

Peace of mind included πŸ˜‰

Download from the official WordPress Repository

UPDATE AUGUST 2012

Due to heavy workload and high demand I can currently no longer find the time to support Snapshot Backup. I may pick up this project again in the future and put new PHP skills to work. Thank you for being kind enough to understand.

In the meantime I’ve discovered a wonderful by Daniel HΓΌsken which does all I ever wanted Snapshot Backup to do and more: It’s called BackWPup – download it here. It’s way ahead of my plugin and under active development.

———————————-

Disclaimer

I’ve recently been flamed a lot by users who are less than happy with this plugin. That’s tough, so I wanted to state some very obvious facts that most of us do take for granted:

This plugin does not work for everyone. It works fine for me, and I’ve written it for me and my own servers. I’m distributing it in the hope that it will be useful to others, but with absolutely no guarantee that it will work on every Linux system out there.

You are free to use Snapshot Backup, but I strongly advise you to test it on a dummy system before deploying it to your precious live site. Users have reported every possible horror scenario, from complete site deletion to an empty database file. Please test the plugin on your system and check that it creates a reliable backup that can be restored before relying on it to work. Remember: you are using Snapshot Backup at your own risk.

Thank you!

Installation

Upload the ZIP file under Plugins – Add New – Upload. Alternatively, unzip all files and upload via FTP client manually.

Activate the plugin and find the option Snapshot Backup in your Dashboard options.

Usage

Snapshot Backup has been designed with ease of use and simplicity in mind.

Once the plugin is activated, you’ll find a new top Level Menu called Snapshot Backup on the left. Under Settings you configure your FTP Details and and additional directory you’d like to back up. Now you can either head over to to Snapshot Backup and create a Snapshot manually, or you can setup automation and let the plugin create a Snapshot for you at regular intervals.

Make sure your wp-content/uploads directory is writable – Snapshot Backup needs somewhere to write files to locally before they get sent away to your FTP server (this would ideally be a second server, preferably with a different host in a different data centre).

In the current release your screen will go blank while the script runs through the various stages. Depending on the size of your site this could take a while… be not alarmed and keep an eye out for the browser status bar. While it appears your browser is working Snapshot Backup is working too. I’m attempting to fix this in future releases and give you a status report of each stage.

Automation

Included since Version 2.0 we have the long awaited automation feature. This creates Snapshots while you sleep and even auto deletes older ones. You can set all this up under Automation and receive a friendly email ever time a Snapshot has been created (optional).

For the automation to work I’m using the WP Cron feature, which in turn relies on your website being visited every once in a while. On live production sites with 100+ visitors per day you’ll be fine, but on low traffic sites you may notice that Snapshots are created at irregular intervals – I’m thinking of test sites with blocked search engines or brand new sites.

To help this along and make the process more accurate you can create a Cron Job which calls the index.php file in your WordPress installation directory (usually http://www.yourdomain.com/index.php)

Screenshots

Snapshot Backup Admin Menu
Success Screen at the end of the Backup
FTP Details Dialogue. Don't panic, your password won't show up -it's an old screenshot you know.

Snapshot Philosophy

Archiving dynamic websites isn’t all that easy and we all tend to forget that because the web is such a fluid thing. The idea of Snapshot Backup is that you may want to create an “as is” version of your entire website for archive purposes. With each click you’ll create a “time capsule” of sorts – this could be for legal, sentimental or security reasons.

Other solutions mirror or sync your installation – which is a great idea too, however if you only notice a week down the line that your site has been compromised then your synced copy most certainly is too. Snapshot makes it easy to go back to a clean version from x days/weeks/months ago.

How does it work?

Snapshot Backup first reads out your entire database into anΒ file. Afterwards it uses the Linux shell command tar to archive all your content. Then it deletes the SQL file and then it uploads the resulting archive file over to your FTP repository.

Please note that this plugin does not work on Windows servers… sorry ;-(

Restoring a Snapshot

I’m working on a simple script that will do this for you. In the meantime you’ll be on your own – with some written guidance from yours truly. Have a look at this article which explains how to restore via FTP.

Known Issues

Even though this plugin is a great idea, it may not work for everyone. I’ve had reports from users reporting that either the plugin creates a 0MB backup file or does not include the database in the tar ball. The following hosts are known to be problematic:

  • Media Temple
  • Netpower
  • MyWebHost
  • Momwebs
On the other hand, on most hosts this plugin works just fine. If you are in the unlucky situation that you have a problem, please leave a comment and state your web host so I can add to this list.

Alternatives to Snapshot Backup

There are alternatives to creating a full backup of your site such as these (which will cost money):
Or you can try the excellentΒ WP DB Backup PluginΒ which will read out your database. Following that you can simply login to your site via FTP and copy all your files to your local machine. Not pretty, not automatic, not fast, not convenient… but it’s free and it works πŸ˜‰

Roadmap: The Future of Snapshot Backup

There are plenty of things I want to add to and improve on this plugin:

  • make sure the screen doesn’t go blank while the Snapshot is being created
  • add translation
  • add the ability to run Snapshot automatically via WP Cron or Cron Jobs done since 2.0
  • make the admin interface look prettier (and easier to find) done since 2.0
  • manage FTP repository from admin interface (i.e. list and delete older backups, local and FTP)
  • give this plugin its own website for documentation (snapshotbackup.org)
  • finalize Snapshot Restore script
  • add FTP Port selection done since 2.1
  • add cloud storage support (Amazon, Dropbox, etc)

If you have any suggestions for future features please leave a comment.

Enjoy Snapshot Backup responsibly πŸ˜‰



If you enjoy my content, please consider supporting me on Ko-fi. In return you can browse this whole site without any pesky ads! More details here.

215 thoughts on “Snapshot Backup Plugin for WordPress”

  1. Thanks Paul, that’s good to know – I’m developing on CentOS πŸ™‚

    Could you have a look in /wp-content/uploads and see if the backup is actually written on your server? If there’s no file at all it may be due to folder permissions (Snapshot currently doesn’t check this). If you find a .tar file in that folder then it may just be the function that reads out the file size.

  2. Jay, all I can say is you made my day, and then some. πŸ™‚ This is EXACTLY the kind of plugin I was looking for. I have used different wp-db backups, which worked well, BUT always ran into issues that it wasn’t always a backup of the ENTIRE database, everything including the kitchen sink.

    So, seeing you mention that very specific point in your post, and seem to be considering options, please always keep the option for the user to backup everything, crumbs on the floor included. Having the option to grab less is cool, but being sure that you have everything is priceless.

    As you have my contact email, if you’re planning on localizing versions, just email me the files for poedit and I’ll get you a French set done.

    Thanks, and once again, great job. I’m definitely hooked.

  3. Hi. Your plugin worked fine on one site, but on the other I get:

    Fatal error: Allowed memory size of 268435456 bytes exhausted (tried to allocate 233309127 bytes) in /home/xxx/public_html/xxx/xxx/wp-content/plugins/snapshot-backup/database.php on line 59

    Any idea what is causing this? I can’t work it out.

  4. Hi Hodgson,

    sounds like PHP is running out of memory on that particular site. There are two things you can try:

    1.) Increase the PHP Memory Limit – you do that by opening your main .htaccess file and find a line like this:

    php_value memory_limit 32M

    Change this to 64M or 128M and try again. If the line doesn’t exist you can just add it. However, some hosts won’t allow you to do this or even have a hard limit in place.

    2.) Alternatively you can free up existing memory – typically by deactivating memory heavy plugins (like Next Gen Gallery, WP Ecommerce, etc).

    Let me know if this solves the issue.

  5. Thanks for the quick replay Jay! Unfortunately, I don’t seem to be able to find an .htaccess file with that line in it, and there are no memory-hogging plugins on the site.

    I do notice that your logo graphics return a 404 error. I’ve checked the permissions and all seems fine, but your logo shows up fine on the working site admin page, not this other site (which is very similar by the way, but hosted somewhere else).

    There is an online shop hosted on the same server however, which is perhaps hogging all the memory, though it seems very stingy on their part!

    Does your plugin require a lot of memory?

Comments are closed.