Change repository home

By default the repository is located at "$TOMCAT_HOME/repository" but you can change to other location.

This action must be done with application stopped.

Understanding the contents of repository folders

Into "$TOMCAT_HOME/repository" there are three folder tmpindex, cache and datastore.

FolderBackupDescription

tmp

No

This folder contains some temporary files to be shared beween several clusteres OpenKM instances.

index

No

The folder which contains the Lucene search engine indexes. The content of that folder can be rebuild.

Although is not mandatory backup this folder, we recommend doing it.

 cache

 No

The folder which contains the application cached files. For example, for previewing documents, sometimes is needed to transform the original document to other format. The conversion consumes a lot of hardware resources, for this reason the application  stores these converted files to be reused later. The content of that folder can be cleaned without major problems.

Although is not mandatory backup this folder, we recommend doing it.

datastore

Yes

The folder which contains all binary data of the documents. 

Is mandatory mandatory backup this folder otherwise the binary data of the documents could be lost on a server hardware fail.

extraction

Yes

This folder contains the text extracted from those documents stored in OpenKM. A backup is not really necessary but may be a time saver. 

Move entire repository location

  • Stop the application
  • Move the "$TOMCAT_HOME/repository" to other location.
  • Edit the "$TOMCAT_HOME/OpenKM.cfg" file and add the property "repository.home".
  • Start the application

Sample

Windows

repository.home=C:/okmrepo

Linux

repository.home=/mnt/okmrepo

Move repository folders  individually

Table of properties:

FolderPropertyDefault

index

hibernate.search.index.home

${repository.home}/index

tmp

repository.temp.home

${repository.home}/tmp

cache

repository.cache.home

${repository.home}/${tenant.id}/cache

datastore

repository.datastore.home

${repository.home}/${tenant.id}/datastore

extraction

repository.extraction.home

${repository.home}/${tenant.id}/extraction

These parameters can be used in combination with the parameter "repository.home" and "tenant.id".

  • Stop the application
  • Move the "$TOMCAT_HOME/repository/{folder}" to other location.
  • Edit the "$TOMCAT_HOME/OpenKM.cfg" file and add the some property.
  • Start the application

Sample

Windows

hibernate.search.index.home=C:/${repository.home}/index
repository.datastore.home=D:/okm/${repository.home}/datastore
repository.cache.home=D:/okm/${repository.home}/cache
repository.temp.home=D:/okm/${repository.home}/tmp

Linux

hibernate.search.index.home=/mnt/${repository.home}/index
repository.datastore.home=/mnt/okm/${repository.home}/datastore
repository.cache.home=/mnt/okm/${repository.home}/cache
repository.temp.home=/mnt/okm/${repository.home}/tmp