E-mailThe Apache Tomcat servlet container provides an ideal environment for running Sakai as a web application. Tomcat implements both the Java Servlet and JavaServer Pages (JSP) specifications and can be run in standalone mode or in conjunction with a web application server such as the Apache HTTP server or JBoss. Sakai 2.5.0 was tested using Apache Tomcat 5.5.23 although the latest stable release of Tomcat 5.5 should present no compatibility issues. You can learn more about Tomcat by visiting http://tomcat.apache.org/.
Sakai installations should always be accompanied by a fresh install of Tomcat. It provides a clean environment that simplifies troubleshooting if problems are encountered during the startup phase.
Download and Install Tomcat
Tomcat and Sakai 2.5 releases
| Sakai | Tomcat (tested against) | Tomcat (also works with) | Tomcat (avoid) |
|---|---|---|---|
| 2.5.0 | 5.5.23 | 5.5.25 | 5.5.26 (known incompatibilities) |
| 2.5.2 | 5.5.26 | 5.5.27 ( requires JAVA_OPTS modification) |
|
| 2.5.3 | 5.5.26 | 5.5.27 ( requires JAVA_OPTS modification) |
|
| 2.5.4 | 5.5.26 | 5.5.27 ( requires JAVA_OPTS modification) |
Tomcat 5.5.27
This version of Tomcat enforces strict quote escaping which causes run-time errors in Sakai tools that use the JavaServer Faces UI framework. See https://issues.apache.org/bugzilla/show_bug.cgi?id=45015 for more details. If you deploy Sakai using Tomcat 5.5.27 add the following parameter to your JAVA_OPTS environment settings:
-Dorg.apache.jasper.compiler.Parser.STRICT_QUOTE_ESCAPING=false
Getting Tomcat
Tomcat can be downloaded as a binary install from
http://archive.apache.org/dist/tomcat/tomcat-5/
Do not download and install the JDK 1.4 Compatibility Package. Sakai 2.5 will not run should you install it.
Choose the core distribution. Windows users have the option of downloading either a Windows Service Installer .exe or a binary *.zip archive. We recommend the *.zip archive over the installer because configuration and log viewing are easier. You can later convert the .zip install into a service install later by running /bin/service.bat (see below for more details).
Unpack the Tomcat archive into your installation directory of choice, e.g. /opt/. Unix/Mac users should create a symbolic link while Windows users should simply rename the base Tomcat directory to /tomcat to simplify the path.
Tomcat 2.5.2+
ln -s apache-tomcat-5.5.26 tomcat
Tomcat 2.5.0
ln -s apache-tomcat-5.5.23 tomcat
Windows users should ensure that the Tomcat path includes no spaces as this causes errors with JavaServer Faces (JSF) tools in Sakai.
Good: C:\opt\tomcat\, C:\sakaistuff\installs\tomcat\
Bad: C:\program files\tomcat\, C:\opt\apache tomcat 5.5.26\
Unix/Mac users should make sure that they have write permissions to the Tomcat servlet container files and directories before proceeding or startup permission errors may occur.