webapps/docs/building.html - portal_platform/tomcat-cms - Gitiles

 <html><head><META http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><title>Apache Tomcat 7 (7.0.42) - Building Tomcat</title><meta name="author" content="Remy Maucherat, Tim Whittington"><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;}
         </style><style type="text/css">
             .wrapped-source code { display: block; background-color: transparent; }
             .wrapped-source div { margin: 0 0 0 1.25em; }
             .wrapped-source p { margin: 0 0 0 1.25em; text-indent: -1.25em; }
         </style><style type="text/css">
             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.42, Jul 2 2013</font></td><td><!--APACHE LOGO--><a href="http://www.apache.org/"><img src="./images/asf-logo.gif" align="right" alt="Apache Logo" border="0"></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</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><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="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>Building Tomcat</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="#Download_a_Java_Development_Kit_(JDK)_version_6">Download a Java Development Kit (JDK) version 6</a></li><li><a href="#Install_Apache_Ant_1.8.1_or_later">Install Apache Ant 1.8.1 or later</a></li><li><a href="#Checkout_or_obtain_the_source_code_for_Tomcat_7.0">Checkout or obtain the source code for Tomcat 7.0</a></li><li><a href="#Building_Tomcat">Building Tomcat</a></li><li><a href="#Building_with_Eclipse">Building with Eclipse</a></li><li><a href="#Building_with_other_IDEs">Building with other IDEs</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>
 Building Apache Tomcat from source is very easy, and is the first step to contributing to
 Tomcat. The following is a step by step guide.
 </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="Download a Java Development Kit (JDK) version 6"><!--()--></a><a name="Download_a_Java_Development_Kit_(JDK)_version_6"><strong>Download a Java Development Kit (JDK) version 6</strong></a></font></td></tr><tr><td><blockquote>

 <p>
 Building Apache Tomcat requires a JDK (version 6) to be installed. You can download one from<br>
 <a href="http://www.oracle.com/technetwork/java/javase/downloads/index.html">http://www.oracle.com/technetwork/java/javase/downloads/index.html</a><br>
 or from another JDK vendor.
 </p>

 <p>
 <b>IMPORTANT</b>: Set an environment variable JAVA_HOME to the pathname of the
 directory into which you installed the JDK release.
 </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="Install Apache Ant 1.8.1 or later"><!--()--></a><a name="Install_Apache_Ant_1.8.1_or_later"><strong>Install Apache Ant 1.8.1 or later</strong></a></font></td></tr><tr><td><blockquote>

 <p>
 Download a binary distribution of Ant 1.8.1 or later from
 <a href="http://ant.apache.org/bindownload.cgi">here</a>.
 </p>

 <p>
 Unpack the binary distribution into a convenient location so that the
 Ant release resides in its own directory (conventionally named
 <code>apache-ant-1.8.x</code>).  For the remainder of this guide,
 the symbolic name <code>${ant.home}</code> is used to refer to the full pathname of
  the Ant installation directory directory.
 </p>

 <p>
 <b>IMPORTANT</b>: Create an ANT_HOME environment variable to point the directory <code>${ant.home}</code>,
 and modify the PATH environment variable to include directory
 <code>${ant.home}/bin</code> in its list.  This makes the <code>ant</code> command line script
 available, which will be used to actually perform the build.
 </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="Checkout or obtain the source code for Tomcat 7.0"><!--()--></a><a name="Checkout_or_obtain_the_source_code_for_Tomcat_7.0"><strong>Checkout or obtain the source code for Tomcat 7.0</strong></a></font></td></tr><tr><td><blockquote>

   <p>
   Tomcat 7.0 SVN repository URL:
   <a href="http://svn.apache.org/repos/asf/tomcat/tc7.0.x/trunk/">http://svn.apache.org/repos/asf/tomcat/tc7.0.x/trunk/</a>
   </p>
   <p>
   Tomcat source packages:
   <a href="http://tomcat.apache.org/download-70.cgi">http://tomcat.apache.org/download-70.cgi</a>.
   </p>

   <p>
   Checkout the source using SVN, selecting a tag for released version or
   trunk for the current development code, or download and unpack a
   source package. For the remainder of this guide, the symbolic name
   <code>${tomcat.source}</code> is used to refer to the
   location where the source has been placed.
   </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="Building Tomcat"><!--()--></a><a name="Building_Tomcat"><strong>Building Tomcat</strong></a></font></td></tr><tr><td><blockquote>

 <p>
 Use the following commands to build Tomcat:
 <br>
 <code><br>
     cd ${tomcat.source}<br>
     ant<br>
 </code>
 </p>

 <p>
 <b>WARNING:</b> Running this command will download libraries required
   to build Tomcat to the <code>/usr/share/java</code> directory by default.
   On a typical Linux or MacOX system, an ordinary user
   will not have access to write to this directory, and, even if you do,
   it is likely not appropriate for you to write there. On Windows
   this usually corresponds to the <code>C:\usr\share\java</code> directory,
   unless Cygwin is used. Read below to learn how to customize the directory
   used to download the binaries.
 </p>

 <p>
 <b>NOTE:</b> Users accessing the Internet through a proxy must use a properties
   file to indicate to Ant the proxy configuration. Read below for details.
 </p>

 <p>
   The build can be controlled by creating a <code>${tomcat.source}/build.properties</code>
   file and adding the following content to it:
 <br>
 <code><br>
     # ----- Proxy setup -----<br>
     # Uncomment if using a proxy server.<br>
     #proxy.host=proxy.domain<br>
     #proxy.port=8080<br>
     #proxy.use=on<br>
 <br>
     # ----- Default Base Path for Dependent Packages -----<br>
     # Replace this path with the directory path where<br>
     # dependencies binaries should be downloaded.<br>
     base.path=/home/me/some-place-to-download-to<br>
 </code>
 </p>

 <p>
 Once the build has completed successfully, a usable Tomcat installation will have been
 produced in the <code>${tomcat.source}/output/build</code> directory, and can be started
 and stopped with the usual scripts.
 </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="Building with Eclipse"><!--()--></a><a name="Building_with_Eclipse"><strong>Building with Eclipse</strong></a></font></td></tr><tr><td><blockquote>

 <p>
 <b>IMPORTANT:</b> This is not a supported means of building Tomcat; this information is
 provided without warranty :-).
 The only supported means of building Tomcat is with the Ant build described above.
 However, some developers like to work on Java code with a Java IDE,
 and the following steps have been used by some developers.
 </p>

 <p>
 <b>NOTE:</b> This will not let you build everything under Eclipse;
 the build process requires use of Ant for the many stages that aren't
 simple Java compilations.
 However, it will allow you to view and edit the Java code,
 get warnings, reformat code, perform refactorings, run Tomcat
 under the IDE, and so on.
 </p>

 <p>
 <b>WARNING:</b> Do not forget to create and configure
   <code>${tomcat.source}/build.properties</code> file as described above
   before running any Ant targets.
 </p>

 <p>
 Sample Eclipse project files and launch targets are provided in the
 <code>res/ide-support/eclipse</code> directory of the source tree.
 The instructions below will automatically copy these into the required locations.
 </p>
 <p>
 An Ant target is provided as a convenience to download all binary dependencies, and to create
 the Eclipse project and classpath files in the root of the source tree.
 <br>
 <code><br>
     cd ${tomcat.source}<br>
     ant ide-eclipse<br>
 </code>
 </p>

 <p>
 Start Eclipse and create a new Workspace.
 </p>

 <p>
 Open the <em>Preferences</em> dialog and then select <em>Java-&gt;Build Path-&gt;Classpath
 Variables</em> to add two new <em>Classpath Variables</em>:
 </p>

 <p>
 <table border="1">
  <tr><td>TOMCAT_LIBS_BASE</td><td>The same location as the <code>base.path</code>
   setting in <code>build.properties</code>, where the binary dependencies have been downloaded</td></tr>
  <tr><td>ANT_HOME</td><td>the base path of Ant 1.8.1 or later</td></tr>
 </table>
 </p>

 <p>
 Use <em>File-&gt;Import</em> and choose <em>Existing Projects into Workspace</em>.
 From there choose the root directory of the Tomcat source tree (<code>${tomcat.source}</code>)
 and import the Tomcat project located there.
 </p>

 <p>
 <code>start-tomcat</code> and <code>stop-tomcat</code> launch configurations are provided in
 <code>res/ide-support/eclipse</code> and will be available in the <em>Run-&gt;Run Configurations</em>
 dialog. Use these to start and stop Tomcat from Eclipse.
 <br>If you want to configure these yourself (or are using a different IDE)
 then use <code>org.apache.catalina.startup.Bootstrap</code> as the main class,
 <code>start</code>/<code>stop</code> etc. as program arguments, and specify <code>-Dcatalina.home=...</code>
 (with the name of your build directory) as VM arguments.
 </p>

 <p>
 Tweaking a few formatting preferences will make it much easier to keep consistent with Tomcat
 coding conventions (and have your contributions accepted):
 </p>
 <p>
 <table border="1">
   <tr><td>Java -&gt; Code Style -&gt; Formatter -&gt; Edit...</td>
   <td>Tab policy: Spaces only<br>Tab and Indentation size: 4</td></tr>
   <tr><td>General -&gt; Editors -&gt; Text Editors</td>
   <td>Displayed tab width: 2<br>Insert spaces for tabs<br>Show whitespace characters (optional)</td></tr>
   <tr><td>XML -&gt; XML Files -&gt; Editor</td><td>Indent using spaces<br>Indentation size: 2</td></tr>
   <tr><td>Ant -&gt; Editor -&gt; Formatter</td><td>Tab size: 2<br>Use tab character instead of spaces: unchecked</td></tr>
 </table>
 </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="Building with other IDEs"><!--()--></a><a name="Building_with_other_IDEs"><strong>Building with other IDEs</strong></a></font></td></tr><tr><td><blockquote>
 <p>
 The same general approach should work for most IDEs; it has been reported
 to work in IntelliJ IDEA, for example.
 </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&amp;A section.<br><br>
               The Apache Comments System is explained <a href="/tomcat-7.0-doc/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/building.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 &copy; 1999-2013, Apache Software Foundation
         </em></font></div></td></tr></table></body></html>
	<html><head><META http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><title>Apache Tomcat 7 (7.0.42) - Building Tomcat</title><meta name="author" content="Remy Maucherat, Tim Whittington"><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;}
	</style><style type="text/css">
	.wrapped-source code { display: block; background-color: transparent; }
	.wrapped-source div { margin: 0 0 0 1.25em; }
	.wrapped-source p { margin: 0 0 0 1.25em; text-indent: -1.25em; }
	</style><style type="text/css">
	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.42, Jul 2 2013</font></td><td><!--APACHE LOGO--><a href="http://www.apache.org/"><img src="./images/asf-logo.gif" align="right" alt="Apache Logo" border="0"></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</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><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="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>Building Tomcat</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="#Download_a_Java_Development_Kit_(JDK)_version_6">Download a Java Development Kit (JDK) version 6</a></li><li><a href="#Install_Apache_Ant_1.8.1_or_later">Install Apache Ant 1.8.1 or later</a></li><li><a href="#Checkout_or_obtain_the_source_code_for_Tomcat_7.0">Checkout or obtain the source code for Tomcat 7.0</a></li><li><a href="#Building_Tomcat">Building Tomcat</a></li><li><a href="#Building_with_Eclipse">Building with Eclipse</a></li><li><a href="#Building_with_other_IDEs">Building with other IDEs</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>
	Building Apache Tomcat from source is very easy, and is the first step to contributing to
	Tomcat. The following is a step by step guide.
	</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="Download a Java Development Kit (JDK) version 6"><!--()--></a><a name="Download_a_Java_Development_Kit_(JDK)_version_6"><strong>Download a Java Development Kit (JDK) version 6</strong></a></font></td></tr><tr><td><blockquote>

	<p>
	Building Apache Tomcat requires a JDK (version 6) to be installed. You can download one from<br>
	<a href="http://www.oracle.com/technetwork/java/javase/downloads/index.html">http://www.oracle.com/technetwork/java/javase/downloads/index.html</a><br>
	or from another JDK vendor.
	</p>

	<p>
	<b>IMPORTANT</b>: Set an environment variable JAVA_HOME to the pathname of the
	directory into which you installed the JDK release.
	</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="Install Apache Ant 1.8.1 or later"><!--()--></a><a name="Install_Apache_Ant_1.8.1_or_later"><strong>Install Apache Ant 1.8.1 or later</strong></a></font></td></tr><tr><td><blockquote>

	<p>
	Download a binary distribution of Ant 1.8.1 or later from
	<a href="http://ant.apache.org/bindownload.cgi">here</a>.
	</p>

	<p>
	Unpack the binary distribution into a convenient location so that the
	Ant release resides in its own directory (conventionally named
	<code>apache-ant-1.8.x</code>). For the remainder of this guide,
	the symbolic name <code>${ant.home}</code> is used to refer to the full pathname of
	the Ant installation directory directory.
	</p>

	<p>
	<b>IMPORTANT</b>: Create an ANT_HOME environment variable to point the directory <code>${ant.home}</code>,
	and modify the PATH environment variable to include directory
	<code>${ant.home}/bin</code> in its list. This makes the <code>ant</code> command line script
	available, which will be used to actually perform the build.
	</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="Checkout or obtain the source code for Tomcat 7.0"><!--()--></a><a name="Checkout_or_obtain_the_source_code_for_Tomcat_7.0"><strong>Checkout or obtain the source code for Tomcat 7.0</strong></a></font></td></tr><tr><td><blockquote>

	<p>
	Tomcat 7.0 SVN repository URL:
	<a href="http://svn.apache.org/repos/asf/tomcat/tc7.0.x/trunk/">http://svn.apache.org/repos/asf/tomcat/tc7.0.x/trunk/</a>
	</p>
	<p>
	Tomcat source packages:
	<a href="http://tomcat.apache.org/download-70.cgi">http://tomcat.apache.org/download-70.cgi</a>.
	</p>

	<p>
	Checkout the source using SVN, selecting a tag for released version or
	trunk for the current development code, or download and unpack a
	source package. For the remainder of this guide, the symbolic name
	<code>${tomcat.source}</code> is used to refer to the
	location where the source has been placed.
	</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="Building Tomcat"><!--()--></a><a name="Building_Tomcat"><strong>Building Tomcat</strong></a></font></td></tr><tr><td><blockquote>

	<p>
	Use the following commands to build Tomcat:
	<br>
	<code><br>
	cd ${tomcat.source}<br>
	ant<br>
	</code>
	</p>

	<p>
	<b>WARNING:</b> Running this command will download libraries required
	to build Tomcat to the <code>/usr/share/java</code> directory by default.
	On a typical Linux or MacOX system, an ordinary user
	will not have access to write to this directory, and, even if you do,
	it is likely not appropriate for you to write there. On Windows
	this usually corresponds to the <code>C:\usr\share\java</code> directory,
	unless Cygwin is used. Read below to learn how to customize the directory
	used to download the binaries.
	</p>

	<p>
	<b>NOTE:</b> Users accessing the Internet through a proxy must use a properties
	file to indicate to Ant the proxy configuration. Read below for details.
	</p>

	<p>
	The build can be controlled by creating a <code>${tomcat.source}/build.properties</code>
	file and adding the following content to it:
	<br>
	<code><br>
	# ----- Proxy setup -----<br>
	# Uncomment if using a proxy server.<br>
	#proxy.host=proxy.domain<br>
	#proxy.port=8080<br>
	#proxy.use=on<br>
	<br>
	# ----- Default Base Path for Dependent Packages -----<br>
	# Replace this path with the directory path where<br>
	# dependencies binaries should be downloaded.<br>
	base.path=/home/me/some-place-to-download-to<br>
	</code>
	</p>

	<p>
	Once the build has completed successfully, a usable Tomcat installation will have been
	produced in the <code>${tomcat.source}/output/build</code> directory, and can be started
	and stopped with the usual scripts.
	</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="Building with Eclipse"><!--()--></a><a name="Building_with_Eclipse"><strong>Building with Eclipse</strong></a></font></td></tr><tr><td><blockquote>

	<p>
	<b>IMPORTANT:</b> This is not a supported means of building Tomcat; this information is
	provided without warranty :-).
	The only supported means of building Tomcat is with the Ant build described above.
	However, some developers like to work on Java code with a Java IDE,
	and the following steps have been used by some developers.
	</p>

	<p>
	<b>NOTE:</b> This will not let you build everything under Eclipse;
	the build process requires use of Ant for the many stages that aren't
	simple Java compilations.
	However, it will allow you to view and edit the Java code,
	get warnings, reformat code, perform refactorings, run Tomcat
	under the IDE, and so on.
	</p>

	<p>
	<b>WARNING:</b> Do not forget to create and configure
	<code>${tomcat.source}/build.properties</code> file as described above
	before running any Ant targets.
	</p>

	<p>
	Sample Eclipse project files and launch targets are provided in the
	<code>res/ide-support/eclipse</code> directory of the source tree.
	The instructions below will automatically copy these into the required locations.
	</p>
	<p>
	An Ant target is provided as a convenience to download all binary dependencies, and to create
	the Eclipse project and classpath files in the root of the source tree.
	<br>
	<code><br>
	cd ${tomcat.source}<br>
	ant ide-eclipse<br>
	</code>
	</p>

	<p>
	Start Eclipse and create a new Workspace.
	</p>

	<p>
	Open the <em>Preferences</em> dialog and then select <em>Java->Build Path->Classpath
	Variables</em> to add two new <em>Classpath Variables</em>:
	</p>

	<p>
	<table border="1">
	<tr><td>TOMCAT_LIBS_BASE</td><td>The same location as the <code>base.path</code>
	setting in <code>build.properties</code>, where the binary dependencies have been downloaded</td></tr>
	<tr><td>ANT_HOME</td><td>the base path of Ant 1.8.1 or later</td></tr>
	</table>
	</p>

	<p>
	Use <em>File->Import</em> and choose <em>Existing Projects into Workspace</em>.
	From there choose the root directory of the Tomcat source tree (<code>${tomcat.source}</code>)
	and import the Tomcat project located there.
	</p>

	<p>
	<code>start-tomcat</code> and <code>stop-tomcat</code> launch configurations are provided in
	<code>res/ide-support/eclipse</code> and will be available in the <em>Run->Run Configurations</em>
	dialog. Use these to start and stop Tomcat from Eclipse.
	<br>If you want to configure these yourself (or are using a different IDE)
	then use <code>org.apache.catalina.startup.Bootstrap</code> as the main class,
	<code>start</code>/<code>stop</code> etc. as program arguments, and specify <code>-Dcatalina.home=...</code>
	(with the name of your build directory) as VM arguments.
	</p>

	<p>
	Tweaking a few formatting preferences will make it much easier to keep consistent with Tomcat
	coding conventions (and have your contributions accepted):
	</p>
	<p>
	<table border="1">
	<tr><td>Java -> Code Style -> Formatter -> Edit...</td>
	<td>Tab policy: Spaces only<br>Tab and Indentation size: 4</td></tr>
	<tr><td>General -> Editors -> Text Editors</td>
	<td>Displayed tab width: 2<br>Insert spaces for tabs<br>Show whitespace characters (optional)</td></tr>
	<tr><td>XML -> XML Files -> Editor</td><td>Indent using spaces<br>Indentation size: 2</td></tr>
	<tr><td>Ant -> Editor -> Formatter</td><td>Tab size: 2<br>Use tab character instead of spaces: unchecked</td></tr>
	</table>
	</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="Building with other IDEs"><!--()--></a><a name="Building_with_other_IDEs"><strong>Building with other IDEs</strong></a></font></td></tr><tr><td><blockquote>
	<p>
	The same general approach should work for most IDEs; it has been reported
	to work in IntelliJ IDEA, for example.
	</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="/tomcat-7.0-doc/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/building.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-2013, Apache Software Foundation
	</em></font></div></td></tr></table></body></html>