1. Home
  2. OpenKM 6.3 - CE
  3. Setup
  4. Change repository home
  1.  

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 "index", "cache" and "datastore".

FolderBackupDescription

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.

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:

FolderProperty

index

hibernate.search.index.home

cache

repository.cache.home

datastore

repository.datastore.home

These parameters can not be used in combination with the parameter "repository.home".

  • 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:/okmrepo/index
repository.datastore.home=D:/okm/datastore
repository.cache.home=D:/okm/cache

Linux

hibernate.search.index.home=/mnt/okmrepo/index
repository.datastore.home=/mnt/okm/datastore
repository.cache.home=/mnt/okm/cache

Troubleshooting

Windows mapped network disk is not working

We encourage do not use networking ( NAS or Samba ) for storing repository. Because network issues will affect the repository we consider as a dangerous configuration.

 Seems there're restrictions using network unit ( mapped with "net use" command line ) and application running from services. To solve it is necessary to create a link between UNC and the file system.

MKLINK /D C:\okm-repository \\192.168.1.36\eDocuments\okm-repository

In most cases will be necessary to use a standard user for running OpenKM service either the standard configured. Take a look at OpenKM windows service configuration to change the default "Local system user" to your own.