You are here

Home » API reference » Backup and Migrate 5.2

README.txt in Backup and Migrate 5.2

Same filename and directory in other branches
  1. 8.2 README.txt
  2. 8.3 README.txt
  3. 5 README.txt
  4. 6.3 README.txt
  5. 6 README.txt
  6. 6.2 README.txt
  7. 7.3 README.txt
  8. 7.2 README.txt
-------------------------------------------------------------------------------
Backup and Migrate for Drupal 5.x
  by Ronan Dowling, Gorton Studios - ronan (at) gortonstudios (dot) com
-------------------------------------------------------------------------------

DESCRIPTION:
This module makes the task of backing up your Drupal database and migrating data
from one Drupal install to another easier. It provides a function to backup the
entire database to file or download, and to restore from a previous backup. You
can also schedule the backup operation. Compression of backup files is also
supported.

There are options to exclude the data from certain tables (such as cache or
search index tables) to increase efficiency by ignoring data that does not need
to be backed up or migrated.

The backup files are a list of SQL statements which can be executed with a tool
such as phpMyAdmin or the command-line mysql client.

-------------------------------------------------------------------------------

INSTALLATION:
Put the module in your drupal modules directory and enable it in 
admin/build/modules. 
Configure and use the module at admin/content/backup_migrate

OPTIONAL:
Enable token.module to allow token replacement in backup file names.

-------------------------------------------------------------------------------

VERY IMPORTANT SECURITY NOTE:
Backup files may contain sensitive data and by default, are saved to your web
server in a directory normally accessible by the public. This could lead to a
very serious security vulnerability. Backup and Migrate attempts to protect
backup files using a .htaccess file, but this is not guaranteed to work on all
environments (and is guaranteed to fail on web servers that are not apache). You
should test to see if your backup files are publicly accessible, and if in doubt
do not save backups to the server, or use the new destinations feature to save 
to a folder outside of your webroot.

OTHER WARNINGS:
A failed restore can destroy your database and therefore your entire Drupal
installation. ALWAYS TEST BACKUP FILES ON A TEST ENVIRONMENT FIRST. If in doubt
do not use this module.

This module has only be tested with MySQL and does not work with anyother dbms. 
If you have experiences with Postres or any other dbms and are willing to help 
test and modify the module to work with it, please contact the developer at 
ronan (at) gortonstudios (dot) com.

Make sure your php timeout is set high enough to complete a backup or restore
operation. Larger databases require more time. Also, while the module attempts
to keep memory needs to a minimum, a backup or restore will require
significantly more memory then most Drupal operations.

If your backup file contains the 'sessions' table you will likely be logged out
after you run a restore. To avoid this, exclude the sessions table when creating
your backups. Be aware though that you will need to recreate the sessions table
if you use this backup on an empty database.

Do not change the file extension of backup files or the restore function will be
unable to determine the compression type the file and will not function
correctly.

IF A RESTORE FAILS:
Don't panic, the restore file should work with phpMyAdmin's import function, or
with the mysql command line tool. If it does not, then it is likely corrupt; you
may panic now. MAKE SURE THAT THIS MODULE IS NOT YOUR ONLY FORM OF BACKUP.

NOTE TO DEVEL USERS:
If you experience memory limit errors while restoring, try disabling the
'Collect query info' setting in devel.

-------------------------------------------------------------------------------

File

README.txt
View source 
  1. 

  2. -------------------------------------------------------------------------------

  3. Backup and Migrate for Drupal 5.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. Configure and use the module at admin/content/backup_migrate

  27. 

  28. OPTIONAL:

  29. Enable token.module to allow token replacement in backup file names.

  30. 

  31. -------------------------------------------------------------------------------

  32. 

  33. VERY IMPORTANT SECURITY NOTE:

  34. Backup files may contain sensitive data and by default, are saved to your web

  35. server in a directory normally accessible by the public. This could lead to a

  36. very serious security vulnerability. Backup and Migrate attempts to protect

  37. backup files using a .htaccess file, but this is not guaranteed to work on all

  38. environments (and is guaranteed to fail on web servers that are not apache). You

  39. should test to see if your backup files are publicly accessible, and if in doubt

  40. do not save backups to the server, or use the new destinations feature to save 

  41. to a folder outside of your webroot.

  42. 

  43. OTHER WARNINGS:

  44. A failed restore can destroy your database and therefore your entire Drupal

  45. installation. ALWAYS TEST BACKUP FILES ON A TEST ENVIRONMENT FIRST. If in doubt

  46. do not use this module.

  47. 

  48. This module has only be tested with MySQL and does not work with anyother dbms. 

  49. If you have experiences with Postres or any other dbms and are willing to help 

  50. test and modify the module to work with it, please contact the developer at 

  51. ronan (at) gortonstudios (dot) com.

  52. 

  53. Make sure your php timeout is set high enough to complete a backup or restore

  54. operation. Larger databases require more time. Also, while the module attempts

  55. to keep memory needs to a minimum, a backup or restore will require

  56. significantly more memory then most Drupal operations.

  57. 

  58. If your backup file contains the 'sessions' table you will likely be logged out

  59. after you run a restore. To avoid this, exclude the sessions table when creating

  60. your backups. Be aware though that you will need to recreate the sessions table

  61. if you use this backup on an empty database.

  62. 

  63. Do not change the file extension of backup files or the restore function will be

  64. unable to determine the compression type the file and will not function

  65. correctly.

  66. 

  67. IF A RESTORE FAILS:

  68. Don't panic, the restore file should work with phpMyAdmin's import function, or

  69. with the mysql command line tool. If it does not, then it is likely corrupt; you

  70. may panic now. MAKE SURE THAT THIS MODULE IS NOT YOUR ONLY FORM OF BACKUP.

  71. 

  72. NOTE TO DEVEL USERS:

  73. If you experience memory limit errors while restoring, try disabling the

  74. 'Collect query info' setting in devel.

  75. 

  76. -------------------------------------------------------------------------------

  77.