The general.properties file contains settings you must configure for WorldServer to function properly.
Before you begin
When installing WorldServer using the Windows installer in a Tomcat environment, all configurations specified during the WorldServer installation process are written to the registry (in
HKEY_LOCAL_MACHINE/SOFTWARE/Idiom/WorldServer/Config). Therefore, if you installed WorldServer with the Windows installer, you do not have to make these mandatory changes in
general.properties. However,
general.properties contains other settings you might want to configure, which are described in the "Configuring other settings in
general.properties" topic.
Tip: Configurations in the registry take precedence over any configurations in the general.properties file. If you want to use the general.properties file instead of the registry entries, you will need to clear out the registry settings first.
Procedure
- On the WorldServer machine, go to the configuration folder of the Web application to find the general.properties file. Below are some possible locations of this file:
- If WorldServer is running on Windows under Tomcat, the general.properties file is typically located in:
%WS_CONFIG%\<application name>
c:\Program Files\Idiom\WorldServer\tomcat\webapps\<application name>\WEB-INF\classes\config
- If WorldServer is running on Linux under Tomcat, the general.properties file is typically located in:
$WS_CONFIG/<application name>
/usr/local/idiom/worldserver/tomcat/webapps/<application name>/WEB-INF/classes/config
- In Linux environments, WorldServer looks for the general.properties in the following folder (listed in preferential order):
- $WS_CONFIG/<application name>.
- ~user/etc (the home folder of the user that the application server is running as).
- /usr/local/idiom
- /etc/idiom
- classpath:config (for example, <TOMCAT_HOME>/webapps/ws-legacy/WEB-INF/classes/config )
Note: SDL strongly recommends that you copy the general.properties file from its original location under the application server into one of these other locations. In particular, each time you deploy a new version of the WAR file, the contents of the application server folder will be overwritten and you will lose any changes to your general.properties file.
- Open general.properties with a text editor.
- Configure the database connection settings.
- Enter the name of the database user that WorldServer should use to connect to the database in the database_user line. For example:
database_username=worldserver
- Enter the password for this user in the database_password line.
The password portion of the
general.properties configuration requires an encrypted string. To create this string, execute the following to command from the WorldServer installation folder:
java -jar PasswordTool.jar <plaintext password>
This will return an encrypted password. For example, a password of transl8 results in the string 4YmA6aCE4aS47buB67qc67uB4YiM.
Copy this string into the
general.properties file. For example:
database_password=4YmA6aCE4aS47buB67qc67uB4YiM
- Change temp_file_path entry to specify the appropriate path for the WorldServer temporary folder. This should be on a separate physical drive from the rest of the WorldServer installation, for I/O performance.
For example:
# Temp directory
temp_file_path=c:/temp
or
# Temp directory
temp_file_path=/tmp
Note: When specifying the path, a forward slash (/) must be used, even in a Windows environment. Make sure you have not accidentally added a tab symbol at the end of the parameter. This symbol is invisible in the editor, but it may cause WorldServer to read the parameter incorrectly. This note applies to steps 10 and 11 as well.
Important: The temp_file_path property should have the same value across all WorldServer components. If you use registries, make sure that the value of the temp_file_path property is the same both in the general.properties file and in the registries.
- In addition to the temp_file_path entry, search for other entries related to storage and shared folders to make sure you have adequate space to operate WorldServer.
These entries include
file_attribute_storage,
background_file_storage, and
ftsserver_shared_directory. Unless you specify a different location for these entries, they default to a sub-folder of
temp_file_path.
Note: If you are using the FTS server, be especially aware of the ftsserver_shared_directory entry. Typically, FTS Server copies the source assets of file types to this working directory for processing. Therefore, it needs the same amount of disk space as the original source assets.
- If you are using RCS Version Control, change the following entry to specify the appropriate path for the root RCS folder:
# RCS root. Repository used for version control information
rcs_root=c:/rcs
or
# RCS root. Repository used for version control information
rcs_root=/rcs
- Specify a different log file path for each WorldServer component by uncommenting and modifying the following entry in the general.properties file of each component folder (WS_CONFIG, ws-api, ws-legacy):
# WorldServer Log File
log4j.appender.logfile.File=<log_path>