Gitiles
Code Review Sign In
source.supwisdom.com / UniIdentify / tomcat / fd5ee81fec460cbe9ad65f300b0faf1bf03c19bc / . / tomcat-uid / webapps / docs / setup.html
blob: c89dfde9fd1650634732d97bebf0aaf47725f985 [file] [log] [blame]
Hongqing Liufd5ee812014-05-10 16:32:51 +0800[diff] [blame^]1<html><head><META http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><title>Apache Tomcat 6.0 (6.0.39) - Tomcat Setup</title><meta name="author" content="Remy Maucherat"><style type="text/css" media="print">
2 .noPrint {display: none;}
3 td#mainBody {width: 100%;}
4 </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="
5 The Apache Tomcat Servlet/JSP Container
6 " border="0"></a></td><td><h1><font face="arial,helvetica,sanserif">Apache Tomcat 6.0</font></h1><font face="arial,helvetica,sanserif">Version 6.0.39, Jan 27 2014</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="noshade" size="1"></td></tr><tr><!--LEFT SIDE NAVIGATION--><td width="20%" valign="top" nowrap="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></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 width="80%" valign="top" align="left" id="mainBody"><h1>Apache Tomcat 6.0</h1><h2>Tomcat Setup</h2><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>
7<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>
8</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>
9 <p>
10 There are several ways to set up Tomcat for running on different
11 platforms. The main documentation for this is a file called
12 <a href="RUNNING.txt">RUNNING.txt</a>. We encourage you to refer to that
13 file if the information below does not answer some of your questions.
14 </p>
15 </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>
16
17 <p>
18 Installing Tomcat on Windows can be done easily using the Windows
19 installer. Its interface and functionality is similar to other wizard
20 based installers, with only a few items of interest.
21 </p>
22
23 <p>
24 <ul>
25 <li><strong>Installation as a service</strong>: Tomcat will be
26 installed as a Windows service no matter what setting is selected.
27 Using the checkbox on the component page sets the service as "auto"
28 startup, so that Tomcat is automatically started when Windows
29 starts. For optimal security, the service should be run as a
30 separate user, with reduced permissions (see the Windows Services
31 administration tool and its documentation).</li>
32 <li><strong>Java location</strong>: The installer will provide a default
33 JRE to use to run the service. The installer uses the registry to
34 determine the base path of a Java 5 or later JRE, including the JRE
35 installed as part of the full JDK. When running on a 64-bit
36 operating system, the installer will first look for a 64-bit JRE and
37 only look for a 32-bit JRE if a 64-bit JRE is not found. It is not
38 mandatory to use the default JRE detected by the installer. Any
39 installed Java 5 or later JRE (32-bit or 64-bit) may be used.</li>
40 <li><strong>Tray icon</strong>: When Tomcat is run as a service, there
41 will not be any tray icon present when Tomcat is running. Note that
42 when choosing to run Tomcat at the end of installation, the tray
43 icon will be used even if Tomcat was installed as a service.</li>
44 <li>Refer to the
45 <a href="windows-service-howto.html">Windows Service HOW-TO</a>
46 for information on how to manage Tomcat as a Windows service.
47 </li>
48 </ul>
49 </p>
50
51 <p>The installer will create shortcuts allowing starting and configuring
52 Tomcat. It is important to note that the Tomcat administration web
53 application can only be used when Tomcat is running.</p>
54
55 </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>
56
57 <p>Tomcat can be run as a daemon using the jsvc tool from the
58 commons-daemon project. Source tarballs for jsvc are included with the
59 Tomcat binaries, and need to be compiled. Building jsvc requires
60 a C ANSI compiler (such as GCC), GNU Autoconf, and a JDK.</p>
61
62 <p>Before running the script, the <code>JAVA_HOME</code> environment
63 variable should be set to the base path of the JDK. Alternately, when
64 calling the <code>./configure</code> script, the path of the JDK may
65 be specified using the <code>--with-java</code> parameter, such as
66 <code>./configure --with-java=/usr/java</code>.</p>
67
68 <p>Using the following commands should result in a compiled jsvc binary,
69 located in the <code>$CATALINA_HOME/bin</code> folder. This assumes
70 that GNU TAR is used, and that <code>CATALINA_HOME</code> is an
71 environment variable pointing to the base path of the Tomcat
72 installation.</p>
73
74 <p>Please note that you should use the GNU make (gmake) instead of
75 the native BSD make on FreeBSD systems.</p>
76
77<div align="left"><table cellspacing="4" cellpadding="0" border="0"><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>
78 cd $CATALINA_HOME/bin
79 tar xvfz commons-daemon-native.tar.gz
80 cd commons-daemon-1.0.x-native-src/unix
81 ./configure
82 make
83 cp jsvc ../..
84 cd ../..
85</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></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 cellspacing="4" cellpadding="0" border="0"><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>
90 CATALINA_BASE=$CATALINA_HOME
91 cd $CATALINA_HOME
92 ./bin/jsvc \
93 -classpath $CATALINA_HOME/bin/bootstrap.jar \
94 -outfile $CATALINA_BASE/logs/catalina.out \
95 -errfile $CATALINA_BASE/logs/catalina.err \
96 -Dcatalina.home=$CATALINA_HOME \
97 -Dcatalina.base=$CATALINA_BASE \
98 -Djava.util.logging.manager=org.apache.juli.ClassLoaderLogManager \
99 -Djava.util.logging.config.file=$CATALINA_BASE/conf/logging.properties \
100 org.apache.catalina.startup.Bootstrap
101</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>
102
103 <p>jsvc has other useful parameters, such as <code>-user</code> which
104 causes it to switch to another user after the daemon initialization is
105 complete. This allows, for example, running Tomcat as a non privileged
106 user while still being able to use privileged ports.
107 <code>jsvc --help</code> will return the full jsvc usage
108 information. In particular, the <code>-debug</code> option is useful
109 to debug issues running jsvc.</p>
110
111 <p>The file <code>$CATALINA_HOME/bin/daemon.sh</code> can be used as a
112 template for starting Tomcat automatically at boot time from
113 <code>/etc/init.d</code> with jsvc.</p>
114
115 <p>Note that the Commons-Daemon JAR file must be on your runtime classpath
116 to run Tomcat in this manner. The Commons-Daemon JAR file is in the
117 Class-Path entry of the bootstrap.jar manifest, but if you get a
118 ClassNotFoundException or a NoClassDefFoundError for a Commons-Daemon
119 class, add the Commons-Daemon JAR to the -cp argument when launching
120 jsvc.</p>
121
122 </blockquote></td></tr></table></td></tr><!--FOOTER SEPARATOR--><tr><td colspan="2"><hr noshade="noshade" size="1"></td></tr><!--PAGE FOOTER--><tr><td colspan="2"><div align="center"><font color="#525D76" size="-1"><em>
123 Copyright &copy; 1999-2014, Apache Software Foundation
124 </em></font></div></td></tr></table></body></html>