Skip to Content

Backup

Version 3.1 by Ludovic Dubost on 2009/10/09
Warning: For security reasons, the document is displayed in restricted mode as it is not the current version. There may be differences and errors due to this.

Failed to execute the [velocity] macro. Cause: [The execution of the [velocity] script macro is not allowed in [xwiki:Documentation.AdminGuide.Backup]. Check the rights of its last author or the parameters if it's rendered from another script.]. Click on this message for details.

Backup/Restore

It's crucial that you define a backup strategy for your wiki so that you don't loose any data in case of a problem with your wiki installation. There are 2 strategies defined below.

Backup configuration files

There are 2 configuration files you'll need to backup:

  • WEB-INF/xwiki.cfg: general XWiki configuration file
  • WEB-INF/hibernate.cfg.xml: Hibernate configuration file

In addition you may want to also backup any extra files you'll have installed in your XWiki installation such as JDBC drivers, extra plugins, etc.

To restore them simply copy them at the same location where you backupped them from.

Backup your database

XWiki stores all its data in a database so all you need to do to save you wiki's data is backup that database.

If you've installed the default standalone version of XWiki then the data are saved in a Hypersonic SQL database bundled by default. It's located in a database directory inside the directory when you installed XWiki. Simply backup this directory and that'll backup all the Hypersonic SQL database.

If you've installed XWiki using your own database then you'll need a backup tool for that database to back it up and to restore it.

  • MySQL: you can use "mysqldump xwiki > xwiki.mysqldump" to backup the xwiki schema (do the same for other schemas if you're in multiwiki mode) and "mysql xwiki --user=root -p < xwiki.mysqldump" to restore it.
  • Oracle: use "exp" to export data and "imp" to restore it.

Use the XWiki Import/Export tool

Since all XWiki data are saved in XWiki pages one solution to backup a XWiki instance is simply to export all its pages. This can easily be done using the Import/Export tool. However note that this is quite a resource hungry operation and depending on the size of your wiki you may need a lot of memory. As a consequence the recommended backup strategy is to backup the databases. It's much etter to use a specialized backup tool that'll bbackup the database, perform incremental backups, verify backup integrity, etc.

The Import/Export should be reserved for the following use cases:

  • move data across XWiki instances, including sharing of applications between separate instances
  • move data to another wiki

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected