3.10. Important Files and their Locations

3.10. Important Files and their Locations
	Chapter 3. Installation

3.10.1. Log Files
3.10.2. Database Settings
3.10.3. Language Files
3.10.4. The Quotes File
3.10.5. The Derby Database
3.10.6. The Content Repository

There are two important directories in a Klaros-Testmanagement installation. One is the installation folder where the Tomcat application server and the web application will be installed. The other is the home folder containing runtime data like configuration files, search indices and attachments. Per default, this folder is named .klaros and located in the home folder of the user running Klaros-Testmanagement.

To allow a simple upgrade the installation/upgrade process will only change files in the installation folder and leaves the content of the home folder untouched.

On Microsoft Windows systems, by default the home folder is located at C:\Users\<username>\.klaros. This can also be addressed by entering %UserProfile%\.klaros in an explorer window address bar or by entering cd %UserProfile%\.klaros on the command line.

On Linux systems this folder can be found using the path ~/.klaros and is generally located at /home/<username>/.klaros.

	Relocating the Klaros Home Folder
	By setting the environment variable `KLAROS-HOME` before starting the application the location of the home folder can be moved to another location. export KLAROS_HOME=/var/application-data/klaros

	Heads up When Moving the Klaros Home Folder!
If the application does not find a previous installation in the home folder it will bootstrap an empty default installation including a new local database. If this happens accidentally, e.g. by specifying an invalid Klaros home directory, it seems that the previous data has disappeared. Of course this is not the case. To resolve this situation point the KLAROS-HOME variable to the correct location and restart.

Heads up When Moving the Klaros Home Folder!

If the application does not find a previous installation in the home folder it will bootstrap an empty default installation including a new local database. If this happens accidentally, e.g. by specifying an invalid Klaros home directory, it seems that the previous data has disappeared.

Of course this is not the case. To resolve this situation point the KLAROS-HOME variable to the correct location and restart.

3.10.1. Log Files

The complete log files for Klaros-Testmanagement are located in the directory logs in the installation directory and also in compressed form in the directory logs in the Klaros home directory.

Attaching these log files to a bug report helps the support team to quickly identify and fix any problems you encounter.

3.10.2. Database Settings

The .klaros/hibernate.properties file is used to specify the database to be used for Klaros-Testmanagement. It defines the driver class and the URI under which the database is accessible as well as the required authentication information. For more information about changing the database settings, see Section 3.11, “Changing the Default Database”.

3.10.3. Language Files

The Klaros-Testmanagement user interface may be customized by adding support for additional languages. This process is described in Section 4.1.1, “Defining Language Files”. The language files can be found under .klaros/resources/messages.

3.10.4. The Quotes File

Klaros-Testmanagement displays a daily changing quote of the day on the login page. These quotes are stored in the .klaros/resources/quotes.txt file. For more information, see Section 10.4.4, “Interface” and Section 4.2, “Quote of the Day”.

3.10.5. The Derby Database

If you are using the default Apache Derby database, the database files are located in the .klaros/klarosDerby folder.

3.10.6. The Content Repository

All attachments and custom reports are saved in the .klaros/contentRepository folder. If the Klaros-Testmanagement installation and database are migrated to a different location, this folder must be moved with them.


3.9. Update Process		3.11. Changing the Default Database