Magnolia 5.3 reached end of life on June 30, 2017. This branch is no longer supported, see End-of-life policy.

Page tree
Skip to end of metadata
Go to start of metadata

The Backup module installs the Backup app that allows you to take a manual backup, schedule automatic backups and view scheduled backup tasks.

The Backup module ensures the proper backup of data from inside of Magnolia. This module is an alternative to file system and database backup solutions. The module provides immediate interactive backup of JackRabbit backed repositories and scheduled recurring backup support with cron-like configuration options.

Download

The Backup module is bundled with Magnolia and typically already installed. You can download it from our Nexus repository.

Installing

Backup is a Enterprise Edition module. It is typically already installed. Launch the Configuration app and go to /modules/backup to check.

 Click for installation steps...

(warning) Create a backup of your system before you install a module. Uninstalling a module is not as simple as removing the .jar file. Modules add and change configurations and may change the content. Try new modules in a test environment first. A module consists of a JAR file and may include dependent JAR files. Modules are responsible for updating their own content and configurations across versions. Be sure to keep only one version of each module and its dependencies.

To install a module:

  1. Stop the application server.
  2. Copy the module JAR files into the WEB-INF/lib directory. The location of this directory depends on the application server.
    • Tomcat: /webapps/magnoliaAuthor/WEB-INF/lib
    • JBoss: /server/default/deploy/magnoliaAuthor/WEB-INF/lib
  3. Restart the server.
  4. Go to the AdminCentral URL.
  5. Start the Web update process.
  6. Click Start up Magnolia.

Repeat the steps for each author and public instance.

Uninstalling

 Click for uninstallation steps...

To uninstall a module, remove the module JAR file from the /WEB-INF/lib folder and restart Magnolia.

(warning) However, this is rarely enough. Modules add and modify configuration during installation. The use of a module also changes content. Removing all of these changes is difficult without knowing the installation tasks in detail.

To test a module, use the embedded Derby database and take a backup of your repositories folder. Install the module and try it. When you are done testing, remove the module JAR and restore the repositories folder from the backup. This way you can go back to square one.

We also recommend that you segregate the development and production environments. Take regular backups for disaster recovery so you can revert to a prior state in a routine fashion.

Taking a manual backup

  1. Go to Tools > Backup.
  2. In Manual backup enter the target path for backup.
  3. Click Backup. The target ID will be created if it doesn't already exist.

The backup consists of the following files:

  • repoConfig.zip - all configuration files necessary to restore the repositories.
  • history.gz - versions of all versionable content from all repositories.
  • <workspace_name>.gz - one file per workspace. Holds all content of given workspace.
  • blobs - folder with binary data from all the workspaces.

(warning) Backup files contain confidential information on how to connect to the database. Keep your backup files in a secure location.

Scheduling automatic backups

  1. Go to Tools > Backup.
  2. In Automatic backup set the time, frequency and target directory
  3. Click Schedule backup.

The tool registers an automatic backup task in the module configuration in /modules/backup/config

Node nameValue

 modules

 

 backup

 

 config

 

 tasks

 

 weeklyBackup

 

 automatedExecution

 

 cron

0 0 6 * * *

 enabled

true

 class

info.magnolia.module.backup.BackupRun

 name

weeklyBackup

 targetPath

 /tmp/backup

Viewing existing tasks

Scheduled automatic backups display in a list in Existing tasks.

Restoring a backup

To restore the previously backed up data, use the restore script in the Backup module bundle.

The restore script is meant to recreate an instance, not to patch an existing one. For it to work correctly you should clean your database schema before running it.

(warning) There is no UI for running the restore script. Run the script before starting Magnolia so that the script can re-create the repository.

To make sure the webapp directory is properly setup before running the restore, we recommend you take the WAR file or webapp from the bundle, add all your custom modules, startup the server once and perform the installation. Perform a backup of this new instance. After that, shutdown the server, delete the repositories directory and run the restore as specified below.

Usage:

restore [options]

Options:

  • -backup <dir>. Backup folder.
  • -help
  • -lib <dir>. Directory containing Magnolia's jar files. Default is the webapp's directory suffixed with WEB-INF/lib/.
  • -propertyfiles <arg>. List of property files to load. By default, files specified in web.xml are used. If the properties are not specified in web.xmldefault configuration properties are used.
  • -saveAfter <num>. Persistence counter. The lower the number, the less memory is used and the slower the restore runs. Default value is 100.
  • -servername <name>. Server name. Used for dynamic property file finding.
  • -webapp <dir>. Webapp's root folder. Default is the current directory.
  • -webappname <name>. Webapp name. Used for dynamic property file finding. Default is the directory name of the webapp.

Example:

./bin/restore -backup /path/to/backup/backup_0812305_1234 -webapp /path/to/magnolia/webapp

Tip

You should reindex your repository once the restore script is done since the Lucene indexer works asynchronously. Even though the restore script has completed indexing may be ongoing and incomplete.

Tip

Assign the restore script more memory by changing the EXTRA_JVM_ARGUMENTS variable in the script file. On a Linux server you need to grant the correct permissions to the script file in order to run it.

Best practice

For safety reasons, run the restore from time to time on a test system to verify the validity of the backup files. Depending on the amount of data changed over the time, perhaps do so every month or every quarter.

Deleting search indexes

Backup data does not contain search indexes. Indexes are created on the fly when running restore. As the indexer runs asynchronously, the indexing may still be in progress when restore is done. For this reason, we recommend that you remove all indexes before starting up a restored instance. This ensures that indexes are freshly generated on startup (Note that this process can take a couple of minutes). To remove indexes just delete all index folders from the workspaces. On unix systems you can do so by executing rm -rf repositories/magnolia/workspaces/*/index.

Database size

During restore all entries are reinserted into the database sequentially. This ensures that the restored database is not fragmented and is slightly smaller than the equivalent database before backup.

Changing persistence managers

You can use backup/restore to migrate data to another persistence manager and to another database.

To change the persistence manager configuration to which the restore script restores the database:

  1. Unzip all entries from repoConfig.zip. You can find this file inside each backup folder. 
  2. Change the persistence manager configuration in each file.
  3. Zip the files.
  4. Run the restore.

    This step is not necessary if you performed a backup of the new instance. Get the repoConfig.zip file from that backup and run the restore script