This documentation is for an outdated version: 14.5.0. The current version is 14.6.17 - get the documentation here.

fit.ini

This document provides an overview of the configuration settings that can be set in the file conf/fit.ini or in .ini files in the directory conf/fit.ini.d/.

Configuration settings are written line-by-line with the following syntax. Lines beginning with a semicolon are considered comments. Blank lines are ignored:

; Comment
;
string_setting = "a string value"
boolean_setting = false
numeric_setting = 42

Each configuration setting has one of the following types:

Type Allowed values Examples
Boolean a Boolean truth value true, false
Number any natural number, including 0 0, 42, 4194304
String a string of characters enclosed in double quotes "", "localhost"
Regular Expressions A string containing a list of regular expressions, including delimiters and modifiers, separated by spaces. "|https?://example\.com| #example\.(net|org)#i"

The fitadmin command line tool in /opt/sevenval/fit14/bin allows easy access to all configuration settings.

# fitadmin config list

outputs a list of all configuration settings. To get a specific value use fitadmin config get, e.g.

# fitadmin config get FIT_HTTP_PROXY

The following sections describe all supported configuration settings. See also the commented configuration file conf/fit.ini.

General settings

Setting Type Default value
FIT_VHOST_DEFAULT_IP String "*"
FIT_USER String "fit-data"
FIT_INSTALLATION_ROLE String ""
  • FIT_VHOST_DEFAULT_IP: The IP address used for the Apache virtual hosts. After changing this value you have to execute fitadmin config generate to update the Apache configuration in conf/include/listen.conf and conf/vhosts. (see domain configuration.
  • FIT_USER: The Unix user to start the FIT Server with. If your FIT Server binds to ports lower than 1024, the value must be "root". If your FIT Server only uses ports from 1024 upwards, we recommend setting this to a non privileged user of the fit-data group, for example "fit-data".
  • FIT_INSTALLATION_ROLE: This setting is used to distinguish production systems from staging or development servers. Its value is accessible in the delivery context as server/role. You can use it in AI filters or to change the flow you are using. For example, you could use placeholder ads when you are on a devel installation.

Debugging

Setting Type Default value
FIT_ALLOW_DEBUG_LOGGING Boolean false
FIT_DEFAULT_ENGINE_DEBUG String ""
FIT_DEBUG_LOGGING_WHITELIST Regular Expressions ""
FIT_DEBUG_AUTH_USER String ""
FIT_DEBUG_AUTH_PASSWORD String ""
FIT_STRICT_CONFIG Boolean false
FIT_VERBOSE_EXCEPTIONS Boolean false
FIT_DEPRECATION_EXCEPTIONS Boolean false
  • FIT_ALLOW_DEBUG_LOGGING: Setting this to true enables debugging by way of the URL mark d=…. On production systems, this is usually set to false.
  • FIT_DEFAULT_ENGINE_DEBUG: Controls which information is included in the debug output, e.g. errorlog-fetch-info.
  • FIT_DEBUG_LOGGING_WHITELIST: Defines which clients are allowed to see debug output via the URL Mark d=…. The regular expressions are matched against the client’s IP address.
  • FIT_DEBUG_AUTH_USER: Clients not authorized by FIT_DEBUG_LOGGING_WHITELIST may authenticate themselves with this username and the password defined by FIT_DEBUG_AUTH_PASSWORD.
  • FIT_DEBUG_AUTH_PASSWORD: The password used for authentication.
  • FIT_STRICT_CONFIG: Enables the strict XML validation of the site configuration files. If enabled and a site configuration file is not well-formed, the FIT Engine will terminate with an exception.
  • FIT_VERBOSE_EXCEPTIONS: Enables the output of the detailed exception messages in case of fatal errors. If enabled, the exception messages are visible to all users. On production systems, this setting should usually be left disabled, i.e. set to “false”. If disabled (false), no EXCEPTION placeholder is availbale in the exceptions template.
  • FIT_DEPRECATION_EXCEPTIONS: Enables the strict deprecation handling. If enabled, the usage of deprecated features terminates with an error. On production systems, this setting should usually be left disabled, i.e. set to “false”.
  • FIT_STRICT_IMAGE_PROCESSING: Enables the strict image processing. If disabled, on errors while processing of image scaling the original source is forwarded to the client. Otherwise the processing terminates with an error.

Refer to the debugging documentation for details.

FIT Engine

Setting Type Default value
FIT_FETCH_DEFAULT_TIMEOUT Number 3
FIT_FETCH_MAX_TIMEOUT Number 20
FIT_MAX_TIMEOUT_PROCESSES Number 30
FIT_MAX_IMAGE_AREA Number 8
FIT_ALLOW_TRANSPORT_MAPPING Boolean false
FIT_USE_XSLT_CACHE Boolean true
FIT_MAX_PARSE_SIZE Number 3
  • FIT_FETCH_DEFAULT_TIMEOUT: Default timeout in seconds for outgoing HTTP requests. May be overwritten in fit://site/conf/sources.xml or in a request action. The maximum allowed timeout is limited by FIT_FETCH_MAX_TIMEOUT.
  • FIT_FETCH_MAX_TIMEOUT: Maximum allowed time in seconds for outgoing HTTP requests.
  • FIT_MAX_TIMEOUT_PROCESSES: Specifies how many PHP-FPM processes are allowed to wait for slow sources at any one time. The lower the threshold value, the earlier slow sources will be blocked.
  • FIT_MAX_IMAGE_AREA: Maximum size of a source image in megapixels.
  • FIT_ALLOW_TRANSPORT_MAPPING: Allow sites to change transport parameters of source requests, such as protocol, hosts or ports.
  • FIT_USE_XSLT_CACHE: If set to false, no compiled XSLT stylesheets will be cached. On production systems, this should be left at the default value true.
  • FIT_MAX_PARSE_SIZE: Maximum input size for the HTML/XML parser in megabytes. Set to prevent excessive CPU usage when processing large DOMs. If the given size is exceeded, the request terminates with an error. Make sure the value is large enough to parse your configuration files (flow.xml, sources.xml etc.) – we recommend a minimum of 1 megabyte.

Since FIT uses mod_proxy_fcgi to communicate with php-fpm, the ProxyTimeout setting of the Apache httpd limits the overall time FIT may take to deliver a result. If it is exceeded, a 503 (Service Unavailable) response may be displayed. The value should at least be slightly larger than the FIT_FETCH_MAX_TIMEOUT. Note that FIT may execute multiple requests sequentially, each of which may take FIT_FETCH_MAX_TIMEOUT seconds, and may additionally take max_execution_time seconds on top of that to compute the output.

Proxy

Setting Type Default value
FIT_HTTP_PROXY String ""
FIT_NO_PROXY_LOCATIONS Regular Expressions ""
FIT_HTTP_PROXY_USER String ""
FIT_HTTP_PROXY_PASS String ""
  • FIT_HTTP_PROXY: Address of the proxy via which all external resources are loaded, e.g. http://127.0.0.1:3128.
  • FIT_NO_PROXY_LOCATIONS: Resources which are not to be loaded via the proxy specified by FIT_HTTP_PROXY. The expressions are matched against the URL to be loaded.
  • FIT_HTTP_PROXY_USER: User name, if the proxy specified by FIT_HTTP_PROXY requires authentication.
  • FIT_HTTP_PROXY_PASS: Password used for proxy authentication.

Server Status

Setting Type Default value
FIT_STATUS_URL String ""
  • FIT_STATUS_URL: URL at which the server status can be accessed, e.g. http://127.0.0.1:8880/