Configuration Files

This section describes TrackStudio configuration files.

Installation

Description

When you start a TrackStudio, following property files are loaded at startup:

trackstudio.properties, a general-purpose configuration file
trackstudio.hibernate.properties, database configuration file
trackstudio.mail.properties, e-mail configuration file
trackstudio.ldap.properties, LDAP configuration file
trackstudio.license.properties, license configuration file, you should not modify it
trackstudio.adapters.properties, adapters configuration file, you should not modify it when you install TrackStudio Enterprise.

These files are read using the following rules:

If the TrackStudio home directory is explicitly specified by setting the trackstudio.Home property using the -D option, the files are read relative to this directory
Otherwise, the files are read relative to WEB-INF directory

1. Configure database connection parameters (trackstudio.hibernate.properties)

hibernate.dialect cirrus.hibernate.sql.HSQLDialect
hibernate.connection.url jdbc:hsqldb:hsql://localhost
hibernate.connection.driver_class org.hsqldb.jdbcDriver
hibernate.connection.username sa
hibernate.connection.password

2. Configure general TrackStudio parameters (trackstudio.properties)

#######################
# TrackStudio options #
#######################

# URL of your site. Host name and port should be correct.
# We use this address in e-mail notification messages.

trackstudio.siteURL http://localhost:8888/TrackStudio


# Logout URL for your site.

#trackstudio.logoutURL http://localhost:8888/TrackStudio


# Upload directory. Should exists and be accessible
# We suggest you use the absolute (not relative) path here
# For example, /mnt/upload or c:\\TrackStudio\\upload

trackstudio.uploadDir upload


# Full text search index directory. Should exists and be accessible
# We suggest you use the absolute (not relative) path here
# For example, /mnt/upload or c:\\TrackStudio\\upload

trackstudio.indexDir index

# Set yes to log debug information

trackstudio.debug no


# Set character encoding, such as Windows-1252 or UTF-8

trackstudio.encoding UTF-8


# Handler for SSL protocol

java.protocol.handler.pkgs com.sun.net.ssl.internal.www.protocol


# TrackStudio cluster support

trackstudio.cluster no


# TrackStudio cluster name

trackstudio.cluster.name MyCluster


# Allowed to use SOAP interface

trackstudio.soap yes

3. Configure email notification and email submission properties (trackstudio.mail.properties)

###############################
# E-Mail notification options #
###############################

# Enable email notification, yes/no

trackstudio.sendMail no


## Mail transport protocol. Should be smtp

mail.transport.protocol smtp


## SMTP server

mail.smtp.host mail.mycompany.com

## SMTP port

mail.smtp.port

## Send email notifications from this address

mail.from trackstudio@mycompany.com


## SMTP user. Required only if SMTP server requires authentication

mail.smtp.user


## SMTP password. Required only if SMTP server requires authentication

mail.smtp.password


## Connection timeout properties

mail.smtp.timeout 10000
mail.smtp.connectiontimeout 10000


#############################
# E-Mail submission options #
#############################

# Enable e-mail submission, yes/no.
# Please note, that this option requires email notification

trackstudio.FormMailNotification no


## Protocol. Should be pop3

mail.store.protocol pop3


## POP3 host

mail.pop3.host mail.mycompany.com

## POP3 port

mail.pop3.port


## Check this mailbox for email submission messages

mail.pop3.user trackstudio


## POP3 server password

mail.pop3.password pass


## Delete or forward bad messages

mail.pop3.forward no


## Forward e-mail address

mail.pop3.fwdaddress

#############################
# Other options             #
#############################

mail.debug false

4. Configure LDAP authorization properties (trackstudio.ldap.properties)

##############################
# LDAP configuration options #
##############################

# Use LDAP authorization, yes/no

trackstudio.useLDAP no


# LDAP server host

ldap.host ldap-server.my-company.com


# LDAP server port (defaul is 389)

#ldap.port 389


# LDAP Base DN

ldap.baseDN cn=users,dc=ldap-server,dc=my-company,dc=com


# LDAP User DN. Use empty for anonymous authorize.

ldap.userDN cn=TrackStudio,cn=users,dc=ldap-server,dc=my-company,dc=com


# LDAP User DN password

ldap.userDNpass pass


# Authorize by name or login of TrackStudio user properties?

ldap.loginAttrTS login


# Authorize by cn (common name / Windows account name),
# sAMAccountName (Windows user logon
# name) or other of LDAP user properties?

ldap.loginAttrLDAP sAMAccountName

You are here: Installation > Configuration Files

Contents | Index