TermWeb configuration (termweb.properties)
- Aleksei Melnikov
Most of the settings are applied via termweb.properties file which is located in TermWeb home folder.
Key | Values | Comment |
|---|---|---|
Minimal required settings | ||
| Absolute path to TermWeb home folder | Command-line argument. Must be specified in Java options of running process (Tomcat) via key -Dtermweb.home=/opt/twhome. See TermWeb 4 install on Windows |
| https://example.termweb.eu | In case of scheduled jobs, like sending mail digest server need to know which URL to use for current installation |
|
| Database driver. Right now supported only MySQL |
| DB user name, empty by default | Database user for connection |
| DB user password, empty by default | Database user’s password for connection |
|
| JDBC URL for DB connection, don’t delete any of additional connection parameters |
|
| Elasticsearch index name prefix used for indices created by TermWeb, see limitations on name: ES Create index API |
|
| IP address or host name of Elasticsearch server |
|
| Elasticsearch server port for connection |
|
|
|
|
|
|
| SMTP user name, empty by default |
|
| SMTP user password, empty by default |
|
System settings | ||
|
| The session timeout in seconds. This value determines how long a user can be logged on to TermWeb before she is logged out due to inactivity. A negative value indicates that the sessions should never expire. A value of 0 (zero) uses the servlet engine's default value, or the value specified in web.xml for TermWeb, e.g. <session-config>
<session-timeout>30</session-timeout>
</session-config>Note that the web.xml timeout value is specified in minutes. |
| since 4.0.7 Time in seconds for how long recovery password token will be valid. | |
|
| Disables the auto-login functionality of the guest account. |
|
| Applies normalisation of text values in filter criteria and term sorting in term list, in order to support double-byte search. |
|
| NOT implemented in tw4 Removes the link (and corresponding text) for links that point to content which the user can not access. If false, a message will be displayed when the user clicks a non-accessible link. |
API settings | ||
|
| Specifies if TermWeb and XML-RPC sessions can work simultaneously for the same user. |
|
| Set the language code to ISO2 (639-1) for the API |
|
| Indication whether automatically created users will be client admins or single users |
|
| since 4.0.8-3 Automatically create user record in the system after successful SSO | API login. |
|
| since 4.0.8-3 Try to login as guest user after successful SSO | API authentication. If guest user is disabled login won’t work. |
| Empty by default | The name of the default group where automatically created single users will belong. |
|
| Option to update an existing concept instead of creating a new one when create concept method is called via the API. Specifically, when calling createFromJSON in concept endpoint, a check is being made if at least one of the concept's terms already exist in the database, in the section the concept is supposed to be added. If it exists, then the concept gets updated instead of creating a new one. Used to avoid concept/term duplicates when adding new terms via the API. |
|
| When using web services to get a decoration for a segment, there is a limit to how many terms are included in each term search. A quick test would be to write the first word of the term you wish to see in the decoration in TermWeb search and see in the term list if the term you wish to see appears in the first page of the list. If not you need to increase this limit to make it appear. |
|
| The limit of characters where a word should be considered as a stem during decoration. |
|
| The margin of characters allowed to be different at the end of a stem during stem comparison in decoration. |
|
| Default stemmer for German language. Default value is: "org.apache.lucene.analysis.de.GermanLightStemFilterFactory" |
|
| since 4.0.8 By default TermWeb term decoration function skips from results terms containing next punctuation symbols: |
|
| Handles hashtag terms as normal terms. Includes them in decoration for segments that contain or not, the hashtag. |
|
| Handles some tags as spaces. (ph, t). This is an unstable feature. Not recommended for use |
File operations settings | ||
|
| The maximum size for import file uploads in Kb. Limited by server value for file upload. |
|
| The maximum size for attachment uploads in Kb. Limited by server value for file upload. |
|
| Escape caret symbol in import/export (it will remove circumflex char |
Mailing settings | ||
|
| The character set to be used for all mail. |
|
|
|
|
| The address of the sender |
| Size in Kilobytes | The maximum size for email attachments in Kb. Note that the SMTP server may be configured to use a lower max size, and emails may bounce if attachments |
| empty by default | The address of technical support to which application errors should be mailed. If omitted no mails will be sent. |
|
| Number of tries to send mail |
|
| since 4.0.6-3 If |
|
| since 4.0.6-3 If |
Security settings | ||
|
| Specifies if TermWeb is allowed to run in an iframe on another page. Required by XTM integration to be enabled. |
|
| List of allowed frame ancestors to use TermWeb in iframe. |
| since 4.0.7 Default cost factor for password hashing with bcrypt. Be careful changing this value after installation invalidate all existing user passwords. | |
| since 4.0.7 Enables scanning for viruses of files uploaded to File repository | |
|
| since 4.0.7 Name of anit-virus settings to use. |
|
| since 4.0.7 Server ip address or host name where clamd is running. |
|
| since 4.0.7 Port number on which clamd listening. |
|
| since 4.0.7 Read timeout value in milliseconds for clamd connection. In case of often “Read timeout” errors you may increase this value. Usually it depends on uploaded file sizes, connection speed between servers and amount of files to scan. |
| since 4.0.7 Maximum failed login attempts before locking user account. | |
|
| since 4.0.7 Time in minutes for how long user account will be locked after unsuccessful login. |
|
| since 4.0.7 Maximum failed login attempts to different users before blocking ip address. |
|
| since 4.0.7 Time in minutes for how long ip address will be blocked after multiple unsuccessful login attempts. |
| since 4.0.9 Enable or disable normal login (by password) for external users (created via SSO login, LDAP) | |
empty by default | since 4.0.9 When value is set TermWeb will include You may specify multiple values like this: See Clear-Site-Data - HTTP | MDN for actual information. | |
OpenId Connect SSO login settings | ||
|
|
|
| empty by default | Identity Provider (IdP) URL (e.g. |
| empty by default | Client identifier for TermWeb installation used by IdP (this value usually provided from IdP, it can be anything: name, TermWeb url, some generated id) |
| empty by default | Client secret for connection with IdP. |
|
|
|
|
|
|
| empty by default | <authentication endpoint> added to the end of |
| empty by default | <token endpoint> subpath added to the end of |
| empty by default | <user details endpoint> full URL or subpath added to the end of |
|
| List of all data requested by TermWeb from IdP about user. |
| empty by default | Field from user data to identify TermWeb’s Client for logging user. Can be skipped when default client is configured. For example: |
| empty by default | Specify Client login name when it can't be retrieved from user details. |
| empty by default | Field to identify user, stored as username in TermWeb. E.g. |
|
|
|
|
| Authenticate user as guest when there is no TermWeb’s user related to OpenId profile. |
| since 4.0.9-0 Add user to TermWeb’s group based on user details property. {\
"employeeType": {\
"Independent": "TermWeb External",\
"Supplier": "TermWeb External",\
"Consultant": "TermWeb External"\
},\
"userGroup": {\
"Translators": "TermWeb Translators",\
"Users": "Termweb Regular user"\
}\
}
| |
Other settings | ||
| Integer number, | Maximum page size allowed by REST API which can be requested by user. Bigger values will be changed automatically to this value. |
Integer number, | since 4.0.8-15 Timeout in milliseconds until a connection is established for ElasticSearch client. A timeout value of zero is interpreted as an infinite timeout. A timeout value of zero is interpreted as an infinite timeout. A negative value is interpreted as undefined (system default). | |
| Integer number, | since 4.0.8-15 Socket timeout in milliseconds for ElasticSearch client, which is the timeout for waiting for data or, put differently, a maximum period inactivity between two consecutive data packets). A timeout value of zero is interpreted as an infinite timeout. A negative value is interpreted as undefined (system default). |
| Integer number, | since 4.0.8-15 Timeout in seconds of reindex request for search service. Period each indexing waits for the following operations:
Defaults to 5m (five minutes). This guarantees Elasticsearch waits for at least the timeout before failing. The actual wait time could be longer, particularly when multiple waits occur. |
|
| Stops TermWeb from printing full version string and build date. When |
|
| deprecated When is set to |
|
| deprecated Used with ES autostart, path to ES installation folder (will be deleted in 4.1.0). |
|
| deprecated Used with ES autostart, passes argument |
|
| deprecated Used with ES autostart, Time to wait for ES instance to start and stop in seconds (will be deleted in 4.1.0). |
|
| obsolete used in previous versions when ES client required it |