| 1 | <html><head><META http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><title>Apache Tomcat 6.0 - Tomcat Setup</title><meta value="Remy Maucherat" name="author"><meta value="remm@apache.org" name="email"></head><body vlink="#525D76" alink="#525D76" link="#525D76" text="#000000" bgcolor="#ffffff"><table cellspacing="0" width="100%" border="0"><!--PAGE HEADER--><tr><td><!--PROJECT LOGO--><a href="http://tomcat.apache.org/"><img border="0" alt=" |
|---|
| 2 | The Apache Tomcat Servlet/JSP Container |
|---|
| 3 | " align="right" src="./images/tomcat.gif"></a></td><td><font face="arial,helvetica,sanserif"><h1>Apache Tomcat 6.0</h1></font></td><td><!--APACHE LOGO--><a href="http://www.apache.org/"><img border="0" alt="Apache Logo" align="right" src="./images/asf-logo.gif"></a></td></tr></table><table cellspacing="4" width="100%" border="0"><!--HEADER SEPARATOR--><tr><td colspan="2"><hr size="1" noshade></td></tr><tr><!--LEFT SIDE NAVIGATION--><td nowrap="true" valign="top" width="20%"><p><strong>Links</strong></p><ul><li><a href="index.html">Docs Home</a></li><li><a href="http://wiki.apache.org/tomcat/FAQ">FAQ</a></li></ul><p><strong>User Guide</strong></p><ul><li><a href="introduction.html">1) Introduction</a></li><li><a href="setup.html">2) Setup</a></li><li><a href="appdev/index.html">3) First webapp</a></li><li><a href="deployer-howto.html">4) Deployer</a></li><li><a href="manager-howto.html">5) Manager</a></li><li><a href="realm-howto.html">6) Realms and AAA</a></li><li><a href="security-manager-howto.html">7) Security Manager</a></li><li><a href="jndi-resources-howto.html">8) JNDI Resources</a></li><li><a href="jndi-datasource-examples-howto.html">9) JDBC DataSources</a></li><li><a href="class-loader-howto.html">10) Classloading</a></li><li><a href="jasper-howto.html">11) JSPs</a></li><li><a href="ssl-howto.html">12) SSL</a></li><li><a href="ssi-howto.html">13) SSI</a></li><li><a href="cgi-howto.html">14) CGI</a></li><li><a href="proxy-howto.html">15) Proxy Support</a></li><li><a href="mbeans-descriptor-howto.html">16) MBean Descriptor</a></li><li><a href="default-servlet.html">17) Default Servlet</a></li><li><a href="cluster-howto.html">18) Clustering</a></li><li><a href="balancer-howto.html">19) Load Balancer</a></li><li><a href="connectors.html">20) Connectors</a></li><li><a href="monitoring.html">21) Monitoring and Management</a></li><li><a href="logging.html">22) Logging</a></li><li><a href="apr.html">23) APR/Native</a></li><li><a href="virtual-hosting-howto.html">24) Virtual Hosting</a></li><li><a href="aio.html">25) Advanced IO</a></li><li><a href="extras.html">26) Additional Components</a></li><li><a href="maven-jars.html">27) Mavenized</a></li></ul><p><strong>Reference</strong></p><ul><li><a href="RELEASE-NOTES.txt">Release Notes</a></li><li><a href="config/index.html">Configuration</a></li><li><a href="api/index.html">Javadocs</a></li><li><a href="http://tomcat.apache.org/connectors-doc/">JK 1.2 Documentation</a></li></ul><p><strong>Apache Tomcat Development</strong></p><ul><li><a href="building.html">Building</a></li><li><a href="changelog.html">Changelog</a></li><li><a href="http://wiki.apache.org/tomcat/TomcatVersions">Status</a></li><li><a href="developers.html">Developers</a></li><li><a href="architecture/index.html">Architecture</a></li><li><a href="funcspecs/index.html">Functional Specs.</a></li></ul></td><!--RIGHT SIDE MAIN BODY--><td align="left" valign="top" width="80%"><table cellspacing="4" width="100%" border="0"><tr><td valign="top" align="left"><h1>Apache Tomcat 6.0</h1><h2>Tomcat Setup</h2></td><td nowrap="true" valign="top" align="right"><small><a href="printer/setup.html"><img alt="Printer Friendly Version" border="0" src="./images/printer.gif"><br>print-friendly<br>version |
|---|
| 4 | </a></small></td></tr></table><table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#525D76"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Introduction"><strong>Introduction</strong></a></font></td></tr><tr><td><blockquote> |
|---|
| 5 | <p> |
|---|
| 6 | This document introduces several ways to set up Tomcat for running |
|---|
| 7 | on different platforms. Please note that some advanced setup issues |
|---|
| 8 | are not covered here: the full distribution (ZIP file or tarball) |
|---|
| 9 | includes a file called |
|---|
| 10 | RUNNING.txt which discusses these issues. We encourage you to refer |
|---|
| 11 | to it if the information below does not answer some of your questions. |
|---|
| 12 | </p> |
|---|
| 13 | </blockquote></td></tr></table><table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#525D76"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Windows"><strong>Windows</strong></a></font></td></tr><tr><td><blockquote> |
|---|
| 14 | |
|---|
| 15 | <p> |
|---|
| 16 | Installing Tomcat on Windows can be done easily using the Windows |
|---|
| 17 | installer. Its interface and functionality is similar to other wizard |
|---|
| 18 | based installers, with only a few items of interest. |
|---|
| 19 | </p> |
|---|
| 20 | |
|---|
| 21 | <p> |
|---|
| 22 | <ul> |
|---|
| 23 | <li><strong>Installation as a service</strong>: Tomcat will be |
|---|
| 24 | installed as a Windows |
|---|
| 25 | NT/2k/XP service no matter what setting is selected. Using the |
|---|
| 26 | checkbox on the component page sets the service as "auto" |
|---|
| 27 | startup, so that Tomcat is automatically started when Windows |
|---|
| 28 | starts. For optimal security, the service should be run as a |
|---|
| 29 | separate user, with reduced permissions (see the Windows Services |
|---|
| 30 | administration tool and its documentation).</li> |
|---|
| 31 | <li><strong>Java location</strong>: The installer will use the registry |
|---|
| 32 | or the JAVA_HOME environment variable to determine the base path |
|---|
| 33 | of a J2SE 5 JRE. |
|---|
| 34 | </li> |
|---|
| 35 | <li><strong>Tray icon</strong>: When Tomcat is run as a service, there |
|---|
| 36 | will not be any tray icon present when Tomcat is running. Note that |
|---|
| 37 | when choosing to run Tomcat at the end of installation, the tray |
|---|
| 38 | icon will be used even if Tomcat was installed as a service.</li> |
|---|
| 39 | <li>Refer to the |
|---|
| 40 | <a href="windows-service-howto.html">Windows Service HOW-TO</a> |
|---|
| 41 | for information on how to manage Tomcat as Windows NT service. |
|---|
| 42 | </li> |
|---|
| 43 | </ul> |
|---|
| 44 | </p> |
|---|
| 45 | |
|---|
| 46 | <p>The installer will create shortcuts allowing starting and configuring |
|---|
| 47 | Tomcat. It is important to note that the Tomcat administration web |
|---|
| 48 | application can only be used when Tomcat is running.</p> |
|---|
| 49 | |
|---|
| 50 | </blockquote></td></tr></table><table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#525D76"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Unix daemon"><strong>Unix daemon</strong></a></font></td></tr><tr><td><blockquote> |
|---|
| 51 | |
|---|
| 52 | <p>Tomcat can be run as a daemon using the jsvc tool from the |
|---|
| 53 | commons-daemon project. Source tarballs for jsvc are included with the |
|---|
| 54 | Tomcat binaries, and need to be compiled. Building jsvc requires |
|---|
| 55 | a C ANSI compiler (such as GCC), GNU Autoconf, and a JDK.</p> |
|---|
| 56 | |
|---|
| 57 | <p>Before running the script, the <code>JAVA_HOME</code> environment |
|---|
| 58 | variable should be set to the base path of the JDK. Alternately, when |
|---|
| 59 | calling the <code>./configure</code> script, the path of the JDK may |
|---|
| 60 | be specified using the <code>--with-java</code> parameter, such as |
|---|
| 61 | <code>./configure --with-java=/usr/java</code>.</p> |
|---|
| 62 | |
|---|
| 63 | <p>Using the following commands should result in a compiled jsvc binary, |
|---|
| 64 | located in the <code>$CATALINA_HOME/bin</code> folder. This assumes |
|---|
| 65 | that GNU TAR is used, and that <code>CATALINA_HOME</code> is an |
|---|
| 66 | environment variable pointing to the base path of the Tomcat |
|---|
| 67 | installation.</p> |
|---|
| 68 | |
|---|
| 69 | <p>Please note that you should use the GNU make (gmake) instead of |
|---|
| 70 | the native BSD make on FreeBSD systems.</p> |
|---|
| 71 | |
|---|
| 72 | <p>Download a commons-daemon binary from the Jakarta Commons download page, |
|---|
| 73 | and place jsvc.tar.gz and commons-daemon.jar in the |
|---|
| 74 | <code>$CATALINA_HOME/bin</code> folder.</p> |
|---|
| 75 | |
|---|
| 76 | <div align="left"><table border="0" cellpadding="0" cellspacing="4"><tr><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" src="./images/void.gif"></td><td height="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" src="./images/void.gif"></td><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" src="./images/void.gif"></td></tr><tr><td width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" src="./images/void.gif"></td><td height="1" bgcolor="#ffffff"><pre> |
|---|
| 77 | cd $CATALINA_HOME/bin |
|---|
| 78 | tar xvfz jsvc.tar.gz |
|---|
| 79 | cd jsvc-src |
|---|
| 80 | autoconf |
|---|
| 81 | ./configure |
|---|
| 82 | make |
|---|
| 83 | cp jsvc .. |
|---|
| 84 | cd .. |
|---|
| 85 | </pre></td><td width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" src="./images/void.gif"></td></tr><tr><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" src="./images/void.gif"></td><td height="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" src="./images/void.gif"></td><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" src="./images/void.gif"></td></tr></table></div> |
|---|
| 86 | |
|---|
| 87 | <p>Tomcat can then be run as a daemon using the following commands.</p> |
|---|
| 88 | |
|---|
| 89 | <div align="left"><table border="0" cellpadding="0" cellspacing="4"><tr><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" src="./images/void.gif"></td><td height="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" src="./images/void.gif"></td><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" src="./images/void.gif"></td></tr><tr><td width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" src="./images/void.gif"></td><td height="1" bgcolor="#ffffff"><pre> |
|---|
| 90 | cd $CATALINA_HOME |
|---|
| 91 | ./bin/jsvc -cp ./bin/bootstrap.jar \ |
|---|
| 92 | -outfile ./logs/catalina.out -errfile ./logs/catalina.err \ |
|---|
| 93 | org.apache.catalina.startup.Bootstrap |
|---|
| 94 | </pre></td><td width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" src="./images/void.gif"></td></tr><tr><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" src="./images/void.gif"></td><td height="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" src="./images/void.gif"></td><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" src="./images/void.gif"></td></tr></table></div> |
|---|
| 95 | |
|---|
| 96 | <p>jsvc has other useful parameters, such as <code>-user</code> which |
|---|
| 97 | causes it to switch to another user after the daemon initialization is |
|---|
| 98 | complete. This allows, for example, running Tomcat as a non privileged |
|---|
| 99 | user while still being able to use privileged ports. |
|---|
| 100 | <code>jsvc --help</code> will return the full jsvc usage |
|---|
| 101 | information. In particular, the <code>-debug</code> option is useful |
|---|
| 102 | to debug issues running jsvc.</p> |
|---|
| 103 | |
|---|
| 104 | <p>The file <code>$CATALINA_HOME/bin/jsvc/native/tomcat.sh</code> can be |
|---|
| 105 | used as a template for starting Tomcat automatically at boot time from |
|---|
| 106 | <code>/etc/init.d</code>. The file is currently setup for running |
|---|
| 107 | Tomcat 4.1.x, so it is necessary to edit it and change the classname |
|---|
| 108 | from <code>BootstrapService</code> to <code>Bootstrap</code>.</p> |
|---|
| 109 | |
|---|
| 110 | <p>Note that the Commons-Daemon JAR file must be on your runtime classpath |
|---|
| 111 | to run Tomcat in this manner. The Commons-Daemon JAR file is in the Class-Path |
|---|
| 112 | entry of the bootstrap.jar manifest, but if you get a ClassNotFoundException |
|---|
| 113 | or a NoClassDefFoundError for a Commons-Daemon class, add the Commons-Daemon |
|---|
| 114 | JAR to the -cp argument when launching jsvc.</p> |
|---|
| 115 | |
|---|
| 116 | </blockquote></td></tr></table></td></tr><!--FOOTER SEPARATOR--><tr><td colspan="2"><hr size="1" noshade></td></tr><!--PAGE FOOTER--><tr><td colspan="2"><div align="center"><font size="-1" color="#525D76"><em> |
|---|
| 117 | Copyright © 1999-2008, Apache Software Foundation |
|---|
| 118 | </em></font></div></td></tr></table></body></html> |
|---|
