Made to Order Software Corporation Logo

MO Backup: Main Page

Summary

Introduction to the MO Backup module
Requirements
Installation
Errors generated by this module.
Copyright (c) 2009-2011 Made to Order Software Corp.

Introduction to the MO Backup module

The MO Backup module was created by Made to Order Software Corporation.

In order to manage a large number of websites, it is necessary to support a mechanism to keep a backup of those websites. The backup should include all the dynamic files.

The dynamic files are:

  • The files found in the directory where users upload files (i.e. sites/<name>/files/*)
  • The settings.inc file (although it does not change much if at all over time, it is important to back up this file since without it you cannot immediately access the website database)
  • The database

This module proposes to save all those dynamic files on a per website basis. We use it with our multi-site installation and it works like a charm.

It is possible to independently configure whether the files and the database are to be backed up.

Note:
This works with websites that are a few hundred pages or less. For websites that are larger (thousand of pages), it is adviced that you find a database replicator. The MO Backup can still be used for the dynamic files, though.
Todo:
Properly extract the Drupal database extensions (i.e. unsigned integers and a few other types and functions.)
Back to Summary

Requirements

This module requires the following functionality on your system:

  • The tar utility (to restore a backup)
  • The gzip compressor (to restore a backup)
  • The pg_dump utility (to backup the database)
  • The pg_restore utility (to restore the database)
  • A valid CRON functionality on your server

All of those tools are generally installed on Linux by default.

For MS-Windows, you can find tar and gzip on the http://www.mingw.org website.

pg_dump comes along with PostgreSQL. It is assumed that you are using PostgreSQL (obviously). This tool is directly used by the MO Backup system. On the other hand, the tar and gzip tools are not required on your server except when restoring a website.

Back to Summary

Installation

In order to install this module:

  • Extract the tarball under sites/all/modules
  • On your server, feel free to delete the doc sub-folder (it is safe since it is just and only static HTML)
  • Go to admin/build/modules and select MO Backup

Then go to admin/settings/mo_backup to change the backup setup.

By default, the files and database backups are turned on but you must specify a directory where backups will be saved. Until then, no backups will be performed.

Back to Summary

Errors generated by this module.

This module generates an error if the destination folder specified for the backup files on the server is read-only or does not exist.

The module will also check whether the tar utility, the gzip utility and the PostgreSQL tools are all available from the server. You can ignore the tar and gzip errors until a restore is required.

Back to Summary

Copyright (c) 2009-2011 Made to Order Software Corp.

http://www.m2osw.com/mo_backup contact@m2osw.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Back to Summary
Documentation generated by Doxygen on Sun Apr 8 2012 20:30:03