[vbcron] Automatic database backup [v1.3]

This script will allow you to automaticly back-up your vBulletin database (or any database you have access to).


Current Stable Version: 1.3.1

System Requirements-

vBulletin RC 2 or later
Unix/Linux server with MySQL Dump support
Ability to chmod folders to 777 (775 works on some servers)

[high]IMPORTANT NOTE TO ALL THAT USE THIS SCRIPT[/high]

This script invokes an outside process that runs in the backround on your server to backup and compress your database. It is important to remember that this is not an instant process, do not enter you ftp as soon as the script says it is done and try to download your backup. It will likely be incomplete and your server will probbly still be writting the file to disk.

I ussally give the process an hour or two before I mess with the file, larger databases will take more time of course.

Installing the script-

1. You will need to change the information here for it to work correctly on your server:

PHP Code:

// ######################## Begin edits ######################
define('DB_HOST', 'localhost'); // database host

define('DB_USER', 'db_user'); // database username

define('DB_PASSWORD', 'password'); // database password

define('DB_NAME', 'db_name'); // vbulletins database name

define('DUMP_PATH', '/path/to/dump/folder'); // path to where db backup will be stored

define('DUMP_MAKE_TAR', 1); // set this to 1 for the backup to be compressed in a .tar.gz file
// ####################### End Edits ########################## 


2. CHMOD the folder you specified in DUMP_PATH to 777

3. Upload the vbcron_db_backup_131.php file to the /vbroot/includes/cron directory

4. Enter you admin control panel, under Scheduled Tasks click [high]Add New Scheduled Task[/high]

Enter the information has follows:

Title: Automatic Database Back-up

Day of the Week:

This is the day of the week the task should run on. Set this to * to have it not apply, or for it to run every day (if Day of the Month is set to * below). Otherwise select a specific day. Note that this will override the day of the month option, unless this is set to *.

Day of the Month:
Set this to the specific day of the month the task should run. This is overridden by the Day of the Week setting above. Set this to * to have it not apply.

Hour:
This is the hour of the day the task should run. Set it to * to have it run every hour.

Minute:
This is the minute of the hour the task should run. Set it to * to have it run every minute (not really recommended!).

Log Actions:
If this is set to Yes, every time the scheduled task runs, a log will be made indicating that the task was run, and in certain cases, additional information will be provided (e.g. for the Birthday Email task, the usernames who were sent birthday wishes will be noted).

Filename:
Enter the path to vbcron_db_backup_131.php, ./includes/cron/vbcron_db_backup_131.php should work in most cases

What was added in 1.3.1

- Fixed all bugs reported in 1.3

What was added in 1.3

- Added ability for script to leave logs

Improvments to come:

- Email alert when db is begin backed up
- Close board when back-up is in process
- 'Lock down' db durring backup so no one can access it
- Table, by table back-up
- Clear session table before backup
- Make script more windows friendly
- Delete last .sql (or .tar.gz) file when doing current back-up
- [high]Ability to use hashed file names for back-ups[/high]
- [high]Save back-up to forgin server[/high]

To come: version 2.0

2.0 will introduce most, if not all the fetures listed above.

Public beta testing will begin in the next few days, expect a stable version in at least 2 weeks time.

[Boofo]

How do we find out if we have MySQLdump on our server?

[Natch]

Originally Posted by Boofo

How do we find out if we have MySQLdump on our server?

You can connect via SSH/telnet and try a mysqldump command from the CLI ...

[Natch]

Brad: you have a couple of Parse errors ... missing ";"'s in the DEFINE area ...

define('DB_HOST', 'localhost')
define('DB_USER', 'user')

Both need those pesky ;'s

EDIT: //

Also on the last line it should look like this

exec('mysqldump --add-drop-table -h ' .DB_HOST. ' -u' .DB_USER. ' -p' .DB_PASSWORD. ' ' .DB_NAME. ' 2>' .DUMP_PATH. '/error.txt >' .DUMP_PATH. '/' .DUMP_DATE. '.sql');

as you have a couple of extra bits you don't need ...

worked fine after that

Great idea!

[Natch]

One suggestion as an improvement ...

Include the facility to make this script also tar.gz the resultant SQL dump file, for compactness ...

[Pikok]

Originally Posted by Natch

One suggestion as an improvement ...

Include the facility to make this script also tar.gz the resultant SQL dump file, for compactness ...

I think you should be able to do that with this..

PHP Code:

// now execute the backup
exec('mysqldump --add-drop-table -h' .DB_HOST. ' -u' .DB_USER. ' -p' .DB_PASSWORD. ' ' .DB_NAME. ' 2>' .DUMP_PATH. '/' .DUMP_DATE. '-error.txt >' .DUMP_PATH. '/' .DUMP_DATE. '.sql');

// now archive and compress the backup
exec('tar -cSz --remove-files -C' .DUMP_PATH. ' -f' .DUMP_PATH. '/' .DUMP_DATE. '.tar.gz ' .DUMP_DATE. '.sql ' .DUMP_DATE. '-error.txt'); 


[Natch]

Wheee - thanks

[Brad]

Natch sorry about that, I coded this real late , ill fix the zip.

Pikok, ill add that to the file to, and probbly some more compresstion methods over time

[M1th]

Looks good, thanks Brad!

[M1th]

er... sorry for double posting. Just wondering, what is the difference between --opt and --add-drop-table?