Documentation Center

Configuring mandatory settings in general.properties

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.

Procedure

  1. 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
  2. In Linux environments, WorldServer looks for the general.properties in the following folder (listed in preferential order):
    1. $WS_CONFIG/<application name>.
    2. ~user/etc (the home folder of the user that the application server is running as).
    3. /usr/local/idiom
    4. /etc/idiom
    5. classpath:config (for example, <TOMCAT_HOME>/webapps/ws-legacy/WEB-INF/classes/config )
  3. Open general.properties with a text editor.
  4. Configure the database connection settings.
  5. 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
  6. 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
  7. 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
  8. 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.
  9. 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
  10. 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>