Configuration File Reference

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

Home >  Configuring the Server > Defining the Network Settings >

Configuration File Reference

The network settings of both FlowForce Server and FlowForce Web Server can be configured either from the Setup page (see Defining the Network Settings) or by editing .ini configuration files, as described below.

 

There are two .ini files, one for FlowForce Server (flowforce.ini), and another one for FlowForce Web Server (flowforceweb.ini). The .ini configuration files can be found at the following path:

 

Linux

/var/opt/Altova/FlowForceServer2019/data/flowforce.ini

/var/opt/Altova/FlowForceServer2019/data/flowforceweb.ini

macOS

/var/Altova/FlowForceServer2019/data/flowforce.ini

/var/Altova/FlowForceServer2019/data/flowforceweb.ini

Windows

C:\ProgramData\Altova\FlowForceServer2019\data\flowforce.ini

C:\ProgramData\Altova\FlowForceServer2019\data\flowforceweb.ini

 

In the directory above, you can also can find two sample .ini files that contain comments and can be used as a template:

 

flowforce.ini.template
flowforceweb.ini.template

 

After editing the .ini files, remember to restart the corresponding service (FlowForce Server or FlowForce Web Server). For more information, see:

 

 

A sample flowforce.ini file looks as follows:

 

[Listen]
host=127.0.0.1
port=4646
active=1
 
[ListenSSL]
active=1
SSL=1
host=0.0.0.0
port=4647
 
[SSL]
certificate=/path/to/certificate.crt
private_key=/path/to/private_key.key

 

[Master]

host=0.0.0.0

port=4645

active=1

 

A sample flowforceweb.ini file looks as follows:

 

[Listen]
host=0.0.0.0
port=8082
active=1
 
[ListenSSL]
active=1
SSL=1
host=0.0.0.0
port=8083
 
[SSL]
certificate=path/to/certificate.crt
private_key=path/to/private_key.key
 
[FlowForce]
host=127.0.0.1
port=4646

 

The .ini files are organized into sections, as described below. Differences between both files are mentioned below where applicable.

 

[Listen]

A [Listen] section defines the HTTP connection settings. It is possible to define multiple [Listen] sections. Each [Listen] section must begin with "Listen", for example [ListenSSL].

 

active

(Optional) Activates or deactivates this [Listen] section. Valid values:

 

0

disabled

1

enabled

 

For example, active=1 means that HTTP connections are enabled.

ssl

(Optional) Enables SSL support for this [Listen] section. Valid values:

 

0

disabled

1

enabled

 

To enable SSL support, set ssl=1 and also create a [SSL] section, as shown below.

host

Specifies the host address of FlowForce (Web) Server, for example, 127.0.0.1. This can be an IPv4 or IPv6 address. Use 0.0.0.0 to listen on all interfaces. For local access only, use 127.0.0.1.

port

Specifies the port on which FlowForce (Web) Server will listen.

 

[SSL]

This section defines the SSL/HTTPS connection settings.

 

certificate

Specifies the absolute path to the certificate file in PEM format.

private_key

Specifies the absolute path to the private key file.

certificate_chain

(optional) The path to the certificate chain file.

 

[FlowForce]

This section is applicable only for FlowForce Web Server (the flowforceweb.ini file). It defines the connection details between FlowForce Web Server and FlowForce Server.

 

ssl

(Optional) Enables SSL support for the connection between FlowForce Web Server and FlowForce Server. Valid values:

 

0

disabled

1

enabled

host

Specifies the host address of FlowForce Server.

 

If SSL is enabled, this value must be the same as the one in the "[ListenSSL]" section of the flowforce.ini file. Also, it must correspond to a server name (or IP address, if applicable) that matches the Common Name of the SSL certificate available for FlowForce Server.

port

Specifies the port on which FlowForce Server will listen.

certificate

(Optional) Defines what server certificate will be accepted by FlowForce Server. If no certificate is given, the system root CA certificates will be used to verify the server certificate. If present, this value must match the certificate that FlowForce Server is using (the one in the flowforce.ini file).

 

[FlowForceWeb]

This section is applicable only for FlowForce Web Server (the flowforceweb.ini file).

 

timezone

Specifies the default time zone of FlowForce Web Server, for example timezone=Europe/Berlin

 

 

[Master]

This section is applicable only for the flowforce.ini file. It is relevant when multiple FlowForce Server instances run in a cluster, and the current instance is the master instance, see Distributed Execution and Load Balancing.

 

active

Enables encrypted connection to this master instance. Valid values:

 

0

disabled

1

enabled

binding address

Specifies the binding address of the master FlowForce Server instance. Use 0.0.0.0 to listen on all interfaces.

port

The port on which this master instance listens for requests from worker instances.

 


© 2019 Altova GmbH