DEPRECATION WARNING

This documentation is not using the current rendering mechanism and is probably outdated. The extension maintainer should switch to the new system. Details on how to use the rendering mechanism can be found here.

EXT: Full Backup

Author:Kasper Skårhøj
Created:2002-11-01T00:32:00
Changed by:Carlos Chiari
Changed:2005-11-16T08:29:12
Author:Carlos Chiari
Email:ccho@dimension-e.net
Info 3:
Info 4:

EXT: Full Backup

Extension Key: Full_backup

Copyright 2000-2002, Carlos Chiari, <ccho@dimension-e.net>

This document is published under the Open Content License

available from http://www.opencontent.org/opl.shtml

The content of this document is related to TYPO3

- a GNU/GPL CMS/Framework available from www.typo3.com

Table of Contents

EXT: Full Backup 1

Introduction 1

What does it do? 1

Screenshots 1

Users manual 2

Backup 2

Clearing 3

Restoring 3

Errors 4

Adminstration 4

Installation under WINDOWS 4

Configuration 4

Introduction

What does it do?

Full Backup extension allows any user to easily make a full TYPO3 installation backup and restore. The backup will consist of:

  • typo3conf/localconf.php file or the whole directory (including local extensions!)
  • fileadmin directory
  • uploads directory
  • database mysql dump

It is based on Ramon Bucher's W4 Backup extension.

Screenshots

img-1

Users manual

The Full Backup extension allows to make a full backup of a typical Typo3 installation.

It has four functions: Backup, Restore, Clear and Settings.

Backup

img-1

First, select if you want to include the whole typo3conf directory. This directory holds your localconf.php, extTables.php (if any), temporary caches files, ext/ directory with ALL your LOCAL EXTENSIONS, etc.

If you don't select it, then only the localconf.php file will be included in your backup.

Optional: You can disable the permissions check.

To make a backup, just click the “Backup now!” button.

The backup will consist of:

typo3conf/ (only localconf.php if the whole directory option was not selected)

  • fileadmin directory
  • uploads directory
  • database mysql dump

These files/dump will be “-tar”ed and -“gzip”ed to a *-tar.gz. There will appear a link so you can download it manually:

img-2

Finally, after many backups, there will appear the full list of available backups (which are being saved to the typo3temp directory), with a link to download anyone of them.

Note that the file will take the site host name and date when it was created as the first part of its name.

If some error appears, and you have the permissions check enabled, an error message will appear.

Otherwise, the backup will be commited. At this moment, there still can be some errors, also true if you disabled the permissions check, and if this happens, a message will appear telling you so and ofering you the operation log.

Clearing

img-3

Each backup file can total huge ammounts of hard disk space.

When you select the “Clear” function of the module, it will list any *.tar.gz file located on the backup directory.

Clicking on each one of the links that appear on the list will delete that specific file. Clicking on the “Clear All *.gz files!” button will do just so.

Restoring

img-4

Restoring backup files into a Typo3 installation is as easy as following on-screen instructions!

  1. Click the file you want to restore;

2. A screen will appear asking you if the file has to be verified for possible problems: (This step can be ommited, with the appropiate setting configuration. Please check the Setting tool, available at the menu).

img-5

3. If no problem appears, another screen will offer you to commit the Restore:

img-6

4. When committed the RESTORE, a security backup will be made prior to the restore . It will have “securityBackup” appended to the name.

All these steps were included at the RESTORE tool to make it a little bit more difficult to make an “easy” restore, thus helping to avoid catastrophic errors.

The extension will untar the file using “/” (root) as target directory. This is because the backup tarred file has respected the original server architecture.

If you plan to use this function, please be aware that

  • There can be problems when you restore a file on a server that is not the original one , if they dont have the same architecture.
  • All tables on the backed up database, will be dropped , created and filled with backed up data. Even the backup users' table. As admin, you are responsable of any undesired outcome this may have.

img-7

If you need to restore a file in another server, you will need:

Shell access and appropiate permissions

  • Copy the file where you want to descompress it
  • Untar the file with “tar -zxf filename.tar.gz”, for example

Note that the tar will most probably have respected your original server architecture. You will find the appropiate folders with your data in there:

  • fileadmin
  • typo3temp/yourdump.sql
  • typo3conf
  • uploads

Copy the fileadmin, typo3conf and uploads content into the appropiate directory.

Use the sql dump to populate your site database.

Check permissions so your newly installed files (fileadmin, uploads) can be used by your site.

Errors

img-8 If there is any error, on any operation, a warning will be issued, and a link to an error report will be provided.

Adminstration

Installation under WINDOWS

To run this exension under WINDOWS OS, you will need to install the 7-ZIP compression software, available at www.7-zip.org , and configure the extension accordingly.

Configuration

When the extension is installed, it will ask you to set the extension configuration.

You can modify your original settings, later, going to the “Settings” option at the menu.

Settings Options:
  • MySqlDump command: Command (and path if needed) for mySQLdump executable. For example, if you have a WINDOWS installation, you would use something like C:mysqlbinysqldump.exe.

    For Linux/UNIX users, it is adviseable to leave the default option alone, without path, as the system should know already where the mysqldump command is.

  • MySql command: Command (and path if needed) for MySql executable. For example, if you have a WINDOWS installation, you would use something like C:mysqlbinmysql.exe.

For Linux/UNIX users, it is adviseable to leave the default option alone, without path, as the system should know already where the mysql command is.

  • Tar command: Command for TAR (UNIX, Linux). Default for Linux/Unix: tar

  • Path to 7-Zip: The extension uses the compression program “7-zip” for WINDOWS installation. Here you have to put the path to the executable file. Example: c:Program files7-zip7z.exe. This compression program can be downloaded at www.7-zip.org site.

  • Backup Dir: Relative path, from site root, to backup directory, where produced “*.tar.gz” files will be saved. Here you can set a different folder for backup files. Default is typo3temp.

  • Excluded Extensions: Comma separated list -without spaces!- of files extensions you don't want to be included on your backup. Example: “gif,jpg,ttf”, without quotes. This is smart if you have huge files of some type you don't want to backup, as “*.pdf” for example. THIS FEATURE IS ONLY ENABLED FOR LINUX/UNIX.

    Please: if you know how to enable it using 7-zip command line features, write me at ccho@dimension-e.net to enable it for WINDOWS installations as well.

  • Keep Days: Maximum age, in days, of backup files to be kept (0 = keep all). The extension, upon generating a new backup, will unlink (eliminate) any tar.gz file older than this setting. Smart option if you want to control the disk space consumption by tar.gz files.

  • Keep Amount: Maximum amount of backup files to be kept (0 = keep all). The extension, upon generating a new backup, will keep the newest tar.gz files, and unlink (delete) any file that exceeds the allowed amount of tared files. Smart option if you want to control the disk space consumption by tar.gz files.

  • Date format: Date format used on the module for name generation. Refer to PHP manual for details on the options.

  • Permission check: Perform permission check before committing the Backup and Restore operations options. You may prefer to disable it if you have script time out.

  • Log tar list: Add the TAR list to the log operation.

img-9 EXT: Full Backup - 5