Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Create a new folder to serve as <SOAVIRT_HOME>. It can be located anywhere except within the Apache Tomcat webapps directory. For example, on Windows you might use c:/wars/soavirt.
  2. Extract the contents of the WAR file into <SOAVIRT_HOME>.
  3. Download Apache Tomcat Core 7 8.5 or 9.0 or above for your platform from http://tomcat.apache.org/.
  4. Extract the downloaded Apache Tomcat to a location of your choice (<TOMCAT_HOME>).
  5. In <TOMCAT_HOME>/conf/Catalina/localhost/, create an empty ROOT.xml file.
  6. Open <TOMCAT_HOME>/conf/Catalina/localhost/ROOT.xml file and add a Context element such as the following (making the appropriate adjustments to docBase absolute path as needed, depending on your specific <SOAVIRT_HOME> location):

    Code Block
    <Context 
      docBase="c:/wars/soavirt" 
      path="" 
      reloadable="true" 
    />
  7. (Optional) If you want to deploy the WAR file over HTTPS, perform the following steps to configure for SSL:
    1. Create a keystore file to store the server's private key and self-signed certificate by executing the following command:

      <JAVA_HOME>/bin/keytool -genkey -alias tomcat -keyalg RSA -keystore /path/to/soavirt.keystore
       
    2. Specify "changeit" for all passwords when prompted. It is recommended for the keystore and <tomcat> alias passwords to be the same.
    3. The soavirt.keystore file will be created in the specified directory.

    4. Uncomment the SSL HTTP/1.1 Connector entry in the <TOMCAT_HOME>/conf/server.xml configuration file and update the keystoreFile attribute value:

      Code Block
      <!-- Define a SSL Coyote HTTP/1.1 Connector on port 8443 -->
      <Connector
           protocol="org.apache.coyote.http11.Http11NioProtocol"
           port="8443" maxThreads="200"
           scheme="https" secure="true" SSLEnabled="true"
           keystoreFile="/path/to/soavirt.keystore" keystorePass="changeit"
           clientAuth="false" sslProtocol="TLS"/>
  8. Specify the ports used by Apache Tomcat in the config.properties file at <SOAVIRT_HOME>/WEB-INF/config.properties (see Configuring Virtualize Server for details). For example, you might use server.port.http=8080 or server.port.https=8443. The ports specified in config.properties must match the ports specified in the Tomcat configuration.
  9. Specify the appropriate license in the config.properties file at <SOAVIRT_HOME>/WEB-INF/config.properties (see Configuring Virtualize Server for details).
  10. Start Tomcat (e.g., from <TOMCAT_HOME>/bin).
  11. Browse to http://localhost:8080/ (adjust the port if needed). The following message confirms that the application was installed correctly: 

...

Although this method is easier than the first, it is not recommended because it removes the default Tomcat ROOT web application.

  1. Download Apache Tomcat Core 7 8.5 or 9.0 or above for your platform from http://tomcat.apache.org/.
  2. Extract the downloaded Apache Tomcat to a location of your choice (<TOMCAT_HOME>).
  3. Remove the “ROOT” folder from the webapps directory.
  4. Rename the “soavirt_<version>.war” file to “ROOT.war”.
  5. Copy “ROOT.war” into the <TOMCAT_HOME>/webapps/ folder.
  6. (Optional) If you want to deploy the WAR file over HTTPS, perform the following steps to configure for SSL:
    1. Create a keystore file to store the server's private key and self-signed certificate by executing the following command:

      <JAVA_HOME>/bin/keytool -genkey -alias tomcat -keyalg RSA -keystore /path/to/soavirt.keystore
       
    2. Specify "changeit" for all passwords when prompted. It is recommended for the keystore and <tomcat> alias passwords to be the same.
    3. The soavirt.keystore file will be created in the specified directory. 
    4. Uncomment the SSL HTTP/1.1 Connector entry in the <TOMCAT_HOME>/conf/server.xml configuration file and update the keystoreFile attribute value:

      Code Block
      <!-- Define a SSL Coyote HTTP/1.1 Connector on port 8443 -->
      <Connector
           protocol="org.apache.coyote.http11.Http11NioProtocol"
           port="8443" maxThreads="200"
           scheme="https" secure="true" SSLEnabled="true"
           keystoreFile="/path/to/soavirt.keystore" keystorePass="changeit"
           clientAuth="false" sslProtocol="TLS"/>
  7. Edit the existing config.properties file (or create a new file) stored in the <TOMCAT_HOME>/webapps folder and add entries for the ports used by Apache Tomcat (see Configuring Virtualize Server for details). For example, add server.port.http=8080 or server.port.https=8443. The ports specified in config.properties must match the ports specified in the Tomcat configuration.
  8. Specify the appropriate license in the config.properties file at <TOMCAT_HOME>/webapps/config.properties (see Configuring Virtualize Server for details).
  9. Start Tomcat (e.g., from <TOMCAT_HOME>/bin).
  10. Browse to http://localhost:8080/ (adjust the port if needed). The following message confirms that the application was installed correctly:

...