Skip to content

global.cfg

The global.cfg file is the configuration file for server wide configurations.

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 collection automatically.

Configuration options

The following tables contain descriptions of the options that are used in the configuration file.

OptionDescription
admin-api.reset-password-from-emailOverride the sender email address used for the password reset email.
admin.read-only-modeSet the server into read only mode preventing updates and configuration changes.
auth.admin.saml.default-login-redirect-urlSpecify the default URL to navigate to after an IdP initiated SSO login. (Admin interface)
auth.admin.saml.enabledEnable SAML authentication (Admin interface).
auth.admin.saml.entity-id-prefixSpecify the prefix for the SAML entity ID (Admin interface).
auth.admin.saml.groovy-permission-mapperSpecify the location of the Groovy class which maps SAML users to their permissions.
auth.admin.saml.identity-provider-metadata-urlSpecify the SAML identity provider's metadata URL (file:// or http://) (Admin interface).
auth.admin.saml.key-aliasSpecify the alias of private key to use in SAML keystore (Admin interface).
auth.admin.saml.key-passwordSpecify the password for private key in SAML keystore (Admin interface).
auth.admin.saml.keystore-passwordSpecify the password for SAML keystore (Admin interface).
auth.admin.saml.keystore-pathSpecify the location of the SAML keystore (Admin interface).
auth.admin.saml.logout-urlSpecify the URL to log users out of the IdP (Admin interface).
auth.publicui.saml.default-login-redirect-urlSpecify the default URL to navigate to after an IdP initiated SSO login. (Public search)
auth.publicui.saml.enabledEnable SAML authentication (Public search).
auth.publicui.saml.entity-id-prefixSpecify the prefix for the SAML entity ID (Public search).
auth.publicui.saml.identity-provider-metadata-urlSpecify the SAML identity provider's metadata URL (file:// or http://) (Public search).
auth.publicui.saml.key-aliasSpecify the alias of private key to use in SAML keystore (Public search).
auth.publicui.saml.key-passwordSpecify the password for private key in SAML keystore (Public search).
auth.publicui.saml.keystore-passwordSpecify the password for SAML keystore (Public search).
auth.publicui.saml.keystore-pathSpecify the location of the SAML keystore (Public search).
auth.publicui.saml.logout-urlSpecify the URL to log users out of the IdP (Public search)
auth.user.allowed-failures-per-periodSpecifies the maximum number of failed login attempts per period.
auth.user.allowed-failures-period-length-secondsSpecifies the period over which failed login attempts are tracked.
auth.user.login-token-lifetime-secondsSpecifies how long a user's login session lasts (if no refreshing occurs).
auth.user.login-token-refresh-after-percentageSpecifies how much of the user's login session duration should expire before the user's next request causes it to be refreshed.
auth.user.prevent-concurrent-user-login-sessionsSpecifies whether users of Funnelback should be prevented from logging in simultaneously from multiple web browser sessions.
jetty.admin_portSpecify the port Jetty will bind to for admin traffic.
jetty.search_portSpecify the port jetty will bind to for insecure HTTP search traffic.
jetty.search_port_httpsSpecify the port jetty will bind to for HTTPS search traffic.
knowledge-graph.neo4j.locationSpecifies the location of the neo4j server.
knowledge-graph.neo4j.passwordSpecifies the password to use when connecting to the neo4j server. longDesc The neo4j server that is included with Funnelback will set the password to match the _svc_knowledge_graph user's password which is based on the server secret. If the server secret is changed neo4j must be restarted for the change to take affect.
knowledge-graph.neo4j.usernameSpecifies the user name to use when connecting to the neo4j server.
knowledge-graph.server.labelSpecifies a label which is unique to the server.
mail.smtp.authSpecify if the mail server requires authentication.
mail.smtp.hostSpecify the hostname of the mail server to use.
mail.smtp.passwordSpecify a password when authenticating with the mail server.
mail.smtp.portSpecify the port of the mail server.
mail.smtp.userSpecify a username when authenticating with the mail server.
push.worker-thread-countSpecify the maximum number of worker threads push should use.
redis.master.hostSpecify the host the redis server is running on.
redis.master.portSpecify the port redis is listening on.
server.cpu_countSpecify CPU count of the server.
server_secretSpecifies the secret used for protecting various internal and external endpoints.
task.default-priority.add-urls-to-live-viewDefines the default priority for ADD_URLS_TO_LIVE_VIEW tasks in the task queue API.
task.default-priority.full-updateDefines the default priority for FULL_UPDATE tasks in the task queue API.
task.default-priority.incremental-updateDefines the default priority for INCREMENTAL_UPDATE tasks in the task queue API.
task.default-priority.instant-updateDefines the default priority for INSTANT_UPDATE tasks in the task queue API.
task.default-priority.knowledge-graphDefines the default priority for UPDATE_KNOWLEDGE_GRAPH tasks in the task queue API.
task.default-priority.normal-updateDefines the default priority for NORMAL_UPDATE tasks in the task queue API.
task.default-priority.re-apply-gscopes-to-live-viewDefines the default priority for REAPPLY_GSCOPES_TO_LIVE_INDEX tasks in the task queue API.
task.default-priority.re-index-live-viewDefines the default priority for REBUILD_LIVE_INDEX tasks in the task queue API.
task.default-priority.refresh-updateDefines the default priority for REFRESH_UPDATE tasks in the task queue API.
task.default-priority.remove-urls-by-prefix-from-live-viewDefines the default priority for REMOVE_URLS_BY_PREFIX_FROM_LIVE_VIEW tasks in the task queue API.
task.default-priority.remove-urls-from-live-viewDefines the default priority for REMOVE_URLS_FROM_LIVE_VIEW tasks in the task queue API.
task.default-priority.restart-full-update-from-crawler-checkpointDefines the default priority for RESTART_FULL_UPDATE_FROM_CRAWLER_CHECKPOINT tasks in the task queue API.
task.default-priority.restart-gatherDefines the default priority for RESTART_GATHER tasks in the task queue API.
task.default-priority.restart-incremental-update-from-crawler-checkpointDefines the default priority for RESTART_INCREMENTAL_UPDATE_FROM_CRAWLER_CHECKPOINT tasks in the task queue API.
task.default-priority.restart-update-from-index-phaseDefines the default priority for RESTART_UPDATE_FROM_INDEX_PHASE tasks in the task queue API.
task.default-priority.restart-update-swap-views-forcing-swapDefines the default priority for RESTART_UPDATE_FROM_SWAP_VIEWS_FORCING_SWAP tasks in the task queue API.
task.default-priority.update-analyticsDefines the default priority for REMOVE_URLS_FROM_LIVE_VIEW tasks in the task queue API.
task.task-picker-classSpecify the name of the class that will be used to pick tasks off the queue to be run.
urls.admin_hostnameHostname used to access the admin UI.
urls.admin_portPort which should be used to access the admin UI.
urls.admin_protocolProtocol for the Admin UI, usually HTTPS
urls.search_hostnameHostname used to access the search endpoint.
urls.search_portPort which should be used to access the search endpoint.
urls.search_protocolProtocol of the preferred search end point, usually http.

top

Funnelback logo
v15.20.0