Snapshot Backup Plugin for WordPress

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 😉

About Jay Versluis

Jay is a medical miracle known as a Super Survivor. He runs two YouTube channels, five websites and several podcast feeds. To see what else he's up to, and to support him on his mission to make the world a better place, check out his Patreon Campaign.

215 thoughts on “Snapshot Backup Plugin for WordPress

    1. Hi Raj,

      the SQL file is stored in /wp-content/uploads – full path in the archive depends on your Linux distribution.

      On CentOS and Red Hat it’ll be /var/www/vhosts/yourdomain.com/httpdocs/wp-content/uploads

      1. Hi Jay,

        Thanks for your response.

        In the folder: /wp-content/uploads, I find the file:
        snapshot-20110827-1635.tar

        Other than the above .tar file, I do not find any file with .sql extension. Nor, any .zip file which is a sql zip file.

        What I am doing wrong?

        Raj

        1. Ah… I wasn’t explaining that very well. The SQL file gets deleted once the TAR file is written, this is so that one single file will contain your entire website. You can extract the SQL file from the TAR file. The full path I mentioned earlier refers to the path inside the TAR file.

          Does that make sense?

  1. Hi,
    Just installed and ran your plug-in with all default settings. The following Warnings appeared :
    Warning: exec() has been disabled for security reasons in
    /xxxx/wp-content/plugins/snapshot-backup/includes/zipshot.php on line 7
    Warning: exec() has been disabled for security reasons in
    /xxxx/wp-content/plugins/snapshot-backup/includes/zipshot.php on line 30
    Warning: exec() has been disabled for security reasons in
    /xxxx/wp-content/plugins/snapshot-backup/includes/zipshot.php on line 33
    The size of this Snapshot is 0 MB
    Warning: exec() has been disabled for security reasons in
    /xxxx/wp-content/plugins/snapshot-backup/includes/zipshot.php on line 35

    Warning: ftp_connect() [function.ftp-connect]: php_network_getaddresses: getaddrinfo failed: Name or service not known in /xxxx/wp-content/plugins/snapshot-backup/includes/sendaway.php on line 13
    Could not connect to ftp server. This will be local backup.

    Warning: ftp_quit() expects parameter 1 to be resource, boolean given in /xxxx/wp-content/plugins/snapshot-backup/includes/sendaway.php on line 44

  2. Hi Jay,
    i installed Snapshot Backup, it makes me the .tar with all files, but the .sql is empty.
    How does this come?

    Greetings Michael

    1. Hi Michael,

      sorry to hear that the SQL file is empty. My guess is that your host doesn’t allow for the execution of the mysqldump command. I’m using this to readout the database – if they’ve blocked it then it would explain why the file exist but with a size of 0 bytes.

      I’ll see if I can modify this in future versions. Thanks for trying, and thanks for your feedback!

    1. I know that plugin well, it uses PHP to read out the database. It’s rather complex to dissect – I’ll give it a go sometime in the future, watch this space!

      An earlier version of Snapshot Backup used a PHP script to readout the database, but it didn’t play well with some hosts so I’ve changed it to mysqldump (which is a Linux shell command).

  3. Its just an idea, i dont know if many people have the same problem like me. Maybe if some others have it you could let the user choose a second sql generation method which integrates the other plugin and used its procedures?

  4. Hi

    I can see you plan to add an ftp port option, i look forward to that 🙂

    I use a different port than 21, way too many hackers trying to brute force their way into the server all day long.

  5. I use this plugin regularly, and it successfully makes the backup on my server, but every time I try to download a copy of the snapshot, It gets interrupted at 4.0MB. If I use wget, this is what happens: “Read error at byte 4244253/47482880 (Connection reset by peer). Retrying.”

    It then resumes and gets the rest of the file.

  6. Hi, great plugin and it seems to work for me with everything but FTP, I have it set up correctly in that the plugin tells me that everything is good with my FTP and I can connect and use it through an FTP client, however when I run a snapshot I get the error “Error: Could not upload file. This will be local backup.”

    Anyone have any ideas please?

    Thanks

    Richard

    1. Thanks for your prompt reply by email, I have managed to resolve the problem myself, I was not entering the initial remote directory in the FTP settings correctly.

      Thanks again for your help.

      Richard

  7. Hey Jay,

    I have a GoDaddy.com hosted site. I successfully installed and ran your script. It created a .tar file of 13.1Mb. When I try to download it to my local machine it appears that the files endlessly grows in size. Essentially, it never completes downloading – when it get’s to 100% it keeps going and going. I finally stopped it at 130% and then tried it again and again with the same result.

    Hope you can help.

    Pat

  8. I was just made aware by Bluehost.com that my site was causing 100+ backend jobs to be processed and was bogging down the entire system. They shut down my hosting. When I called in, they said Snapshot was the culprit. I convinced them to reactivate it and I deactivated the plugin. Now we’re fine. Just letting you know.

    1. Thank you for your feedback, Dane.

      It would be interesting to know if you used the automatic backup feature and if so with which frequency. For example, if you asked for a backup every two minutes for several days then yes – it will bog down busy servers. On the other hand, one backup per day shouldn’t be a problem.

    2. Similar situation here with World4You and WP 3.1 – and yes I have verified that automation is disabled. It seems to be stuck in a loop continuously creating 1.3GB archive files (we only have 5GB total available, i.e. after 1 backup the 2nd one can’t be created and there appears the next one with 0 bytes until I delete the 1.3GB one). I keep my FTP program open to the /backup directory and I notice a new file appears every 30-60 minutes with the current date/time stamp. What is going on?! 🙁

      1. Hi glenroo,

        thanks for letting me know – I’ll have a look into this. I think WordPress 3.1 has introduced something that the plugin doesn’t like, and my plugin is due for a major overhaul anyway. I think I’ll get a chance to look into this next week – watch out for an upgrade.

Comments are closed.