Server Configuration File

www.altova.com Print this Topic Previous Page Up One Level Next page

Home >  Configuring the Server >

Server Configuration File

After installation, DiffDog Server contains a server configuration file called server_config.ini located in the application data directory. The application data directory depends on the operating system:

 

Linux

/var/opt/Altova/DiffDogServer

Mac

/var/Altova/DiffDogServer

Windows 7, 8, 10

C:\ProgramData\Altova\DiffDogServer

 

To create a DiffDog Server configuration file with the default configuration settings, run the createconfig command.

 

The server configuration file includes the following options.

 

Option

Description

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. Valid values:

False

Allow clients to view the list of aliases defined on the server along with the paths to which each alias points.

True

Allow clients to view just the list of aliases defined on the server; do not show any paths.

See also: Restricting Access to Server Paths

http.access-file

Defines the name and location of the HTTP access log file. The access file contains information about access-related activity. It contains information that is useful for resolving connection issues.

http.environment

Sets the environment (development or production). The development production allows for easier debugging compared to the production one. Valid values:

production

Set environment to production.

development

Set environment to development.

http.error-file

Defines the name and location of the HTTP error file. The error file contains errors related to traffic to and from the server. If there are connection problems, this file can provide useful information towards resolving them.

http.log-screen

If you started DiffDog Server with the command debug, and if this option is set to true, then server activity is displayed in the command line console. Otherwise, server activity is not displayed. The log screen is displayed in addition to the writing of log files.

http.socket-host

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.

http.socket-port

Defines the port on which DiffDog Server should listen for HTTP requests.

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 an 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).

restrict-to-aliases

Restricts access to server paths for remote clients connecting to DiffDog server. Valid values:

True

Access to server paths is restricted. If you set this value, then at least one [alias:<identifier>] must be defined in the configuration file as well, see below. Any server paths outside of the alias directory are not accessible to remote clients and cannot be included in comparisons.

False

Access to server paths is not restricted.

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. Creating aliases is meaningful if the option restrict-to-aliases=true. When restrict-to-aliases=true, clients must always specify the --alias option when running a comparison that includes server paths. For an example, see Restricting Access to Server Paths.

 

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.

 

Option

Description

path

The path to the directory that DiffDog Command Line clients are allowed to access on the server.

 

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 the connection details to a database, and specifies various other parameters applicable when performing database comparisons. You can create multiple data sources if necessary. For more information, see Setting up Data Sources.


© 2019 Altova GmbH