Configuration Reference

1. Configuration

Most of the CleanSpeak configuration is performed in the Management Interface. However some configuration is provided through a configuration file. You may modify this file in order to change your configuration, CleanSpeak will need to be restarted to pick up changes to this configuration. Assuming you installed in the default locations, the configuration file may be found in the following directory. If you have installed in an alternate location the path to this file will be different.

Linux and Mac OS X
/usr/local/inversoft/config/cleanspeak.properties
Windows
C:\inversoft\config\cleanspeak.properties

This table contains all of the configuration options available in the cleanspeak.properties file.

Table 1. Properties

license.id [String]

Your License ID. You can find your License ID by logging into your account at https://www.inversoft.com/account/.

database.url [String]

A JDBC URL for your database.

For MySQL, this URL will look something like this:

database.url=jdbc:mysql://localhost:3306/cleanspeak

For PostgreSQL, this URL will look something like this:

database.url=jdbc:postgresql://localhost:5432/cleanspeak

database.username [String]

The username used to connect to the database.

database.password String

The password used to connect to the database.

database.mysql.enforce-utf8mb4 [String] defaults to true

When set to true and using MySQL, full 4 byte unique configuration is enforced at startup.

If this validation is not desired or not it is not possible to modify your MySQL configuration so satisfy the validation, disable this check by setting this value to false.

email.host [String] Required Deprecated

The hostname of your SMTP server. Starting in version 3.4.0 email server configuration has moved to the Management Interface.

email.port [Integer] Required Deprecated

The SMTP port. By default SMTP servers use port 25, 587 for SSL(TLS) connections and less commonly port 465 (SSL). Starting in version 3.4.0 email server configuration has moved to the Management Interface.

email.ssl [Boolean] Required Deprecated

Set to true to enable an SSL connection to the SMTP server. Starting in version 3.4.0 email server configuration has moved to the Management Interface.

email.username [String] Required Deprecated

The username used to connect to your email server. Starting in version 3.4.0 email server configuration has moved to the Management Interface.

email.password [String] Optional Deprecated

The password used to connect to your email server. Starting in version 3.4.0 email server configuration has moved to the Management Interface.

email.from [String] Required Deprecated

The email address used as in the from field when CleanSpeak sends emails. Starting in version 3.4.0 email server configuration has moved to the Management Interface.

cleanspeak-management-interface.management-port [Integer]

The port number that CleanSpeak Management Interface will use for internal Tomcat administration.

cleanspeak-management-interface.http-port [Integer]

The port number that CleanSpeak Management Interface will use to accept HTTP requests.

cleanspeak-management-interface.https-port [Integer]

The port number that CleanSpeak Management Interface will use to accept HTTPS requests.

cleanspeak-management-interface.memory [String]

The amount of memory to allocate dedicate to Java VM where this service will run. Use the M or G suffix to denote megabytes and gigabytes respectively.

For example, 512M will allocate 512 Megabytes to the Java VM and 1G will allocate 1 gigabyte. This value must be an integer, for example use 1536M to allocate 1.5 gigabytes.

cleanspeak-management-interface.additional-java-args [String]

Any additional arguments that you want to pass to the Java VM where this service will run.

cleanspeak-search-engine.transport-port [Integer]

The port that the search engine will use for optimized TCP communications instead of HTTP communications.

cleanspeak-search-engine.http-port [Integer]

The port number that the Search Engine will use to accept HTTP requests.

cleanspeak-search-engine.memory [String]

The amount of memory to allocate dedicate to Java VM where this service will run. Use the M or G suffix to denote megabytes and gigabytes respectively.

For example, 512M will allocate 512 Megabytes to the Java VM and 1G will allocate 1 gigabyte. This value must be an integer, for example use 1536M to allocate 1.5 gigabytes.

cleanspeak-search-engine.hosts [String] defaults to _local_

This parameter indicates which address or network interfaces to bind during service startup. The default value will cause the service to bind any loopback address on the system such as 127.0.0.1.

This default value is sufficient for running CleanSpeak Webservice, CleanSpeak Management Interface, and the Search Engine on the same server. If you run the Search Engine on a separate system than Cleanspeak Management Interface or CleanSpeak Webservice you will need to modify this value. You may specify a single hostname or IP address or one of the special values in any combination.

Special values include:

  • _[networkInterface]_ - Addresses of a network interface, for example _en0_

  • _local_ - Any loopback address on the system, for example 127.0.0.1

  • _site_ - Any site-local addresses on the system, for example 192.168.0.1.

  • _global_ - Any globally-scoped addresses on the system, for example 8.8.8.8.

The following is an example to bind to localhost as well as any site local addresses on the system such at 192.168.1.42.

cleanspeak-search-engine.hosts=_local_,_site_

cleanspeak-search-engine.servers [String]

A comma separated list of stand-alone search engine servers that will be used by CleanSpeak.

The following is an example of a configuration for two separate search engines, one running on localhost and the other is on remote system.

cleanspeak-search-engine.servers=localhost:8020,search2.example.com:8020

cleanspeak-search-engine.data-directory [String]

The location on disk where CleanSpeak Search Engine will store its data. This value is defaulted if not specified and generally should not be modified.

cleanspeak-search-engine.additional-java-args [String]

Any additional arguments that you want to pass to the Java VM where this service will run.

cleanspeak-webservice.management-port [Integer]

The port number that CleanSpeak Webservice will use for internal Tomcat administration.

cleanspeak-webservice.http-port [Integer]

The port number that CleanSpeak Webservice will use to accept HTTP requests.

cleanspeak-webservice.https-port [Integer]

The port number that CleanSpeak Webservice will use to accept HTTPS requests.

cleanspeak-webservice.urls [String]

A comma separated list of CleanSpeak Webservice instances.

The following is an example of a single webservice running on localhost.

cleanspeak-webservice.urls=http://localhost:8001

cleanspeak-webservice.memory [String]

The amount of memory to allocate dedicate to Java VM where this service will run. Use the M or G suffix to denote megabytes and gigabytes respectively.

For example, 512M will allocate 512 Megabytes to the Java VM and 1G will allocate 1 gigabyte. This value must be an integer, for example use 1536M to allocate 1.5 gigabytes.

cleanspeak-webservice.additional-java-args [String]

Any additional arguments that you want to pass to the Java VM where this service will run.