| <html><head><META http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><title>Apache Tomcat 7 (7.0.77) - Tomcat Setup</title><meta name="author" content="Remy Maucherat"><style type="text/css" media="print"> | |
| .noPrint {display: none;} | |
| td#mainBody {width: 100%;} | |
| </style><style type="text/css"> | |
| code {background-color:rgb(224,255,255);padding:0 0.1em;} | |
| code.attributeName, code.propertyName {background-color:transparent;} | |
| table { | |
| border-collapse: collapse; | |
| text-align: left; | |
| } | |
| table *:not(table) { | |
| /* Prevent border-collapsing for table child elements like <div> */ | |
| border-collapse: separate; | |
| } | |
| th { | |
| text-align: left; | |
| } | |
| div.codeBox pre code, code.attributeName, code.propertyName, code.noHighlight, .noHighlight code { | |
| background-color: transparent; | |
| } | |
| div.codeBox { | |
| overflow: auto; | |
| margin: 1em 0; | |
| } | |
| div.codeBox pre { | |
| margin: 0; | |
| padding: 4px; | |
| border: 1px solid #999; | |
| border-radius: 5px; | |
| background-color: #eff8ff; | |
| display: table; /* To prevent <pre>s from taking the complete available width. */ | |
| /* | |
| When it is officially supported, use the following CSS instead of display: table | |
| to prevent big <pre>s from exceeding the browser window: | |
| max-width: available; | |
| width: min-content; | |
| */ | |
| } | |
| div.codeBox pre.wrap { | |
| white-space: pre-wrap; | |
| } | |
| table.defaultTable tr, table.detail-table tr { | |
| border: 1px solid #CCC; | |
| } | |
| table.defaultTable tr:nth-child(even), table.detail-table tr:nth-child(even) { | |
| background-color: #FAFBFF; | |
| } | |
| table.defaultTable tr:nth-child(odd), table.detail-table tr:nth-child(odd) { | |
| background-color: #EEEFFF; | |
| } | |
| table.defaultTable th, table.detail-table th { | |
| background-color: #88b; | |
| color: #fff; | |
| } | |
| table.defaultTable th, table.defaultTable td, table.detail-table th, table.detail-table td { | |
| padding: 5px 8px; | |
| } | |
| p.notice { | |
| border: 1px solid rgb(255, 0, 0); | |
| background-color: rgb(238, 238, 238); | |
| color: rgb(0, 51, 102); | |
| padding: 0.5em; | |
| margin: 1em 2em 1em 1em; | |
| } | |
| </style></head><body bgcolor="#ffffff" text="#000000" link="#525D76" alink="#525D76" vlink="#525D76"><table border="0" width="100%" cellspacing="0"><!--PAGE HEADER--><tr><td><!--PROJECT LOGO--><a href="http://tomcat.apache.org/"><img src="./images/tomcat.gif" align="right" alt=" | |
| The Apache Tomcat Servlet/JSP Container | |
| " border="0"></a></td><td><h1><font face="arial,helvetica,sanserif">Apache Tomcat 7</font></h1><font face="arial,helvetica,sanserif">Version 7.0.77, Mar 28 2017</font></td><td><!--APACHE LOGO--><a href="http://www.apache.org/"><img src="./images/asf-logo.svg" align="right" alt="Apache Logo" border="0" style="width: 266px;height: 83px;"></a></td></tr></table><table border="0" width="100%" cellspacing="4"><!--HEADER SEPARATOR--><tr><td colspan="2"><hr noshade size="1"></td></tr><tr><!--LEFT SIDE NAVIGATION--><td width="20%" valign="top" nowrap class="noPrint"><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><li><a href="#comments_section">User Comments</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/TLS</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-descriptors-howto.html">16) MBeans Descriptors</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><li><a href="security-howto.html">28) Security Considerations</a></li><li><a href="windows-service-howto.html">29) Windows Service</a></li><li><a href="windows-auth-howto.html">30) Windows Authentication</a></li><li><a href="jdbc-pool.html">31) Tomcat's JDBC Pool</a></li><li><a href="web-socket-howto.html">32) WebSocket</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">Tomcat Javadocs</a></li><li><a href="servletapi/index.html">Servlet Javadocs</a></li><li><a href="jspapi/index.html">JSP 2.2 Javadocs</a></li><li><a href="elapi/index.html">EL 2.2 Javadocs</a></li><li><a href="websocketapi/index.html">WebSocket 1.1 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><li><a href="tribes/introduction.html">Tribes</a></li></ul></td><!--RIGHT SIDE MAIN BODY--><td width="80%" valign="top" align="left" id="mainBody"><h1>Tomcat Setup</h1><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Table of Contents"><!--()--></a><a name="Table_of_Contents"><strong>Table of Contents</strong></a></font></td></tr><tr><td><blockquote> | |
| <ul><li><a href="#Introduction">Introduction</a></li><li><a href="#Windows">Windows</a></li><li><a href="#Unix_daemon">Unix daemon</a></li></ul> | |
| </blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Introduction"><strong>Introduction</strong></a></font></td></tr><tr><td><blockquote> | |
| <p> | |
| There are several ways to set up Tomcat for running on different | |
| platforms. The main documentation for this is a file called | |
| <a href="RUNNING.txt">RUNNING.txt</a>. We encourage you to refer to that | |
| file if the information below does not answer some of your questions. | |
| </p> | |
| </blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Windows"><strong>Windows</strong></a></font></td></tr><tr><td><blockquote> | |
| <p> | |
| Installing Tomcat on Windows can be done easily using the Windows | |
| installer. Its interface and functionality is similar to other wizard | |
| based installers, with only a few items of interest. | |
| </p> | |
| <p> | |
| <ul> | |
| <li><strong>Installation as a service</strong>: Tomcat will be | |
| installed as a Windows service no matter what setting is selected. | |
| Using the checkbox on the component page sets the service as "auto" | |
| startup, so that Tomcat is automatically started when Windows | |
| starts. For optimal security, the service should be run as a | |
| separate user, with reduced permissions (see the Windows Services | |
| administration tool and its documentation).</li> | |
| <li><strong>Java location</strong>: The installer will provide a default | |
| JRE to use to run the service. The installer uses the registry to | |
| determine the base path of a Java 6 or later JRE, including the JRE | |
| installed as part of the full JDK. When running on a 64-bit | |
| operating system, the installer will first look for a 64-bit JRE and | |
| only look for a 32-bit JRE if a 64-bit JRE is not found. It is not | |
| mandatory to use the default JRE detected by the installer. Any | |
| installed Java 6 or later JRE (32-bit or 64-bit) may be used.</li> | |
| <li><strong>Tray icon</strong>: When Tomcat is run as a service, there | |
| will not be any tray icon present when Tomcat is running. Note that | |
| when choosing to run Tomcat at the end of installation, the tray | |
| icon will be used even if Tomcat was installed as a service.</li> | |
| <li>Refer to the | |
| <a href="windows-service-howto.html">Windows Service HOW-TO</a> | |
| for information on how to manage Tomcat as a Windows service. | |
| </li> | |
| </ul> | |
| </p> | |
| <p>The installer will create shortcuts allowing starting and configuring | |
| Tomcat. It is important to note that the Tomcat administration web | |
| application can only be used when Tomcat is running.</p> | |
| </blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Unix daemon"><!--()--></a><a name="Unix_daemon"><strong>Unix daemon</strong></a></font></td></tr><tr><td><blockquote> | |
| <p>Tomcat can be run as a daemon using the jsvc tool from the | |
| commons-daemon project. Source tarballs for jsvc are included with the | |
| Tomcat binaries, and need to be compiled. Building jsvc requires | |
| a C ANSI compiler (such as GCC), GNU Autoconf, and a JDK.</p> | |
| <p>Before running the script, the <code>JAVA_HOME</code> environment | |
| variable should be set to the base path of the JDK. Alternately, when | |
| calling the <code>./configure</code> script, the path of the JDK may | |
| be specified using the <code>--with-java</code> parameter, such as | |
| <code>./configure --with-java=/usr/java</code>.</p> | |
| <p>Using the following commands should result in a compiled jsvc binary, | |
| located in the <code>$CATALINA_HOME/bin</code> folder. This assumes | |
| that GNU TAR is used, and that <code>CATALINA_HOME</code> is an | |
| environment variable pointing to the base path of the Tomcat | |
| installation.</p> | |
| <p>Please note that you should use the GNU make (gmake) instead of | |
| the native BSD make on FreeBSD systems.</p> | |
| <div class="codeBox"><pre><code> | |
| cd $CATALINA_HOME/bin | |
| tar xvfz commons-daemon-native.tar.gz | |
| cd commons-daemon-1.0.x-native-src/unix | |
| ./configure | |
| make | |
| cp jsvc ../.. | |
| cd ../.. | |
| </code></pre></div> | |
| <p>Tomcat can then be run as a daemon using the following commands.</p> | |
| <div class="codeBox"><pre><code> | |
| CATALINA_BASE=$CATALINA_HOME | |
| cd $CATALINA_HOME | |
| ./bin/jsvc \ | |
| -classpath $CATALINA_HOME/bin/bootstrap.jar:$CATALINA_HOME/bin/tomcat-juli.jar \ | |
| -outfile $CATALINA_BASE/logs/catalina.out \ | |
| -errfile $CATALINA_BASE/logs/catalina.err \ | |
| -Dcatalina.home=$CATALINA_HOME \ | |
| -Dcatalina.base=$CATALINA_BASE \ | |
| -Djava.util.logging.manager=org.apache.juli.ClassLoaderLogManager \ | |
| -Djava.util.logging.config.file=$CATALINA_BASE/conf/logging.properties \ | |
| org.apache.catalina.startup.Bootstrap | |
| </code></pre></div> | |
| <p>You may also need to specify <code>-jvm server</code> if the JVM defaults | |
| to using a server VM rather than a client VM. This has been observed on | |
| OSX.</p> | |
| <p>jsvc has other useful parameters, such as <code>-user</code> which | |
| causes it to switch to another user after the daemon initialization is | |
| complete. This allows, for example, running Tomcat as a non privileged | |
| user while still being able to use privileged ports. Note that if you | |
| use this option and start Tomcat as root, you'll need to disable the | |
| <code>org.apache.catalina.security.SecurityListener</code> check that | |
| prevents Tomcat starting when running as root.</p> | |
| <p><code>jsvc --help</code> will return the full jsvc usage | |
| information. In particular, the <code>-debug</code> option is useful | |
| to debug issues running jsvc.</p> | |
| <p>The file <code>$CATALINA_HOME/bin/daemon.sh</code> can be used as a | |
| template for starting Tomcat automatically at boot time from | |
| <code>/etc/init.d</code> with jsvc.</p> | |
| <p>Note that the Commons-Daemon JAR file must be on your runtime classpath | |
| to run Tomcat in this manner. The Commons-Daemon JAR file is in the | |
| Class-Path entry of the bootstrap.jar manifest, but if you get a | |
| ClassNotFoundException or a NoClassDefFoundError for a Commons-Daemon | |
| class, add the Commons-Daemon JAR to the -cp argument when launching | |
| jsvc.</p> | |
| </blockquote></td></tr></table></td></tr><tr class="noPrint"><td width="20%" valign="top" nowrap class="noPrint"></td><td width="80%" valign="top" align="left"><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="comments_section" id="comments_section"><strong>Comments</strong></a></font></td></tr><tr><td><blockquote><p class="notice"><strong>Notice: </strong>This comments section collects your suggestions | |
| on improving documentation for Apache Tomcat.<br><br> | |
| If you have trouble and need help, read | |
| <a href="http://tomcat.apache.org/findhelp.html">Find Help</a> page | |
| and ask your question on the tomcat-users | |
| <a href="http://tomcat.apache.org/lists.html">mailing list</a>. | |
| Do not ask such questions here. This is not a Q&A section.<br><br> | |
| The Apache Comments System is explained <a href="./comments.html">here</a>. | |
| Comments may be removed by our moderators if they are either | |
| implemented or considered invalid/off-topic.</p><script type="text/javascript"><!--//--><![CDATA[//><!-- | |
| var comments_shortname = 'tomcat'; | |
| var comments_identifier = 'http://tomcat.apache.org/tomcat-7.0-doc/setup.html'; | |
| (function(w, d) { | |
| if (w.location.hostname.toLowerCase() == "tomcat.apache.org") { | |
| d.write('<div id="comments_thread"><\/div>'); | |
| var s = d.createElement('script'); | |
| s.type = 'text/javascript'; | |
| s.async = true; | |
| s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier; | |
| (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s); | |
| } | |
| else { | |
| d.write('<div id="comments_thread"><strong>Comments are disabled for this page at the moment.<\/strong><\/div>'); | |
| } | |
| })(window, document); | |
| //--><!]]></script></blockquote></td></tr></table></td></tr><!--FOOTER SEPARATOR--><tr><td colspan="2"><hr noshade size="1"></td></tr><!--PAGE FOOTER--><tr><td colspan="2"><div align="center"><font color="#525D76" size="-1"><em> | |
| Copyright © 1999-2017, Apache Software Foundation | |
| </em></font></div></td></tr></table></body></html> |