266 lines
16 KiB
HTML
266 lines
16 KiB
HTML
<html><head><META http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><title>Apache Tomcat 7 (7.0.108) - Host Manager App -- Text Interface</title><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="https://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.108, Jan 28 2021</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="https://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="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></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="annotationapi/index.html">Common Annotations 1.1 Javadocs</a></li><li><a href="https://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="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="tribes/introduction.html">Tribes</a></li></ul></td><!--RIGHT SIDE MAIN BODY--><td width="80%" valign="top" align="left" id="mainBody"><h1>Host Manager App -- Text Interface</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="#Configuring_Manager_Application_Access">Configuring Manager Application Access</a></li><li><a href="#List_of_Commands">List of Commands</a><ol><li><a href="#List_command">List command</a></li><li><a href="#Add_command">Add command</a></li><li><a href="#Remove_command">Remove command</a></li><li><a href="#Start_command">Start command</a></li><li><a href="#Stop_command">Stop command</a></li></ol></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>
|
|
The <strong>Tomcat Host Manager</strong> application enables you to create,
|
|
delete, and otherwise manage virtual hosts within Tomcat. This how-to guide
|
|
is best accompanied by the following pieces of documentation:
|
|
</p>
|
|
<ul>
|
|
<li>
|
|
<a href="virtual-hosting-howto.html">Virtual Hosting How-To</a> for more
|
|
information about virtual hosting.
|
|
</li>
|
|
<li>
|
|
<a href="config/host.html">The Host Container</a> for more information
|
|
about the underlying xml configuration of virtual hosts and description
|
|
of attributes.
|
|
</li>
|
|
</ul>
|
|
|
|
<p>
|
|
The <strong>Tomcat Host Manager</strong> application is a part of
|
|
Tomcat installation, by default available using the following
|
|
context: <code>/host-manager</code>. You can use the host manager in the
|
|
following ways:
|
|
</p>
|
|
|
|
<ul>
|
|
<li>
|
|
Utilizing the graphical user interface, accessible at:
|
|
<code>{server}:{port}/host-manager/html</code>.
|
|
</li>
|
|
<li>
|
|
Utilizing a set of minimal HTTP requests suitable for scripting.
|
|
You can access this mode at:
|
|
<code>{server}:{port}/host-manager/text</code>.
|
|
</li>
|
|
</ul>
|
|
<p>
|
|
Both ways enable you to add, remove, start, and stop virtual hosts. Changes
|
|
are not persisted to the Tomcat configuraiton files. If you want your
|
|
settings to be persistent, you must write them into the <i>server.xml</i>
|
|
configuration file manually. For full documentation about the configuration,
|
|
see <a href="config/host.html">The Host Container</a>. This document focuses
|
|
on the text interface. For further information about the graphical
|
|
interface, see
|
|
<a href="html-host-manager-howto.html">Host Manager App -- HTML Interface</a>.
|
|
</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="Configuring Manager Application Access"><!--()--></a><a name="Configuring_Manager_Application_Access"><strong>Configuring Manager Application Access</strong></a></font></td></tr><tr><td><blockquote>
|
|
<p><em>The description below uses <code>$CATALINA_HOME</code> to refer the
|
|
base Tomcat directory. It is the directory in which you installed
|
|
Tomcat, for example <code>C:\tomcat7</code>, or
|
|
<code>/usr/share/tomcat7</code>.</em></p>
|
|
|
|
<p>
|
|
The Host Manager application requires a user with one of the following
|
|
roles:
|
|
</p>
|
|
|
|
<ul>
|
|
<li>
|
|
<code>admin-gui</code> - use this role for the graphical web interface.
|
|
</li>
|
|
<li>
|
|
<code>admin-script</code> - use this role for the scripting web interface.
|
|
</li>
|
|
</ul>
|
|
|
|
<p>
|
|
To enable access to the text interface of the Host Manager application,
|
|
either grant your Tomcat user the appropriate role, or create a new one with
|
|
the correct role. For example, open
|
|
<code>${CATALINA_BASE}/conf/tomcat-users.xml</code> and enter the following:
|
|
</p>
|
|
<div class="codeBox"><pre><code><user username="test" password="chang3m3N#w" roles="admin-script"/></code></pre></div>
|
|
<p>
|
|
No further settings is needed. When you now access
|
|
<code>{server}:{port}/host-manager/text/${COMMAND}</code>,you are able to
|
|
log in with the created credentials. For example:
|
|
<div class="codeBox"><pre><code>$ curl -u ${USERNAME}:${PASSWORD} http://localhost:8080/host-manager/text/list
|
|
OK - Listed hosts
|
|
localhost:</code></pre></div>
|
|
</p>
|
|
<p>
|
|
If you are using a different realm you will need to add the necessary role
|
|
to the appropriate user(s) using the standard user management tools for that
|
|
realm.
|
|
</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="List of Commands"><!--()--></a><a name="List_of_Commands"><strong>List of Commands</strong></a></font></td></tr><tr><td><blockquote>
|
|
<p>The following commands are supported:</p>
|
|
<ul>
|
|
<li>list</li>
|
|
<li>add</li>
|
|
<li>remove</li>
|
|
<li>start</li>
|
|
<li>stop</li>
|
|
</ul>
|
|
<p>
|
|
In the following subsections, the username and password is assumed to be
|
|
<b>test:test</b>. For your environment, use credentials created in the
|
|
previous sections.
|
|
</p>
|
|
<table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="List command"><!--()--></a><a name="List_command"><strong>List command</strong></a></font></td></tr><tr><td><blockquote>
|
|
<p>
|
|
Use the <b>list</b> command to see the available virtual hosts on your
|
|
Tomcat instance.
|
|
</p>
|
|
<p><i>Example command</i>:</p>
|
|
<code>curl -u test:test http://localhost:8080/host-manager/text/list</code>
|
|
<p><i>Example response</i>:</p>
|
|
<div class="codeBox"><pre><code>OK - Listed hosts
|
|
localhost:</code></pre></div>
|
|
</blockquote></td></tr></table>
|
|
<table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Add command"><!--()--></a><a name="Add_command"><strong>Add command</strong></a></font></td></tr><tr><td><blockquote>
|
|
<p>
|
|
Use the <b>add</b> command to add a new virtual host. Parameters used
|
|
for the <b>add</b> command:
|
|
</p>
|
|
<ul>
|
|
<li>String <b>name</b>: Name of the virtual host. <b>REQUIRED</b></li>
|
|
<li>String <b>aliases</b>: Aliases for your virtual host.</li>
|
|
<li>String <b>appBase</b>: Base path for the application that will be
|
|
served by this virtual host. Provide relative or absolute path.</li>
|
|
<li>Boolean <b>manager</b>: If true, the Manager app is added to the
|
|
virtual host. You can access it with the <i>/manager</i> context.</li>
|
|
<li>Boolean <b>autoDeploy</b>: If true, Tomcat automatically redeploys
|
|
applications placed in the appBase directory.</li>
|
|
<li>Boolean <b>deployOnStartup</b>: If true, Tomcat automatically deploys
|
|
applications placed in the appBase directory on startup.</li>
|
|
<li>Boolean <b>deployXML</b>: If true, the <i>/META-INF/context.xml</i>
|
|
file is read and used by Tomcat.</li>
|
|
<li>Boolean <b>copyXML</b>: If true, Tomcat copies <i>/META-INF/context.xml</i>
|
|
file and uses the original copy regardless of updates to the application's
|
|
<i>/META-INF/context.xml</i> file. Available only for
|
|
<b>Tomcat 8 and newer</b>.</li>
|
|
</ul>
|
|
<p><i>Example command</i>:</p>
|
|
<div class="codeBox"><pre><code>curl -u test:test http://localhost:8080/host-manager/text/add?name=www.awesomeserver.com&aliases=awesomeserver.com&appBase/mnt/appDir&deployOnStartup=true</code></pre></div>
|
|
<p><i>Example response</i>:</p>
|
|
<div class="codeBox"><pre><code>add: Adding host [www.awesomeserver.com]</code></pre></div>
|
|
</blockquote></td></tr></table>
|
|
<table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Remove command"><!--()--></a><a name="Remove_command"><strong>Remove command</strong></a></font></td></tr><tr><td><blockquote>
|
|
<p>
|
|
Use the <b>remove</b> command to remove a virtual host. Parameters used
|
|
for the <b>remove</b> command:
|
|
</p>
|
|
<ul>
|
|
<li>String <b>name</b>: Name of the virtual host to be removed.
|
|
<b>REQUIRED</b></li>
|
|
</ul>
|
|
<p><i>Example command</i>:</p>
|
|
<div class="codeBox"><pre><code>curl -u test:test http://localhost:8080/host-manager/text/remove?name=www.awesomeserver.com</code></pre></div>
|
|
<p><i>Example response</i>:</p>
|
|
<div class="codeBox"><pre><code>remove: Removing host [www.awesomeserver.com]</code></pre></div>
|
|
</blockquote></td></tr></table>
|
|
<table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Start command"><!--()--></a><a name="Start_command"><strong>Start command</strong></a></font></td></tr><tr><td><blockquote>
|
|
<p>
|
|
Use the <b>start</b> command to start a virtual host. Parameters used
|
|
for the <b>start</b> command:
|
|
</p>
|
|
<ul>
|
|
<li>String <b>name</b>: Name of the virtual host to be started.
|
|
<b>REQUIRED</b></li>
|
|
</ul>
|
|
<p><i>Example command</i>:</p>
|
|
<div class="codeBox"><pre><code>curl -u test:test http://localhost:8080/host-manager/text/start?name=www.awesomeserver.com</code></pre></div>
|
|
<p><i>Example response</i>:</p>
|
|
<div class="codeBox"><pre><code>OK - Host www.awesomeserver.com started</code></pre></div>
|
|
</blockquote></td></tr></table>
|
|
<table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Stop command"><!--()--></a><a name="Stop_command"><strong>Stop command</strong></a></font></td></tr><tr><td><blockquote>
|
|
<p>
|
|
Use the <b>stop</b> command to stop a virtual host. Parameters used
|
|
for the <b>stop</b> command:
|
|
</p>
|
|
<ul>
|
|
<li>String <b>name</b>: Name of the virtual host to be stopped.
|
|
<b>REQUIRED</b></li>
|
|
</ul>
|
|
<p><i>Example command</i>:</p>
|
|
<div class="codeBox"><pre><code>curl -u test:test http://localhost:8080/host-manager/text/stop?name=www.awesomeserver.com</code></pre></div>
|
|
<p><i>Example response</i>:</p>
|
|
<div class="codeBox"><pre><code>OK - Host www.awesomeserver.com stopped</code></pre></div>
|
|
</blockquote></td></tr></table>
|
|
</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-2021, Apache Software Foundation
|
|
</em></font></div></td></tr></table></body></html> |