View source for Repository backup 5.x

OpenKM backup depends on repository configuration. By default, all documents are stored in $JBOSS_HOME/repository. This default folder can be changed using the property repository.home in the file [[OpenKM.cfg]]. If you want to make a backup, you should keep a copy of this folder. Is also recommended to backup files located at ''$JBOSS_HOME/server/default/data/hypersonic'' because there are several databases which handle important data.

{{Note|Keep on mind that OpenKM by default use the embedded Hypersonic database, which files are located at ''$JBOSS_HOME/server/default/data/hypersonic''. If you configure another database ad MySQL you need to backup this database, and not the previous Hypersonic files.}}

{{Warning|It is recommended to stop JBoss before start the backup to prevent file modifications in the middle of the process because can make the backup useless.}}

The backup process should have these steps:

* Stop JBoss
* Backup important folders
* Start JBoss

'''In Unix / Linux''' you can backup the repository folder running these commands from $JBOSS_HOME. First stop JBoss:

 $ ./bin/shutdown.sh -S

Once JBoss is stopped (you can see the JBoss log to ensure it has stopped) , make the backup:
 
 $ tar czf repository.tgz repository

To check the backup, rename the repository folder:

 $ mv repository repository-old

Restore the backup:

 $ tar xzf repository.tgz

And start JBoss:

 $ ./bin/run.sh

See also [[Backup scripts]].

'''In Windows''' could be something like this:

* Stop JBoss
 c:\jboss\bin\shutdown.bat -S

* Make backup
 xcopy c:\jboss-4.2.3.GA\*.* e:\Backup\ /s/e

* Start JBoss again
 c:\jboss-4.2.3.GA\bin\run.bat -b 0.0.0.0

The complete script may be like this one:

<source lang="dos">
 c:\jboss\bin\shutdown.bat -S
 xcopy c:\jboss-4.2.3.GA\*.* e:\Backup\ /s/e
 c:\jboss-4.2.3.GA\bin\run.bat -b 0.0.0.0
</source>

There's a little problem in default shutdown.bat and run.bat script because makes a pause at ends, you might delete the final line in both scripts

<source lang="dos">
if "%NOPAUSE%" == "" pause
</source>

{{Note|Due to Jackrabbit flexibility you can configure your OpenKM installation to store the documents in a database, for example. In this case you have to modify the backup procedure. Anyway the $JBOSS_HOME/repository folder should be backup because it
contains repository meta data.}}

== Alternative backup procedure ==
There is an alternative method for backups: you can export the whole repository from OpenKM administration. The folder structure will be re-created in the local filesystem, and all document on them. Since '''OpenKM 5.1.9 also can export document related metadata''', but in older versions you can't and will lose the document history and other metadata like Property Groups.

{{Advice|Ensure you have enough free disk space before perform this operation.}}

This export is only of the document repository and won't backup all other information stored in OpenKM database as user, roles, property groups definitions, workflows, mail accounts, etc.

[[Category: Installation Guide]]