Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: DOCU-2801

The Backup module allows you to take manual and scheduled backups of content and configuration. The module backs up Magnolia configuration and all versions of content in all workspaces. Manual and automated scheduled backups can be managed in the Backup app. Backup and restore scripts are provided for more flexible backup options and for restoring Magnolia.

...

Include Page
_Maven is the easiest way to install
_Maven is the easiest way to install

Artifact maven dependencies snippet
rangeHigherVersion2.4
groupIdinfo.magnolia
artifactIdmagnolia-module-backup

...

Code Block
<dependency>
  <groupId>info.magnolia</groupId>
  <artifactId>magnolia-module-backup</artifactId>
</dependency>

...

Backup app

The Backup app allows you to make a manual backup, schedule automatic backups and view existing backup tasks. The tool creates a backup of the entire Magnolia installation.

...

2.4

info.magnolia.module.backup.AutomatedBackupConfiguration is the bean that holds the backup configuration.

config

optional

Module configuration node.

tasks

optional

Tasks folder.

backupTasks

required

Name of task.

automatedExecution

required

Automated execution node.

cron

required

CRON expression that sets the scheduled execution time.

enabled

optionaldefault is false

Enables and disables the task.

class

required

Javadoc resource link
rangeHigherVersionclassName
renderTypeasynchronous

name

required

Task name.

targetPath

required

Path to the backup directory. The path must be absolute.

...

info.magnolia.module.backup.commands.BackupCommand starts the backup execution process both both manual and automated requests.

commands

optional

Commands folder.

backup

required

Backup catalog.

backup

required

Command name

class

requiredjavadoc-resource-link-macro

rangeHigherVersion2.4
className
renderTypeasynchronous

repositoryPath

required, default is magnolia.repositories.home property

Location of the repository to back up.

configurationPath

required, default is magnolia.repositories.jackrabbit.config property

Location of the repository configuration.

backupLocation

required

Target location of the backup.

compression

optional, default is false

When set to true backup is compressed in a ZIP archive.

retryTimeout

optional, default is 30 seconds

Interval in seconds for retrying backup execution when an exception occurs.

maxRetries

optional, default is 3

Maximum number of retries when encountering an exception.

...