Page History
...
| align | right |
|---|---|
| class | menu |
...
...
...
...
...
...
...
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.
| Info | |||||
|---|---|---|---|---|---|
|
| Table of Contents |
|---|
Installing
| Include Page | ||||
|---|---|---|---|---|
|
| Artifact maven dependencies snippet | ||||
|---|---|---|---|---|
|
...
| Code Block |
|---|
<dependency>
<groupId>info.magnolia</groupId>
<artifactId>magnolia-module-backup</artifactId>
</dependency> |
...
Artifact resource link groupId info.magnolia artifactId magnolia-module-backup label $artifactId.jar renderType download_link resourceType JAR
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.
...
config | optional Module configuration node. | ||
| optional Tasks folder. | ||
| required Name of task. | ||
| required Automated execution node. | ||
| required CRON expression that sets the scheduled execution time. | ||
| optional, default is Enables and disables the task. | ||
| required
0 | info.magnolia.module.backup.AutomatedBackupConfiguration is the bean that holds the backup configuration. | |
| required Task name. | ||
| required Path to the backup directory. The path must be absolute. |
...
The backup script provides more flexibility for backing up Magnolia. Options include backing up a single workspace or file, and running a backup from a running Magnolia instance. The backup script is in the bin folder in the Backup module bundle and needs to be run in a CLIfrom the command line.
| Info |
|---|
If choose to use the script, make sure that library versions referenced by the script after the update are the same as the versions in Magnolia you are currently running. |
Usage:
| Code Block | ||||
|---|---|---|---|---|
| ||||
./bin/backup [options] |
...
To restore the previously backed up data, use the restore script in the bin folder in the Backup module bundle. The restore script needs to be run in a CLI. from the command line.
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.
...
-c | --configuration <arg> | required Location of the repository configuration.
|
-r | --repository <arg> | required Location of the repository to restore.
|
-s | --source <arg> | required Source location of the backup. |
-z | --zip | optional Restore from a compressed ZIP archive. |
...
commands | optional Commands folder. |
| required Backup catalog. |
| required Command name |
| |
| required, default is Location of the repository to back up. |
| required, default is Location of the repository configuration. |
| required Target location of the backup. |
| optional, default is When set to |
| optional, default is Interval in seconds for retrying backup execution when an exception occurs. |
| optional, default is Maximum number of retries when encountering an exception. |
...
Overview
Content Tools