...
- JDK 1.6 update 21 or later (JDK 1.7 is not supported as of 2013/01)
- Download Location: http://java.sun.com
Environment Variable: JAVA_HOME
Tip title Java Environment Variable JAVA_HOME=/path/to/your/java (ie: /usr/local/java or C:\java\jdk)
(optional)
PATH= append the bin subdirectory to the path statement
- Tomcat 6.X (Tomcat 7 is not supported as of 2013/01)
Instructions for installing and configuring Tomcat for the SSP-Platform (uPortal 4.0)
Warning title Tomcat Configuration It is important to complete sections: Environment Variables, Shared Libraries, Shared Sessions, Java Heap
- The following are the key parts of the document linked above if you have already installed tomcat.
Edit CATALINA_BASE/conf/catalina.properties to include the shared library folders in the tomcat directory. You may need to create these folders depending on your system permissions, as well as include an absolute path instead of ${catalina.base} if the environment variables are not set correctly.
Code Block shared.loader=${catalina.base}/shared/classes,${catalina.base}/shared/lib/*.jar
Warning title Symptoms of not including this change localhost.<date>.log file will throw java.lang.ClassNotFoundException: javax.portlet.PortletMode exception as you start tomcat.
Edit CATALINA_BASE/conf/server.xml to allow the portlets to share user session data.
Code Block <Connector port="8080" protocol="HTTP/1.1" connectionTimeout="20000" redirectPort="8443" emptySessionPath="true"/>
Warning title Symptoms of not including this change If you go to localhost:8080/ssp-platform and login successfully, upon loading the SSP Portlet does not appear.
Edit CATALINA_BASE/bin/startup, or add an environment variable called CATALINA_OPTS as follows (note on Unix/Linux/OS X you should permanently export the environment variable)
On Windows, Edit the file $TOMCAT_HOME\bin\startup.bat and insert or alter the following line, substituting for the desired values. The line you add should go just before the line starting call “%EXECUTABLE%”…:Code Block set CATALINA_OPTS=-XX:MaxPermSize=300m -Xmx1024m
On Linux/Unix/OS X, Edit the file $TOMCAT_HOME/bin/startup.sh and insert the following line, substituting for the desired value, eg. Bash Shell:
export CATALINA_OPTS="-XX:MaxPermSize=300m -Xmx1024m"Code Block setenv.[sh|bat]
Warning Increase the heap in<tomcat>/bin/setenv.sh
(*nix) or<tomcat>/bin/setenv.bat
(Windows). Smaller sizing is probably feasible, but the examples below match what our SSP CI envs run with. For production systems, start with a max heap of roughly half available physical memory and increase from there if necessary.The uPortal instructions above recommend usingJAVA_OPTS
for heap sizing. This can lead to problems on memory constrained systems becauseJAVA_OPTS
will be used when trying to stop Tomcat with its own scripts. You don't typically need a large heap at all for that operation. SoCATALINA_OPTS
is a better choice for sizing the heap insetenv
scripts, because that var will only be used for Tomcat's http-serving runtime.setenv.sh:
CATALINA_OPTS=-Xms2G -Xmx2G -XX:PermSize=256m -XX:MaxPermSize=256m
setenv.bat (uPortal instructions linked to above are missing the 'set'):
set CATALINA_OPTS=-Xms2G -Xmx2G -XX:PermSize=256m -XX:MaxPermSize=256m
Warning title Symptoms of not including this change there will be a permGenSpace error PermGen space errors reported in catalina.out as tomcat attempts to start.
...