Product Documentation

ExtraView 11 requires Java JRE 8. If your system is on an earlier version of Java, you must upgrade to the required version. If your current version of Tomcat does not support Java 8, you must upgrade to a newer version. We recommend upgrading to Tomcat 8.5. When upgrading, ensure that the Tomcat service is stopped before installing the new version.

Note that if you are intending to use Microsoft IIS as your web server, you must still install Tomcat. IIS does not provide the same functionality as Tomcat.

Double click on the Tomcat Application server installation file that you downloaded. In our example it is called apache-tomcat-8.5.23.exe. You may get a Windows Security Warning - click Run to proceed.

Extract the apache-tomcat-8.5.23 folder to your destination folder  - C:\ExtraView - so that you end up with C:\ExtraView\apache-tomcat-8.5.23

Include the selected defaults

Open a command window, as Administrator, and navigate to the destination folder

You can modify the ports Tomcat will run on, if you already have something else running on these ports. In this example, we will leave the defaults

Browse to the Java 8 that you installed for ExtraView

Ensure that the destination path for the Tomcat installation does not contain any empty spaces in the folder names

Once Tomcat has successfully completed the installation, let it start up and close the installer window

You can modify the service parameters once you have created it - 

Navigate to the destination folder, and into the /bin folder where you will see the tomcat8w.exe application

Double click the tomcat8w.exe file to start it

On the General tab - set the service to start automatically 

On the Java tab, you can select a different installation of Java if the JAVA_HOME did not pick the correct installation.

Set the memory parameters to a minimum of:

128 MB for Initial memory pool 
512 MB for Maximum memory pool

We generally do not recommend setting the Maximum memory pool (the Xmx parameter) above 1024 megs at maximum. If your system usage is predicted to be high enough that you will require more memory, we strongly suggest installing a clustered set of multiple Tomcat nodes under a load-balanced Apache web server.

Now, on the General tab - start the service

If you enter http://localhost:8080 into the local browser, you should get the Tomcat test page.

Using the APIs to Insert Large Amounts of Text

When using an API to insert very large amounts of text within a single issue you may encounter an error within the API function, exhibiting as a null pointer exception that originates within the Tomcat application server.  This error may be remedied by inserting the modifying the Connector entry within the Tomcat configuration file.  An example of the altered configuration is:

The maxPostSize parameter increases the size of Tomcat's buffer used to process the API command.

Tomcat 8.5 Notes

1. Modify the <Context> entry in the context.xml file to be

   <Context useHttpOnly="false">

   You should add the following to the tomcat/conf/context.xml file:

   <!-- Force use of the old Cookie processor (because this Tomcat version uses RFC6265 Cookie Specification) -->
<CookieProcessor className="org.apache.tomcat.util.http.LegacyCookieProcessor" />

2. Locate the following section in the Tomcat configuration file:

   <!-- Uncomment this to disable session persistence across Tomcat restarts -->
<!--
<Manager pathname="" />
-->

   and alter to use this setting:

   <!-- Disable session persistence across Tomcat restarts -->
<Manager pathname="" />
    

3. Tomcat 8's standard installation altered the way in which several characters were accepted as valid URL characters.  These are characters such as |, { and }.  Some of these characters have long been used within the ExtraView application.  To enable Tomcat's handling of these characters, insert this line into the Catalina.properties file:

   tomcat.util.http.parser.HttpParser.requestTargetAllow=|{}
    

4. Tomcat 8.x has a security measure which mandates that you must configure a security measure.  This measure rejects all calls to the Tomcat server unless a secret word is part of the request, with requests typically being sent by the Apache web server.  Without this configuration, the Tomcat server will apear to spin without responding to the request or will respond with a 404 Not Found error.  To configure this feature:
   1. In the server.xml file, ensure the section for the AJP 13 connector, has these parameters:

      <Connector protocol="AJP/1.3"
           address="0.0.0.0"
           port="8009"
           redirectPort="8443"
           secret="changeme" />

      Note the port number is typically 8009
      Note the secret word should be changed to your secret word

   2. In the workers.properties file where you set the AJP 1.3 connector, add a parameter:

      worker.tomcat1.secret = changeme

      Note the secret word should match the entry in the server.xml file.

5. Make sure you restart Tomcat after altering its configuration.