Deploying WorldServer through Tomcat (on Windows)

The WorldServer installer for Windows installs Tomcat and deploys WorldServer for you. However, there may be situations when you have to deploy WorldServer manually (for example, in your testing environment). You can deploy WorldServer through Apache Tomcat 9, which you can find in the 3rdparty folder of the WorldServer distribution kit.

About this task

Use this procedure both to deploy WorldServer on a new environment and to upgrade Tomcat on an existing WorldServer environment. In the latter case, however, you have to uninstall your existing Tomcat version before you start upgrading to a new one. Also, you no longer need to configure the .properties files at the end, because they have already been configured.

Procedure

  1. Do one of the following:
    • For WorldServer 11.8.3 and later: Copy the apache-tomcat-9.0.91.zip file from the WorldServer distribution kit to your machine, and then extract the contents of the apache-tomcat-9.0.91.zip file to your <ws-home> folder.
    • For WorldServer 11.8.2: Copy the apache-tomcat-9.0.87.zip file from the WorldServer distribution kit to your machine, and then extract the contents of the apache-tomcat-9.0.87.zip file to your <ws-home> folder.
    • For WorldServer 11.8.0 and 11.8.1: Copy the apache-tomcat-9.0.68.zip file from the WorldServer distribution kit to your machine, and then extract the contents of the apache-tomcat-9.0.68.zip file to your <ws-home> folder.
    <ws-home> is the WorldServer installation folder—by default, C:\Program Files\Idiom\WorldServer.
  2. If you haven't done so already, set the CATALINA_HOME environment variable: set CATALINA_HOME=<ws-home>\tomcat
  3. Copy the WorldServer .war files from the WorldServer installation folder to the Tomcat webapps folder:
    copy c:\Program Files\Idiom\WorldServer\ws.war
    copy c:\Program Files\Idiom\WorldServer\ws-legacy.war
    copy c:\Program Files\Idiom\WorldServer\ws-api.war 
    
  4. Start Tomcat:
    • For WorldServer 11.8.3 and later:
      cd c:\Program Files\Idiom\WorldServer\apache-tomcat-9.0.91\bin
      startup.bat
    • For WorldServer 11.8.2:
      cd c:\Program Files\Idiom\WorldServer\apache-tomcat-9.0.87\bin
      startup.bat
    • For WorldServer 11.8.0 and 11.8.1:
      cd c:\Program Files\Idiom\WorldServer\apache-tomcat-9.0.68\bin
      startup.bat
    The contents of the ws.war, ws-legacy.war, and ws-api.war files are extracted and the Tomcat console displays a log such as the following:
    Aug 12, 2024 9:34:30 AM org.apache.coyote.http11.Http11BaseProtocol
    init
    INFO: Initializing Coyote HTTP/1.1 on port 8080
    ...
    INFO: Starting service Catalina
    ...
    INFO: Starting Servlet Engine: Apache Tomcat/9.0.91
    ...
    INFO: Deploying web application archive ws.war
    ...
    INFO: Deploying web application archive ws-legacy.war
    ...
    INFO: Deploying web application archive ws-api.war
    ...
    Aug 12, 2024 9:34:37 AM org.apache.catalina.startup.Catalina start
    INFO: Server startup in 21310 ms

Results

You have now finished deploying WorldServer on Windows.