Server Configuration File
The server configuration file is called server_config.ini and is located in the application data folder. You can reconfigure the server by modifying the settings in this file. To create a DiffDog Server configuration file with the default configuration settings, run the createconfig command.
Server configuration settings
The settings of the server configuration file are given below.
address | Defines the address (HTTP interface) on which DiffDog Server should listen for HTTP requests. This should be an IP address from one of the network interfaces configured at the machine or the name localhost. To have DiffDog Server listen on all interfaces, set this value to 0.0.0.0. If it should listen for local requests only, set this value to 127.0.0.1 (which is the default setting). | ||||
hide-alias-paths | An alias is a directory path on the server that clients are allowed to access when performing remote comparisons. This option controls the level of detail that clients can see when they run the aliases command. It is meaningful if the restrict-to-aliases option is set to true.
See also: Aliases for Server Folders | ||||
jvm-location | This option lets you specify the path to a Java VM (Virtual Machine) required for Java-specific tasks such as connecting to a database through JDBC.
Note that adding a custom Java VM path is typically not necessary. By default, the application attempts to detect the Java VM path automatically based on the JAVA_HOME environment variable. On Windows, the Java VM path is determined by reading (in this order) the Windows registry and the JAVA_HOME environment variable.
The custom path added in the jvm-location option will take priority over any other Java VM path detected automatically. If set, the path must point to the jvm.dll (Windows), jvm.so (Linux), or libjvm.dylib (macOS) file found in the JDK installation directory. | ||||
language | Specifies the language of the command line interface. Valid values are en, de, es, fr, ja (English, German, Spanish, French, and Japanese). | ||||
port | Defines the port on which DiffDog Server should listen for HTTP requests. The default setting is 29800. | ||||
restrict-to-aliases | Restricts access to server paths for remote clients connecting to DiffDog server. Valid values are:
| ||||
server.log-file | Defines the name and location of the server's log file. This file contains general activity events logged by the server, including licensing events. | ||||
server.output-root-dir | Specifies the directory where the output of all submitted jobs is saved. | ||||
server.unrestricted-filesystem-access | When set to True (the default value), output files are written directly to the location specified by the user (possibly overwriting existing files of the same name). Setting the value to True is meaningful if the client and server are on the same machine and you want to write the output files to any directory on that machine.
When set to False, output files are written to the output directory (see the server.output-root-dir option). |
[alias:<name>]
An alias is a directory path on the server that clients are allowed to access when performing remote comparisons. When restrict-to-aliases=true, clients must always specify the --alias option when running a comparison that includes server paths. For an example, see Aliases for Server Folders.
You can create multiple aliases, for example [alias:name1], [alias:name2], and so on. The name of each alias must be unique. An alias can have only one option: path., which is the path to the to the folder on the server that DiffDog Server clients are allowed to access. For example, the following configuration creates an alias called sandbox for the directory C:\Public.
[alias:sandbox]
path = C:\Public
restrict-to-aliases = true
[datasource:<name>]
A [datasource] section defines (i) the connection details to a database and (ii) specifies various other parameters applicable when performing database comparisons. You can create multiple data sources if necessary. Also see Setting up Data Sources and CLI: data-diff, compare-data.