Configuration
Config files
The following configuration files are processed by map.apps Smart Search Extension:
-
WEB-INF/classes/default-application.properties
(DO NOT EDIT)
This file contains all configuration options of map.apps Smart Search Extension: with their default values. -
WEB-INF/classes/custom-application.properties
If you change the working directorydata.directory.location
, you must adjust this file. All other adjustments are made in the following file. -
[data.directory.location]/application.properties
Editing this file is the recommended way to make configuration changes.
By default,${user.home}/.smartfinder
is the working directorydata.directory.location
of smart.finder. Theapplication.properties
is not created automatically. You can use theWEB-INF/classes/application.properties
file as a template. It is recommended to leave only the settings in the file that have been changed.
The format of the configuration files must correspond to the Java Properties file format .
# The files must be UTF-8 encoded, otherwise umlauts can cause errors!
# The safest way is to encode umlauts in Unicode syntax e.g: รค = \u00E4 (vgl. http://0xcc.net/jsescape/)
# Comments are preceded by a hash
# Common syntax:
key = value
# A value can reference another key
key1 = http://${key.with.server}/test
After changing one of the configuration files a restart of the web application or alternatively the entire Tomcat server is required. |
Configuration parameters
This section describes the parameters that most often need to be changed in a default installation.
Other parameters are described in comments in the WEB-INF/classes/default-application.properties
file.
Both the client and the server have these configuration files.
The following list does not distinguish between them.
Stick to the respective default-application.properties file to change the parameters for the respective web application.
|
data.directory.location
-
Working directory where map.apps data (e.g. an HSQL database) is stored locally.
In case the Tomcat server is run as a Windows service, the
.smartfinder
directory is located in the user directory of the Tomcat user who started the service. Path separators must be specified as either/
or\\
.Default:
data.directory.location=$\{user.home\}/.smartfinder
finder.service.url
-
Context name of the smart.finder server.
If the name was changed during the installation of the smart.finder Server, the current name must be entered here.
Default:
/smartfinder-search
solr.solr.home
-
Directory path to
solr.home
.The path can be specified absolute or relative. You can also use placeholders that are resolved by the Web Container.
Example:
solr.solr.home = ${catalina.base}/webapps/smartfinder-server/WEB-INF/solr.home
solr.default.core.name
-
The standard index of the server.
This index is used if no other index is specified during job creation in the job manager.
Default:
core0
Security
security.mode
-
Protection mode of the smart.finder administrative area.
Access to the administrative areas of the smart.finder can be protected if required. To do this, the value of this parameter must be set to
INTEGRATED
(otherwise:NONE
).
The modeONLY_AUTHN
can only be used in conjunction with security.manager Enterprise Edition.Allowed values:
INTEGRATED
,NONE
,ONLY_AUTHN
Default:INTEGRATED
If
INTEGRATED
was selected, the mode can be specified in more detail using the following parameter set:security.user.admin.name
-
Username in plain text.
security.user.admin.pw
-
Password of the user.
This must be described according to the selected encoding.
security.user.pwenc
-
Encoding of the password.
This can be
plain
(no coding) or by means ofMD5
(Message-Digest Algorithm 5) orSHA-1
(secure hash algorithm). Some web services support the generation of encrypted passwords.Allowed Values:
plain
,MD5
,SHA-1
security.user.use_mapped_pass
-
Specifies whether a password encoding other than
plain
has been selected.Allowed Values:
true
,false
security.ssl.trustAny
-
Specifies whether self-signed certificates are supported for HTTPS connections.
Allowed Values:
true
,false
Default:false
Mailing
mailing.host
-
Hostname on which an SMTP server is available for sending e-mails.
mailing.port
-
SMTP port on the SMTP host computer.
mailing.username
-
Username for the SMTP server.
mailing.password
-
Password for the SMTP server.
mailing.senderaddress
-
Reply address for e-mail dispatch.
mailing.locale
-
Language setting for sending e-mails.
Allowed Values:
de
,en
Logging
The following configuration parameters are available to adjust logging settings:
logging.logger.level
-
Level of detail of the log.
Allowed Values:
TRACE
,DEBUG
,INFO
,WARN
,ERROR
Default:INFO
logging.output.location
-
Deprecated since 2.0.8Use logging.file.location instead.
logging.file.location
-
Location where the log file is stored.
The default value corresponds to the
logs
directory of Tomcat. With the value${data.directory.location}/logs
the log file is created in the working directory of smart.finder.Default:
${catalina.base}/logs
logging.file.prefix
-
This parameter defines the name of the log files.
To prefix log files with the URL context path of the smart.finder installation (for example
smartfinder
), use the value${webcontext.name}
.Default:
ct-smartfinder
Additional logging options are described in the |
Changing the location of the index
In the standard delivery, the indexes of smart.finder are stored under the following path:
%TOMCAT%\webapps\ct-finder-server-webapp-[VERSION]\WEB-INF\solr.home
The indexes of the individual cores are stored in the subdirectories located here.
To change the location of the indexes you have to change the value of the variable solr.solr.home
in the file application.properties
.
solr.solr.home=[absolute path]
After a restart, the indexes are stored in this directory.