blob: ab1c5892b58cffba3ca22657a9cd8101fa720773 [file] [log] [blame]
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Apache TomEE</title>
<meta name="description"
content="Apache TomEE is a lightweight, yet powerful, JavaEE Application server with feature rich tooling." />
<meta name="keywords" content="tomee,asf,apache,javaee,jee,shade,embedded,test,junit,applicationcomposer,maven,arquillian" />
<meta name="author" content="Luka Cvetinovic for Codrops" />
<link rel="icon" href="favicon.ico">
<link rel="icon" type="image/png" href="favicon.png">
<meta name="msapplication-TileColor" content="#80287a">
<meta name="theme-color" content="#80287a">
<link rel="stylesheet" type="text/css" href="css/normalize.css">
<link rel="stylesheet" type="text/css" href="css/bootstrap.css">
<link rel="stylesheet" type="text/css" href="css/owl.css">
<link rel="stylesheet" type="text/css" href="css/animate.css">
<link rel="stylesheet" type="text/css" href="fonts/font-awesome-4.1.0/css/font-awesome.min.css">
<link rel="stylesheet" type="text/css" href="fonts/eleganticons/et-icons.css">
<link rel="stylesheet" type="text/css" href="css/jqtree.css">
<link rel="stylesheet" type="text/css" href="css/idea.css">
<link rel="stylesheet" type="text/css" href="css/cardio.css">
<script type="text/javascript">
<!-- Matomo -->
var _paq = window._paq = window._paq || [];
/* tracker methods like "setCustomDimension" should be called before "trackPageView" */
/* We explicitly disable cookie tracking to avoid privacy issues */
_paq.push(['disableCookies']);
_paq.push(['trackPageView']);
_paq.push(['enableLinkTracking']);
(function () {
var u = "//matomo.privacy.apache.org/";
_paq.push(['setTrackerUrl', u + 'matomo.php']);
_paq.push(['setSiteId', '5']);
var d = document, g = d.createElement('script'), s = d.getElementsByTagName('script')[0];
g.async = true;
g.src = u + 'matomo.js';
s.parentNode.insertBefore(g, s);
})();
<!-- End Matomo Code -->
</script>
</head>
<body>
<div class="preloader">
<img src="img/loader.gif" alt="Preloader image">
</div>
<nav class="navbar">
<div class="container">
<div class="row"> <div class="col-md-12">
<!-- Brand and toggle get grouped for better mobile display -->
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="/" title="Apache TomEE">
<span>
<img
src="img/apache_tomee-logo.svg"
onerror="this.src='img/apache_tomee-logo.jpg'"
height="50"
>
</span>
</a>
</div>
<!-- Collect the nav links, forms, and other content for toggling -->
<div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
<ul class="nav navbar-nav navbar-right main-nav">
<li><a href="docs.html">Documentation</a></li>
<li><a href="community/index.html">Community</a></li>
<li><a href="security/security.html">Security</a></li>
<li><a class="btn btn-accent accent-orange no-shadow" href="download.html">Downloads</a></li>
</ul>
</div>
<!-- /.navbar-collapse -->
</div></div>
</div>
<!-- /.container-fluid -->
</nav>
<div id="main-block" class="container main-block">
<div class="row title">
<div class="col-md-12">
<div class='page-header'>
<h1>Tomcat Installation</h1>
</div>
</div>
</div>
<div class="row">
<div class="col-md-12">
<div class="sect1">
<h2 id="_overview">Overview</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Tomcat installation is very simple, and can be describes as "Unpack and Run".
These instructions were written using Tomcat 6.0.14 but any recent 6.x version should work.
If you are comfortable with the CLI, these the following quick instructions will get you going ASAP;
otherwise skip to the <a href="#_download_tomcat">Download Tomcat</a> section.</p>
</div>
<div class="olist arabic">
<ol class="arabic">
<li>
<p>Download Tomcat zip or tar.gz</p>
</li>
<li>
<p>Unpack archive</p>
</li>
<li>
<p>Platform specific setup</p>
<div class="ulist">
<ul>
<li>
<p><a href="#_openejb_unix">OpenEJB - Unix</a>.
If zip was unpacked, <em>chmod u+x bin/</em>.sh*</p>
</li>
<li>
<p><a href="#_openejb_windows">OpenEJB - Windows</a> <em>set JAVA_HOME =C:\your\java\installation</em></p>
</li>
</ul>
</div>
</li>
<li>
<p>Run bin/startup.sh or bin/startup.bat</p>
</li>
<li>
<p>Visit <a href="http://localhost:8080/" class="bare">http://localhost:8080/</a></p>
</li>
<li>
<p>Run bin/shutdown.sh or bin/shutdown.bat</p>
</li>
</ol>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_download_tomcat">Download Tomcat</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Download Tomcat 6 zip file from <a href="http://tomcat.apache.org/download-60.cgi#6.0.14">here</a> .</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_unpack_tomcat">Unpack Tomcat</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Unpack the Tomcat zip file which will create a new directory containing the complete Tomcat installation.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-console" data-lang="console">C:&gt;jar -xvf apache-tomcat-6.0.14.zip
created: apache-tomcat-6.0.14/
created: apache-tomcat-6.0.14/bin/
created: apache-tomcat-6.0.14/conf/
...snip...
C:&gt;dir apache-tomcat-6.0.14 Volume in drive C has no label.
Volume Serial Number is 0000-0000
Directory of C:\apache-tomcat-6.0.14
09/20/2007 09:14 PM .
09/20/2007 09:14 PM ..
09/20/2007 09:15 PM bin
09/20/2007 09:15 PM conf
09/20/2007 09:15 PM lib
07/20/2007 04:20 AM 11,560 LICENSE
09/20/2007 09:14 PM logs
07/20/2007 04:20 AM 556 NOTICE
07/20/2007 04:20 AM 6,656 RELEASE-NOTES
07/20/2007 04:20 AM 5,829 RUNNING.txt
09/20/2007 09:14 PM temp
09/20/2007 09:14 PM webapps
09/20/2007 09:14 PM work
4 File(s) 24,601 bytes 9 Dir(s) 5,085,085,696 bytes free</code></pre>
</div>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-console" data-lang="console">$ jar -xvf apache-tomcat-6.0.14.zip
created: apache-tomcat-6.0.14/
created: apache-tomcat-6.0.14/bin/
created: apache-tomcat-6.0.14/conf/
...snip...
$ ls apache-tomcat-6.0.14/
LICENSE RELEASE-NOTES bin/ lib/ temp/ work/
NOTICE RUNNING.txt conf/ logs/ webapps/</code></pre>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_openejb_windows">OpenEJB - Windows</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Set JAVA_HOME environment variable</p>
</div>
<div class="paragraph">
<p>For Windows users, the Tomcat shell scripts must know the location of the Java installation, and this is done with environment variables.
The following command will set the JAVA_HOME environment variable:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-console" data-lang="console">C:&gt;set JAVA_HOME =C:\your\java\installation</code></pre>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_openejb_unix">OpenEJB - Unix</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Make shell scripts executable</p>
</div>
<div class="paragraph">
<p>For Unix users, the shell scripts in the Tomcat installation are not executable by default, so in order to execute them, you must set mark them as executable.
If you unpacked the Tomcat tar.gz file, the scripts are already executable. The following command will make all shell scripts executable:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-console" data-lang="console">apache-tomcat-6.0.14$ chmod u+x bin/*.sh</code></pre>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_start_tomcat">Start Tomcat</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Execute the following command to start the Tomcat server:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-console" data-lang="console">C:&gt;cd apache-tomcat-6.0.14\bin
C:\apache-tomcat-6.0.14\bin&gt;startup.bat
Using CATALINA_BASE: C:\apache-tomcat-6.0.14
Using CATALINA_HOME: C:\apache-tomcat-6.0.14
Using CATALINA_TMPDIR: C:\apache-tomcat-6.0.14\temp
Using JRE_HOME: C:\your\java\installation</code></pre>
</div>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-console" data-lang="console">$ cd apache-tomcat-6.0.14/bin
apache-tomcat-6.0.14/bin$ ./startup.sh
Using CATALINA_BASE: /your/tomcat/installation/apache-tomcat-6.0.14
Using CATALINA_HOME: /your/tomcat/installation/apache-tomcat-6.0.14
Using CATALINA_TMPDIR: /your/tomcat/installation/apache-tomcat-6.0.14/temp
Using JRE_HOME: /your/java/installation</code></pre>
</div>
</div>
<div class="paragraph">
<p><em>NOTE:</em> Your output will be different from the example above due to differences in installation location.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_verify_tomcat_is_running">Verify Tomcat is Running</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Visit <a href="http://localhost:8080/" class="bare">http://localhost:8080/</a> and you should see the Tomcat welcome page.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_stop_tomcat">Stop Tomcat</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Shutdown Tomcat by executing the following command:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-console" data-lang="console">C:\apache-tomcat-6.0.14\bin&gt;shutdown.bat
Using CATALINA_BASE: C:\apache-tomcat-6.0.14
Using CATALINA_HOME: C:\apache-tomcat-6.0.14
Using CATALINA_TMPDIR: C:\apache-tomcat-6.0.14\temp
Using JRE_HOME: C:\your\java\installation</code></pre>
</div>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-console" data-lang="console"> apache-tomcat-6.0.14/bin$ ./shutdown.sh
Using CATALINA_BASE: /your/tomcat/installation/apache-tomcat-6.0.14
Using CATALINA_HOME: /your/tomcat/installation/apache-tomcat-6.0.14
Using CATALINA_TMPDIR: /your/tomcat/installation/apache-tomcat-6.0.14/temp
Using JRE_HOME: /your/java/installation</code></pre>
</div>
</div>
<div class="paragraph">
<p><em>NOTE:</em> Your output will be different from the example above due to differences in installation locations.</p>
</div>
</div>
</div>
</div>
</div>
</div>
<div style="margin-bottom: 30px;"></div>
<footer>
<div class="container">
<div class="row">
<div class="col-sm-6 text-center-mobile">
<h3 class="white">Be simple. Be certified. Be Tomcat.</h3>
<h5 class="light regular light-white">"A good application in a good server"</h5>
<ul class="social-footer">
<li><a href="https://www.facebook.com/ApacheTomEE/"><i class="fa fa-facebook"></i></a></li>
<li><a href="https://twitter.com/apachetomee"><i class="fa fa-twitter"></i></a></li>
</ul>
<h5 class="light regular light-white">
<a href="privacy-policy.html" class="white">Privacy Policy</a>
</h5>
</div>
<div class="col-sm-6 text-center-mobile">
<div class="row opening-hours">
<div class="col-sm-3 text-center-mobile">
<h5><a href="latest/docs/" class="white">Documentation</a></h5>
<ul class="list-unstyled">
<li><a href="latest/docs/admin/configuration/index.html" class="regular light-white">How to configure</a></li>
<li><a href="latest/docs/admin/file-layout.html" class="regular light-white">Dir. Structure</a></li>
<li><a href="latest/docs/developer/testing/index.html" class="regular light-white">Testing</a></li>
<li><a href="latest/docs/admin/cluster/index.html" class="regular light-white">Clustering</a></li>
</ul>
</div>
<div class="col-sm-3 text-center-mobile">
<h5><a href="latest/examples/" class="white">Examples</a></h5>
<ul class="list-unstyled">
<li><a href="latest/examples/simple-cdi-interceptor.html" class="regular light-white">CDI Interceptor</a></li>
<li><a href="latest/examples/rest-cdi.html" class="regular light-white">REST with CDI</a></li>
<li><a href="latest/examples/ejb-examples.html" class="regular light-white">EJB</a></li>
<li><a href="latest/examples/jsf-managedBean-and-ejb.html" class="regular light-white">JSF</a></li>
</ul>
</div>
<div class="col-sm-3 text-center-mobile">
<h5><a href="community/index.html" class="white">Community</a></h5>
<ul class="list-unstyled">
<li><a href="community/contributors.html" class="regular light-white">Contributors</a></li>
<li><a href="community/social.html" class="regular light-white">Social</a></li>
<li><a href="community/sources.html" class="regular light-white">Sources</a></li>
</ul>
</div>
<div class="col-sm-3 text-center-mobile">
<h5><a href="security/index.html" class="white">Security</a></h5>
<ul class="list-unstyled">
<li><a href="https://apache.org/security" target="_blank" class="regular light-white">Apache Security</a></li>
<li><a href="https://apache.org/security/projects.html" target="_blank" class="regular light-white">Security Projects</a></li>
<li><a href="https://cve.mitre.org" target="_blank" class="regular light-white">CVE</a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="row bottom-footer text-center-mobile">
<div class="col-sm-12 light-white">
<p>Copyright &copy; 1999-2022 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache TomEE, TomEE, Apache, the Apache feather logo, and the Apache TomEE project logo are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.</p>
</div>
</div>
</div>
</footer>
<!-- Holder for mobile navigation -->
<div class="mobile-nav">
<ul>
<li><a hef="latest/docs/admin/index.html">Administrators</a>
<li><a hef="latest/docs/developer/index.html">Developers</a>
<li><a hef="latest/docs/advanced/index.html">Advanced</a>
<li><a hef="community/index.html">Community</a>
</ul>
<a href="#" class="close-link"><i class="arrow_up"></i></a>
</div>
<!-- Scripts -->
<script src="js/jquery-1.11.1.min.js"></script>
<script src="js/owl.carousel.min.js"></script>
<script src="js/bootstrap.min.js"></script>
<script src="js/wow.min.js"></script>
<script src="js/typewriter.js"></script>
<script src="js/jquery.onepagenav.js"></script>
<script src="js/tree.jquery.js"></script>
<script src="js/highlight.pack.js"></script>
<script src="js/main.js"></script>
</body>
</html>