Allows specifying profile and collection level configuration keys which are only to be respected when running under particular a environment. Keys that are only respected under a particular environment are called 'environment keys'. This is useful as multiple servers can share a single configuration file while reading different settings from that file. For example a 'development' server could be configured to run crawls for 5 minutes, while a 'production' server could be configured to run crawls for 5 hours.
This setting configures which environment the server is to use.
Environment keys are always picked in preference to non environment keys.
Keys that are defined in
$SEARCH_HOME/conf/collection.cfg can be overwritten
in the collection level configuration file
However if a environment key is defined in
$SEARCH_HOME/conf/collection.cfg it can not be
overwritten by a non environment key. It can only be overwritten by an environment key in the
Environment keys can be set in the configuration editor UI. To access the configuration editor UI,
go to the Administration home page, and then under the
Administer tab, select either
Edit Collection Configuration or
Edit Profile Configuration. When editing a configuration key,
you can select an existing environment or create a new one from the dropdown menu in order to
set an environment specific configuration value.
Environment keys are in the form:
for example to display Freemarker errors under the
dev environment but not the
prod environment we could have:
Set this configuration key in the server configuration.
Use the configuration key editor to add or edit the
environment-name key, and set the value. This can be set to any valid
To set the environment to 'dev' and have keys prefixed with
env.dev. be picked in preference to
non environment keys:
foo=a1 env.prod.foo=a2 env.dev.bar=b1 plop=c0
Then that configuration would be read as:
foo=a0 bar=b1 plop=c0
The following configuration options do not completely support configuration environments: