Server Options (global.cfg)
The global.cfg file is the configuration file for server wide configurations.
The global.cfg
configuration file is created during installation and can be edited through the admin home page’s system > edit system configuration menu.
Location
The file is in $SEARCH_HOME/conf/global.cfg
, the defaults are in $SEARCH_CONF/conf/global.cfg.default
. The global.cfg.default
file should not be modified.
Format
The format of the file is a simple name=value
pair per line, with the values $SEARCH_HOME
and $COLLECTION_NAME
automatically expanded to the funnelback installation path and the name of the current search package or data source automatically.
Configuration options
The following tables contain descriptions of the options that are used in the configuration file.
Option | Description |
---|---|
Configures any ranges which should be considered 'internal' and hence ignored in X-Forwarded-For processing. |
|
Override the sender email address used for the password reset email. |
|
Set the server into read only mode preventing updates and configuration changes. |
|
App ID to enable tracking via Heap |
|
Specify the default URL to navigate to after an IdP initiated SSO login. (Admin interface) |
|
Enable SAML authentication (Admin interface). |
|
Specify the prefix for the SAML entity ID (Admin interface). |
|
Specify the location of the Groovy class which maps SAML users to their permissions. |
|
Specify the SAML identity provider’s metadata URL (Admin interface). |
|
Specify the alias of private key to use in SAML keystore (Admin interface). |
|
Specify the password for private key in SAML keystore (Admin interface). |
|
Specify the password for SAML keystore (Admin interface). |
|
Specify the location of the SAML keystore (Admin interface). |
|
Specify the URL to log users out of the IdP (Admin interface). |
|
Specify the default URL to navigate to after an IdP initiated SSO login. (Public search) |
|
Enable SAML authentication (Public search). |
|
Specify the prefix for the SAML entity ID (Public search). |
|
Specify the SAML identity provider’s metadata URL (file:// or http://) (Public search). |
|
Specify the alias of private key to use in SAML keystore (Public search). |
|
Specify the password for private key in SAML keystore (Public search). |
|
Specify the password for SAML keystore (Public search). |
|
Specify the location of the SAML keystore (Public search). |
|
Specify the URL to log users out of the IdP (Public search) |
|
Specify the SAML signature/digest algorithm name to use with OpenSAML. |
|
Specifies the maximum number of failed login attempts per period. |
|
Specifies the period over which failed login attempts are tracked. |
|
Specifies the delay applied to authentication attempts after too many failures. |
|
Specifies how long a user’s login session lasts (if no refreshing occurs). |
|
Specifies how much of the user’s login session duration should expire before the user’s next request causes it to be refreshed. |
|
Specifies whether users of Funnelback should be prevented from logging in simultaneously from multiple web browser sessions. |
|
Specify the heap memory size the Funnelback daemon service should be generated with. |
|
Specify the name of the class that will be used to provide the encryption/decryption KeysetHandle. |
|
Specifies the configuration environment the server is in. |
|
Specify the umask value for Funnelback |
|
Enable Intercom usage within the administration dashboard. |
|
Specify the port Jetty will bind to for admin traffic. |
|
Specify the compliance level for multipart/form-data handling |
|
Specify the size of the buffer of HTTP response (in bytes). |
|
Specify the maximum size of the request header (in bytes) |
|
Specify the maximum size of the response header (in bytes) |
|
Specify the heap memory size the Jetty web server service should be generated with. |
|
Specify the metaspace memory size the Jetty web server service should be generated with. |
|
Specify the port jetty will bind to for insecure HTTP search traffic. |
|
Specify the port jetty will bind to for HTTPS search traffic. |
|
Specifies the location of the neo4j server. |
|
Specifies the password to use when connecting to the neo4j server. |
|
Specifies the user name to use when connecting to the neo4j server. |
|
Specifies a label which is unique to the server. |
|
Specify if the mail server requires authentication. |
|
Specify the hostname of the mail server to use. |
|
Specify a password when authenticating with the mail server. |
|
Specify the port of the mail server. |
|
Specify a username when authenticating with the mail server. |
|
Specify the heap memory size the Funnelback graph service should be generated with. |
|
Defines the id of the server plugin which will provide the functionality to scan a file. |
|
Plugin password for storing secret information such as a password in an encrypted format. |
|
Specifies the version of the server plugin which will provide the file scanning capability. |
|
Defines the id of the server plugin which will provide the functionality to map a SAML user. |
|
Specifies the version of the server plugin which will provide the SAML user mapping capability. |
|
Name of script to run after the collection has been created. |
|
Name of the pre-delete hook script |
|
Configures the hostname of the push master node for a push slave node. |
|
Delay before requesting new data from the master node. |
|
Sets the push API port for the master node when running as a push slave. |
|
Specify the maximum number of worker threads push should use. |
|
Specify the host the redis server is running on. |
|
Specify the port redis is listening on. |
|
Specifies whether automatic task scheduling is active or paused for the Funnelback server. |
|
Specify CPU count of the server. |
|
Specifies the secret used for protecting various internal and external endpoints. |
|
Defines the default priority for ADD_URLS_TO_LIVE_VIEW tasks in the task queue API. |
|
Defines the default priority for FULL_UPDATE tasks in the task queue API. |
|
Defines the default priority for INCREMENTAL_UPDATE tasks in the task queue API. |
|
Defines the default priority for INSTANT_UPDATE tasks in the task queue API. |
|
Defines the default priority for UPDATE_KNOWLEDGE_GRAPH tasks in the task queue API. |
|
Defines the default priority for META_INDEX tasks in the task queue API. |
|
Defines the default priority for META_UPDATE tasks in the task queue API. |
|
Defines the default priority for NORMAL_UPDATE tasks in the task queue API. |
|
Defines the default priority for REAPPLY_GSCOPES_TO_LIVE_INDEX tasks in the task queue API. |
|
Defines the default priority for REBUILD_LIVE_INDEX tasks in the task queue API. |
|
Defines the default priority for REFRESH_UPDATE tasks in the task queue API. |
|
Defines the default priority for REMOVE_URLS_BY_PREFIX_FROM_LIVE_VIEW tasks in the task queue API. |
|
Defines the default priority for REMOVE_URLS_FROM_LIVE_VIEW tasks in the task queue API. |
|
|
Defines the default priority for RESTART_FULL_UPDATE_FROM_CRAWLER_CHECKPOINT tasks in the task queue API. |
Defines the default priority for RESTART_GATHER tasks in the task queue API. |
|
|
Defines the default priority for RESTART_INCREMENTAL_UPDATE_FROM_CRAWLER_CHECKPOINT tasks in the task queue API. |
Defines the default priority for RESTART_UPDATE_FROM_INDEX_PHASE tasks in the task queue API. |
|
|
Defines the default priority for RESTART_UPDATE_FROM_SWAP_VIEWS_FORCING_SWAP tasks in the task queue API. |
Defines the default priority for TUNING tasks in the task queue API. |
|
Defines the default priority for UPDATE_ANALYTICS tasks in the task queue API. |
|
Specify the name of the class that will be used to pick tasks off the queue to be run. |
|
Hostname used to access the admin UI. |
|
Port which should be used to access the admin UI. |
|
Protocol for the Admin UI, usually HTTPS |
|
Hostname used to access the search endpoint. |
|
Port which should be used to access the search endpoint. |
|
Protocol of the preferred search end point, usually http. |
|
Address to bind the WebDAV service to |
|
Alias of the key within the keystore.file to use for the WebDAV service |
|
File containing the keystore for the WebDAV service |
|
Password for the keystore.file to use for the WebDAV service |
|
Port to use for the WebDAV service |