202 lines
14 KiB
HTML
202 lines
14 KiB
HTML
|
<!DOCTYPE html SYSTEM "about:legacy-compat">
|
||
|
|
<html lang="en"><head><META http-equiv="Content-Type" content="text/html; charset=UTF-8"><link href="./images/docs-stylesheet.css" rel="stylesheet" type="text/css"><title>Apache Tomcat 8 (8.0.53) - Tomcat Setup</title><meta name="author" content="Remy Maucherat"><script type="application/javascript" data-comments-identifier="tomcat-8.0-doc/setup">
|
||
|
|
"use strict"; // Enable strict mode
|
||
|
|
|
||
|
|
(function() {
|
||
|
|
var thisScript = document.currentScript;
|
||
|
|
if (!thisScript) { // Workaround for IE <= 11
|
||
|
|
var scripts = document.getElementsByTagName("script");
|
||
|
|
thisScript = scripts[scripts.length - 1];
|
||
|
|
}
|
||
|
|
document.addEventListener("DOMContentLoaded", (function() {
|
||
|
|
var commentsDiv = document.getElementById("comments_thread");
|
||
|
|
var commentsShortname = "tomcat";
|
||
|
|
var commentsIdentifier = "https://tomcat.apache.org/" +
|
||
|
|
thisScript.getAttribute("data-comments-identifier") + ".html";
|
||
|
|
|
||
|
|
(function(w, d) {
|
||
|
|
if (w.location.hostname.toLowerCase() == "tomcat.apache.org") {
|
||
|
|
var s = d.createElement("script");
|
||
|
|
s.type = "application/javascript";
|
||
|
|
s.async = true;
|
||
|
|
s.src = "https://comments.apache.org/show_comments.lua?site=" +
|
||
|
|
encodeURIComponent(commentsShortname) +
|
||
|
|
"&page=" + encodeURIComponent(commentsIdentifier);
|
||
|
|
d.head.appendChild(s);
|
||
|
|
} else {
|
||
|
|
commentsDiv.appendChild(d.createTextNode("Comments are disabled for this page at the moment."));
|
||
|
|
}
|
||
|
|
})(window, document);
|
||
|
|
}), false);
|
||
|
|
})();
|
||
|
|
</script></head><body><div id="wrapper"><header><div id="header"><div><div><div class="logo noPrint"><a href="https://tomcat.apache.org/"><img alt="Tomcat Home" src="./images/tomcat.png"></a></div><div style="height: 1px;"></div><div class="asfLogo noPrint"><a href="https://www.apache.org/" target="_blank"><img src="./images/asf-logo.svg" alt="The Apache Software Foundation" style="width: 266px; height: 83px;"></a></div><h1>Apache Tomcat 8</h1><div class="versionInfo">
|
||
|
|
Version 8.0.53,
|
||
|
|
<time datetime="2018-06-29">Jun 29 2018</time></div><div style="height: 1px;"></div><div style="clear: left;"></div></div></div></div></header><div id="middle"><div><div id="mainLeft" class="noprint"><div><nav><div><h2>Links</h2><ul><li><a href="index.html">Docs Home</a></li><li><a href="https://wiki.apache.org/tomcat/FAQ">FAQ</a></li><li><a href="#comments_section">User Comments</a></li></ul></div><div><h2>User Guide</h2><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="host-manager-howto.html">6) Host Manager</a></li><li><a href="realm-howto.html">7) Realms and AAA</a></li><li><a href="security-manager-howto.html">8) Security Manager</a></li><li><a href="jndi-resources-howto.html">9) JNDI Resources</a></li><li><a href="jndi-datasource-examples-howto.html">10) JDBC DataSources</a></li><li><a href="class-loader-howto.html">11) Classloading</a></li><li><a href="jasper-howto.html">12) JSPs</a></li><li><a href="ssl-howto.html">13) SSL/TLS</a></li><li><a href="ssi-howto.html">14) SSI</a></li><li><a href="cgi-howto.html">15) CGI</a></li><li><a href="proxy-howto.html">16) Proxy Support</a></li><li><a href="mbeans-descriptors-howto.html">17) MBeans Descriptors</a></li><li><a href="default-servlet.html">18) Default Servlet</a></li><li><a href="cluster-howto.html">19) Clustering</a></li><li><a href="balancer-howto.html">20) Load Balancer</a></li><li><a href="connectors.html">21) Connectors</a></li><li><a href="monitoring.html">22) Monitoring and Management</a></li><li><a href="logging.html">23) Logging</a></li><li><a href="apr.html">24) APR/Native</a></li><li><a href="virtual-hosting-howto.html">25) Virtual Hosting</a></li><li><a href="aio.html">26) Advanced IO</a></li><li><a href="extras.html">27) Additional Components</a></li><li><a href="maven-jars.html">28) Mavenized</a></li><li><a href="security-howto.html">29) Security Considerations</a></li><li><a href="windows-service-howto.html">30) Windows Service</a></li><li><a href="windows-auth-howto.html">31) Windows Authentication</a></li><li><a href="jdbc-pool.html">32) Tomcat's JDBC Pool</a></li><li><a href="web-socket-howto.html">33) WebSocket</a></li><li><a href="rewrite.html">34) Rewrite</a></li></ul></div><div><h2>Reference</h2><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.3 Javadocs</a></li><li><a href="elapi/index.html">EL 3.0 Javadocs</a></li><li><a href="websocketapi/index.html">WebSocket 1.1 Javadocs</a></li><li><a href="https://tomcat.apache.org/connectors-doc/">JK 1.2 Documentation</a></li></ul></div><div><h2>Apache Tomcat Development</h2><ul><li><a href="building.html">Building</a></li><li><a href="changelog.html">Changelog</a></li><li><a href="https://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></div></nav></div></div><div id="mainRight"><div id="content"><h2>Tomcat Setup</h2><h3 id="Table_of_Contents">Table of Contents</h3><div class="text">
|
||
|
|
<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>
|
||
|
|
</div><h3 id="Introduction">Introduction</h3><div class="text">
|
||
|
|
<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>
|
||
|
|
</div><h3 id="Windows">Windows</h3><div class="text">
|
||
|
|
|
||
|
|
<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>
|
||
|
|
|
||
|
|
|
||
|
|
<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 7 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 7 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><strong>Defaults</strong>: The defaults used by the installer may be
|
||
|
|
overridden by use of the <code>/C=<config file></code> command
|
||
|
|
line argument. The configuration file uses the format
|
||
|
|
<code>name=value</code> with each pair on a separate line. The names
|
||
|
|
of the available configuration options are:
|
||
|
|
<ul>
|
||
|
|
<li>JavaHome</li>
|
||
|
|
<li>TomcatPortShutdown</li>
|
||
|
|
<li>TomcatPortHttp</li>
|
||
|
|
<li>TomcatPortAjp</li>
|
||
|
|
<li>TomcatMenuEntriesEnable</li>
|
||
|
|
<li>TomcatShortcutAllUsers</li>
|
||
|
|
<li>TomcatServiceDefaultName</li>
|
||
|
|
<li>TomcatServiceName</li>
|
||
|
|
<li>TomcatServiceFileName</li>
|
||
|
|
<li>TomcatServiceManagerFileName</li>
|
||
|
|
<li>TomcatAdminEnable</li>
|
||
|
|
<li>TomcatAdminUsername</li>
|
||
|
|
<li>TomcatAdminPassword</li>
|
||
|
|
<li>TomcatAdminRoles</li>
|
||
|
|
</ul>
|
||
|
|
By using <code>/C=...</code> along with <code>/S</code> and
|
||
|
|
<code>/D=</code> it is possible to perform fully configured
|
||
|
|
unattended installs of Apache Tomact.
|
||
|
|
</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>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>
|
||
|
|
|
||
|
|
</div><h3 id="Unix_daemon">Unix daemon</h3><div class="text">
|
||
|
|
|
||
|
|
<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.1.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>When runnong on Java 9 you will need to additionally specify the
|
||
|
|
following when starting jsvc to avoid warnings on shutdown.</p>
|
||
|
|
<div class="codeBox"><pre><code>...
|
||
|
|
--add-opens=java.base/java.lang=ALL-UNNAMED \
|
||
|
|
--add-opens=java.base/java.io=ALL-UNNAMED \
|
||
|
|
--add-opens=java.rmi/sun.rmi.transport=ALL-UNNAMED \
|
||
|
|
...
|
||
|
|
</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>
|
||
|
|
|
||
|
|
</div><div class="noprint"><h3 id="comments_section">
|
||
|
|
Comments
|
||
|
|
</h3><div class="text"><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="https://tomcat.apache.org/findhelp.html">Find Help</a> page
|
||
|
|
and ask your question on the tomcat-users
|
||
|
|
<a href="https://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><div id="comments_thread"></div></div></div></div></div></div></div><footer><div id="footer">
|
||
|
|
Copyright © 1999-2018, The Apache Software Foundation
|
||
|
|
</div></footer></div></body></html>
|