View source

Quercus is implemented primarily as a servlet and it will run in any application server including Tomcat.

=Requirements=
# Java 1.5 or higher
# Quercus WAR download at http://quercus.caucho.com

=Optional=
# MySQL Connector/J Driver
# Java Mail (javax.mail jar)

=Quick start=
The Quercus servlet is just a plain servlet.  The web.xml should look like the following:

==web.xml==
<code>
<pre>
&lt;web-app xmlns="http://java.sun.com/xml/ns/javaee"
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
     http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
   version="2.5">

  &lt;display-name>Quercus on Tomcat&lt;/display-name>
  
  &lt;servlet>
     &lt;servlet-name>Quercus Servlet&lt;/servlet-name>
     &lt;servlet-class>com.caucho.quercus.servlet.QuercusServlet&lt;/servlet-class>
  &lt;/servlet>
 
  &lt;servlet-mapping>
    &lt;servlet-name>Quercus Servlet</servlet-name>
    &lt;url-pattern>*.php&lt;/url-pattern>
  &lt;/servlet-mapping>
 
  &lt;welcome-file-list>
    &lt;welcome-file>index.php&lt;/welcome-file>
  &lt;/welcome-file-list>

&lt;/web-app>
</pre>
</code>

=Compilation=
Quercus can compile PHP files down to Java bytecodes for faster performance.  However, this feature was only available when Quercus was running inside Resin.  Since 4.0.1, this constraint no longer exists and Quercus compilation is now available to all application servers including Tomcat.  A valid [http://www.caucho.com/products/sales/ license] is required.

==Configuration==

Quercus compilation requires a license.  In the web.xml, you will need to specify the directory where the license is located:

<code>
<pre>
&lt;web-app xmlns="http://java.sun.com/xml/ns/javaee"
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
     http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
   version="2.5">

  &lt;display-name>Quercus on Tomcat&lt;/display-name>
  
  &lt;servlet>
     &lt;servlet-name>Quercus Servlet&lt;/servlet-name>
     &lt;servlet-class>com.caucho.quercus.servlet.QuercusServlet&lt;/servlet-class>
     &lt;init-param>
       &lt;param-name>license-directory&lt;/param-name>
       &lt;param-value>WEB-INF/licenses&lt;/param-value>
     &lt;/init-param>
  &lt;/servlet>
 
  &lt;servlet-mapping>
    &lt;servlet-name>Quercus Servlet</servlet-name>
    &lt;url-pattern>*.php&lt;/url-pattern>
  &lt;/servlet-mapping>
 
  &lt;welcome-file-list>
    &lt;welcome-file>index.php&lt;/welcome-file>
  &lt;/welcome-file-list>

&lt;/web-app>
</pre>
</code>

The compiled files will be located in WEB-INF/work.