Issue #1357402 by ericxb. File dates displayed in destinations
[project/backup_migrate.git] / README.txt
1
2 -------------------------------------------------------------------------------
3 Backup and Migrate 2 for Drupal 6.x
4   by Ronan Dowling, Gorton Studios - ronan (at) gortonstudios (dot) com
5 -------------------------------------------------------------------------------
6
7 DESCRIPTION:
8 This module makes the task of backing up your Drupal database and migrating data
9 from one Drupal install to another easier. It provides a function to backup the
10 entire database to file or download, and to restore from a previous backup. You
11 can also schedule the backup operation. Compression of backup files is also
12 supported.
13
14 There are options to exclude the data from certain tables (such as cache or
15 search index tables) to increase efficiency by ignoring data that does not need
16 to be backed up or migrated.
17
18 The backup files are a list of SQL statements which can be executed with a tool
19 such as phpMyAdmin or the command-line mysql client.
20
21 -------------------------------------------------------------------------------
22
23 INSTALLATION:
24 * Put the module in your drupal modules directory and enable it in 
25   admin/build/modules. 
26 * Go to admin/user/permissions and grant permission to any roles that need to be 
27   able to backup or restore the databse.
28 * Configure and use the module at admin/content/backup_migrate
29
30 OPTIONAL:
31 * Enable token.module to allow token replacement in backup file names.
32 * To Backup to Amazon S3:
33     - Download the S3 library from http://undesigned.org.za/2007/10/22/amazon-s3-php-class
34       and place the file 'S3.php' in the includes directory in this module.
35       The stable version (0.4.0 – 20th Jul 2009) works best with Backup and Migrate.
36
37 LIGHTTPD USERS:
38 Add the following code to your lighttp.conf to secure your backup directories:
39   $HTTP["url"] =~ "^/sites/default/files/backup_migrate/" {
40        url.access-deny = ( "" )
41   }
42 You may need to adjust the path to reflect the actual path to the files.
43
44 IIS 7 USERS:
45 Add the following code to your web.config code to secire your backup directories:
46 <rule name="postinst-redirect" stopProcessing="true">
47    <match url="sites/default/files/backup_migrate" />
48    <action type="Rewrite" url=""/>
49 </rule>
50 You may need to adjust the path to reflect the actual path to the files.
51
52 NGINX USERS:
53 Add the following to your configuration:
54 location ^~ /backup_migrate/ {
55     internal;
56 }
57
58 -------------------------------------------------------------------------------
59
60 VERY IMPORTANT SECURITY NOTE:
61 Backup files may contain sensitive data and by default, are saved to your web
62 server in a directory normally accessible by the public. This could lead to a
63 very serious security vulnerability. Backup and Migrate attempts to protect
64 backup files using a .htaccess file, but this is not guaranteed to work on all
65 environments (and is guaranteed to fail on web servers that are not apache). You
66 should test to see if your backup files are publicly accessible, and if in doubt
67 do not save backups to the server, or use the destinations feature to save to a 
68 folder outside of your webroot.
69
70 OTHER WARNINGS:
71 A failed restore can destroy your database and therefore your entire Drupal
72 installation. ALWAYS TEST BACKUP FILES ON A TEST ENVIRONMENT FIRST. If in doubt
73 do not use this module.
74
75 This module has only be tested with MySQL and does not work with anyother dbms. 
76 If you have experiences with Postres or any other dbms and are willing to help 
77 test and modify the module to work with it, please contact the developer at 
78 ronan (at) gortonstudios (dot) com.
79
80 Make sure your php timeout is set high enough to complete a backup or restore
81 operation. Larger databases require more time. Also, while the module attempts
82 to keep memory needs to a minimum, a backup or restore will require
83 significantly more memory then most Drupal operations.
84
85 If your backup file contains the 'sessions' table all other users will be logged
86 out after you run a restore. To avoid this, exclude the sessions table when 
87 creating your backups. Be aware though that you will need to recreate the 
88 sessions table if you use this backup on an empty database.
89
90 Do not change the file extension of backup files or the restore function will be
91 unable to determine the compression type the file and will not function
92 correctly.
93
94 IF A RESTORE FAILS:
95 Don't panic, the restore file should work with phpMyAdmin's import function, or
96 with the mysql command line tool. If it does not, then it is likely corrupt; you
97 may panic now. MAKE SURE THAT THIS MODULE IS NOT YOUR ONLY FORM OF BACKUP.
98
99 -------------------------------------------------------------------------------
100