Server configuration (advanced)

This document is intended to guide you through the configuration of ARCAD CodeChecker. The main configuration is done through a set of configuration files (with extension.cfg or .ini) stored in the configuration folder under the application's home directory. Every path given here is relative to the application home directory.

The following steps must be checked before running the application for the first time. Incorrect configuration may compromise the stability of the application or require a new installation.

Make sure that:

  1. The ./configuration folder contains the config.ini file, the osgi.cm.ini file and all the *.cfg files used for specific configuration parts. Note that the folder containing the *.cfg files is designated in the config.ini file by the osgi.cm.storefile parameter.

  2. The com.arcadsoftware.masterkey property or the com.arcadsoftware.masterkey.fog property in the config.ini file are set to a value complex enough. These parameters are used to generate all encrypted materials.

    Warning!

    If these parameters are not set before the first run of the application, a random value will be used and stored into the config.ini file.

    Their value must not be changed after the first run of the application in any case. If changed, important information and encrypted data will be lost.

  3. In the database parameters, the data sources required by the application are predefined to connect to an H2 database. Make sure that the H2 database file itself exists and the default password of the JDBC connection must be been changed to a more complex one. If you plan to use a PostgreSQL database, you must install it before starting the server of the application.
  4. In the HTTP(S) server configuration, the HTTP and/or HTTPS port numbers are set. These TCP port numbers must be free and authorized by any firewall control. If a HTTPS server is used, make sure that the keystore is set and points to an existing file containing the correct certificate associated to your company policy.
  5. The log is configured so that a log file is generated. For a first run, the log level can be set to the info level, but in a production environment, the log level should be set to the warn or error levels.

These check points ensure that the application starts correctly. However, the application may require some specific additional configuration steps. Some can be done before the first run, like installing a license key.

The parameters that may compromise the security of the application are indicated in Warning boxes. These options should not be activated in production, except for diagnostic purposes and for a limited time.

For each parameter, when necessary, the type of parameter is indicated. The most common parameter types are strings, integers and true/false for Boolean values. The expression of these values may change depending on the format of the configuration file.

Note

When a default value is specified in the description of a parameter, this parameter is an optional one.

Important!

Setting a parameter to an empty value does not set this parameter to the default value. To do so, the parameter must not be present in the configuration files.