The following section describes the TrackStudio configuration files.
DescriptionTrackStudio look for configuration files in the following order:
- WEB-INF subdirectory in TrackStudio.war. Use the jar utility (supplied with JRE) to pack and unpack TrackStudio.war.
- If the TrackStudio home directory is explicitly specified by setting the trackstudio.Home property (case sensitive) using the -D option in the java command line, the files are read relative to this directory:
> java -Dtrackstudio.Home=c:/trackstudio <options and parameters>
- path specified in TS_CONFIG environment variable:
> set TS_CONFIG=c:/trackstudio > java <options and parameters>
When you start TrackStudio, the following property files are loaded at startup:
|
File |
Server Manager tab |
Description |
|
trackstudio.properties |
General |
A main configuration file. |
|
trackstudio.hibernate.properties |
Database |
Database connection configuration file. |
|
trackstudio.mail.properties |
E-mail |
E-mail notification and e-mail submission configuration file. |
|
trackstudio.security.properties |
Security |
LDAP & NTLM properties and security policy configuration. |
|
trackstudio.scm.properties |
SCM |
Source Code Management systems integration. |
|
trackstudio.log4j.properties |
N/A |
Debug logging properties. |
|
trackstudio.license.properties |
N/A |
TrackStudio license file. Do not modify this file. |
|
trackstudio.adapters.properties |
N/A |
TrackStudio adapters configuration. Do not modify this file. |
You should restart TrackStudio after configuration files modification.
trackstudio.properties
|
Property |
Server Manager (General tab) |
Description |
Example |
|
trackstudio.siteURL |
HTTP port HTTPS port Host |
URL of your site. TrackStudio uses this URL to generate links (in e-mail notification messages, for example). |
http://www.mycompany.com:8080/TrackStudio |
|
trackstudio.logoutURL |
N/A |
Logout URL. The specified URL to load upon logout. If empty, goes to login screen. |
http://localhost:8888/TrackStudio |
|
trackstudio.uploadDir |
Upload directory |
Upload directory. Should exist and be accessible. We suggest you use the absolute (not relative) path here. |
/mnt/upload c:/TrackStudio/upload |
|
trackstudio.indexDir |
Index directory |
Full text search index directory. Should exist and be accessible. We suggest you use the absolute (not relative) path here. |
/mnt/index c:/TrackStudio/index |
|
trackstudio.encoding |
Character encoding |
Character encoding. Should match the codepage of the database. |
UTF-8 |
|
java.protocol.handler.pkgs |
N/A |
Handler for SSL protocol. |
com.sun.net.ssl.internal.www.protocol |
|
trackstudio.cluster |
Cluster node |
TrackStudio cluster support. |
yes no |
|
trackstudio.cluster.name |
Cluster name |
TrackStudio cluster name. |
MyCluster |
|
trackstudio.cluster.bind |
Specify network interface (checkbox) |
Mark to bind cluster node to specific network interface. |
yes no |
|
trackstudio.cluster.bindTo |
Specify network interface (dropdown) |
TrackStudio cluster node IP address. |
192.168.1.100 |
|
trackstudio.soap |
Enable SOAP |
Allowed to use SOAP interface. Enable to use SCM and IDE integration. |
yes |
|
trackstudio.maxUploadSize |
Max upload file size |
Max size for uploaded files. |
52428800 |
|
trackstudio.skinPath |
N/A |
Skin path. |
/skins/defaultSkin |
|
trackstudio.defaultLocale |
Default locale |
Default locale. Used before user is logged in (Login/Registration/Forgot password pages). |
en |
|
trackstudio.script |
N/A |
Import packages for scripts. |
java.lang.Boolean |
|
trackstudio.maxDescriptionLength |
N/A |
Maximum task/message description length. |
60000 |
|
trackstudio.startupDelay |
N/A |
Startup delay in seconds. Used to wait for DBMS startup. |
0 |
|
trackstudio.gzipHTTP |
Compress HTTP content |
Compress HTTP content. |
yes no |
trackstudio.hibernate.properties
|
Property |
Server Manager (Database tab) |
Description |
Example |
|
hibernate.dialect |
Select DBMS |
SQL dialect. |
org.hibernate.dialect.HSQLDialect |
|
hibernate.connection.url |
URL |
JDBC connection URL. |
jdbc:hsqldb:file:test;shutdown=true |
|
hibernate.connection.driver_class |
JDBC driver |
JDBC driver class. |
org.hsqldb.jdbcDriver |
|
hibernate.connection.username |
Login |
Database user. |
sa |
|
hibernate.connection.password |
Password |
Database user password. |
|
trackstudio.mail.properties
|
Property |
Server Manager (E-mail tab) |
Description |
Example |
|
trackstudio.sendMail |
Enable e-mail notification |
Enable e-mail notification. |
yes no |
|
mail.transport.protocol |
Protocol |
Mail transport protocol. Should be smtp. |
smtp |
|
mail.smtp.host |
SMTP server |
The SMTP server to connect to. |
127.0.0.1 |
|
mail.smtp.port |
SMTP port |
The SMTP port to connect to. |
|
|
mail.from |
TrackStudio e-mail |
This sets the envelope From address. |
trackstudio@127.0.0.1 |
|
mail.smtp.user |
SMTP server login |
SMTP user. Required only if SMTP server requires authentication. |
|
|
mail.smtp.password |
SMTP server password |
SMTP password. Required only if SMTP server requires authentication. |
|
|
mail.smtp.timeout |
N/A |
Socket I/O timeout value in milliseconds. Default is infinite timeout. |
10000 |
|
mail.smtp.connectiontimeout |
N/A |
Socket connection timeout value in milliseconds. Default is infinite timeout. |
10000 |
|
trackstudio.FormMailNotification |
Enable e-mail submission |
Enable e-mail submission. Enable this option with trackstudio.sendMail yes only. |
no |
|
mail.store.protocol |
Protocol |
Protocol. |
pop3 imap |
|
mail.store.host |
Mail server |
POP3/IMAP host. |
127.0.0.1 |
|
mail.store.port |
Mail port |
POP3/IMAP port. |
|
|
mail.store.user |
Login |
Check this mailbox for e-mail submission messages. |
trackstudio@127.0.0.1 |
|
mail.store.password |
Password |
Mail server password. |
ChangeMe |
|
mail.store.forward |
Delete/forward unprocessed e-mails |
Delete or forward any invalid e-mail submission messages. |
yes no |
|
mail.store.fwdaddress |
Forward unprocessed e-mails to |
Forward e-mail address (when mail.store.forward yes). |
admin@mycompany.com |
|
mail.debug |
N/A |
SMTP/POP3/IMAP debug logs. |
true false |
trackstudio.security.properties
|
Property |
Server Manager (Security tab) |
Description |
Example |
|
trackstudio.security.password.min |
Minimum password length |
Minimum password length. |
0 |
|
trackstudio.security.password.maxage |
Maximum password age (days) |
Maximum password age in days. 0 means "unlimited". |
0 |
|
trackstudio.security.password.complex |
Password must meet complexity requirements |
Enforce password complexity requirements to prevent dictionary attack. |
0 |
|
trackstudio.security.password.history |
Enforce password history |
Amount of remembered passwords to prevent password reuse by users. 0 means "don't check", maximum value - 8. |
0 |
|
trackstudio.security.password.changefirst |
User must change password at first login |
User must change password at first login. |
yes no |
|
trackstudio.security.password.case |
Use case insensitive account names |
Use case insensitive account names (logins). |
yes no |
|
trackstudio.loginAsAnotherUser |
Enable logon as another user |
Allowed login as another user. To login as subordinate user, use their name and your password. |
yes no |
|
trackstudio.hideSessionId |
Hide session ID from URL |
Set to store the session ID in the cookie. |
yes no |
|
trackstudio.useNTLM |
Use NTLM Authorization |
Use NTLM Authorization. |
yes no |
|
jcifs.netbios.wins |
WINS server address |
WINS server address for name resolution. |
127.0.0.1 |
|
jcifs.smb.client.domain |
Domain name |
Domain name. |
WORKGROUP |
|
trackstudio.useLDAP |
Use LDAP authorization |
Specifies whether the authorization on the LDAP server is used. If the parameter is set to yes, the user authorization on the LDAP server will be performed alongside the usual authorization in the TrackStudio system. |
yes no |
|
ldap.host |
Server host |
Specifies the LDAP server address. |
192.168.22.10 |
|
ldap.port |
Server port |
Specifies the server port. |
389 |
|
ldap.baseDN |
Base DN |
Specifies the base DN. TrackStudio uses the specified DN for user authentication. |
cn=users,dc=ldap-server, dc=my-company,dc=com |
|
ldap.userDN |
User DN |
Specifies the user DN, which is connected to the LDAP server. Objects (users, groups, and computers) in the LDAP directory are referred to by the cn attribute - the Common Name. Containers, which may contain many objects, are also referred to by the cn attribute. LDAP supports special containers - Organizational Units and Domain Components. Part of the binding string composed of Domain Component elements is the DNS domain name. For example, the cn=TrackStudio user above is in the cn=users container, which is in the dc=ldap-server,dc=my-company,dc=com DNS domain (sometimes referred to as ldap-server.my-company.com). |
cn=TrackStudio,cn=users, dc=ldap-server,dc=my-company, dc=com |
|
ldap.userDNpass |
User DN password |
Specifies the password for the user detailed in ldap.userDN. |
|
|
ldap.loginAttrTS |
Authorize by TrackStudio properties |
Specifies which user parameters are used for authorization on the server. |
name login |
|
ldap.loginAttrLDAP |
Authorize by LDAP properties |
Specifies the property which should be used to search for the user on the LDAP server. For example, if the ldap.loginAttrLDAP is cn, the common name is used to search for the user. |
displayName sAMAccountName |
trackstudio.scm.properties
|
Property |
Server Manager (SCM tab) |
Description |
Example |
|
trackstudio.scm.useSCM |
Enable SCM integration |
|
yes no |
|
trackstudio.scm.updateInterval |
Update interval (minutes) |
Update interval (minutes) |
10 |
|
trackstudio.scm.<name>.type |
Type |
SCM type |
Subversion CVS |
|
trackstudio.scm.<name>.tasknum |
# |
Task number. SCM integration will be available for subtasks of the specified task. |
2 5 |
|
trackstudio.scm.<name>.root |
Root |
SCM root |
http\://svn.mycompany.com/prj/MyProject/Application/trunk/ |
|
trackstudio.scm.<name>.login |
Login |
Login |
|
|
trackstudio.scm.<name>.password |
Password |
Password |
|
|
trackstudio.scm.<name>.module |
Module |
Module (CVS only) |
project |
|
trackstudio.scm.<name>.encoding |
Character encoding |
Character encoding (CVS only) |
UTF-8 |
Topic path: Installation Guide > TrackStudio Configuration Properties