Everyday Rails

Simple Rails site backups

By Aaron Sumner, April 03, 2011.

Today’s post won’t be specifically about Rails, but it will be about an important component of deploying productional Rails applications: Backing up your application’s data. Regardless of whether you’ve already got a system in place or if you’re hoping your hosting provider has your back, here’s an elegant way to gain some peace of mind and have data that are easy to recover should the unthinkable happen.

A little about my server setup: I’ve got several Linux-based virtual private servers running at work; each one with one to five Rails applications being served from it. I like to have data backups of each application (both database data and any file uploads an app may have) in addition to traditional server backups, just in case. In my situation, it would be faster to redeploy an application on a new virtual server than it would be to recover an existing virtual server, especially if I only need to recover data from one of the apps.

Traditionally, I’ve used a hodgepodge set of bash scripts to dump MySQL databases and copy data directories over to another server, but with the Backup gem by Michael van Rooijen my setup is a little less hodgepodge and a lot more elegant. Here’s a quick look at how to get things set up.

As mentioned in the README, Backup won’t work on Windows computers.

The Backup gem is incredibly easy to install, assuming you’ve got shell access to your server (I haven’t tried this on the likes of Heroku or Engine Yard). Follow the instructions in the README and the project wiki to get going; assuming you’ve got data to back up and somewhere to back it up to you’ll be up and running in no more than 15 minutes. My only problem: I selected scp as a file transfer option, since I have an existing backup server, and had to install a couple of extra dependencies to get things to work. The good news is the Backup gem does a nice job reporting missing dependencies and setting you on the right path (and I like that it doesn’t install a bunch of gems I wouldn’t have otherwise used). Afterward I noticed there’s a convenient way to see what your configuration’s dependencies will be:

  $ backup dependencies --list

Next steps

  • You’ll probably want to set up automated execution of your new backup system. Van Rooijen and I both recommend using the handy Whenever gem to create cron jobs for this purpose.
  • You can set up notification via e-mail, Twitter, or Campfire. See the project wiki’s page on notifications for details.
  • Replace your current Rails backup solution (the one that possibly involves duct tape and baling wire) with Backup. OK, maybe that’s just a next step for me.
What do you think? Follow along on on Mastodon, Facebook, or Bluesky to let me know what you think and catch my latest posts. Better yet, subscribe to my newsletter for updates from Everyday Rails, book picks, and other thoughts and ideas that didn't quite fit here.
Buy Me A Coffee

Test with confidence!

If you liked my series on practical advice for adding reliable tests to your Rails apps, check out the expanded ebook version. Lots of additional, exclusive content and a complete sample Rails application.

Newsletter

Ruby on Rails news and tips, and other ideas and surprises from Aaron at Everyday Rails. Delivered to your inbox on no particular set schedule.