Details | Last modification | View Log | RSS feed
| Rev | Author | Line No. | Line |
|---|---|---|---|
| 771 | blopes | 1 | <!DOCTYPE html SYSTEM "about:legacy-compat"> |
| 2 | <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 9 (9.0.112) - Host Manager App -- Text Interface</title></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 9</h1><div class="versionInfo"> |
||
| 3 | Version 9.0.112, |
||
| 4 | <time datetime="2025-11-06">Nov 6 2025</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://cwiki.apache.org/confluence/display/TOMCAT/FAQ">FAQ</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="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><li><a href="rewrite.html">33) Rewrite</a></li><li><a href="cdi.html">34) CDI 2 and JAX-RS</a></li><li><a href="graal.html">35) AOT/GraalVM Support</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 4.0 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="jaspicapi/index.html">JASPIC 1.1 Javadocs</a></li><li><a href="annotationapi/index.html">Common Annotations 1.3 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://cwiki.apache.org/confluence/display/TOMCAT/Tomcat+Versions">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></div></nav></div></div><div id="mainRight"><div id="content"><h2>Host Manager App -- Text Interface</h2><h3 id="Table_of_Contents">Table of Contents</h3><div class="text"> |
||
| 5 | <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><li><a href="#Persist_command">Persist command</a></li></ol></li></ul> |
||
| 6 | </div><h3 id="Introduction">Introduction</h3><div class="text"> |
||
| 7 | <p> |
||
| 8 | The <strong>Tomcat Host Manager</strong> application enables you to create, |
||
| 9 | delete, and otherwise manage virtual hosts within Tomcat. This how-to guide |
||
| 10 | is best accompanied by the following pieces of documentation: |
||
| 11 | </p> |
||
| 12 | <ul> |
||
| 13 | <li> |
||
| 14 | <a href="virtual-hosting-howto.html">Virtual Hosting How-To</a> for more |
||
| 15 | information about virtual hosting. |
||
| 16 | </li> |
||
| 17 | <li> |
||
| 18 | <a href="config/host.html">The Host Container</a> for more information |
||
| 19 | about the underlying xml configuration of virtual hosts and description |
||
| 20 | of attributes. |
||
| 21 | </li> |
||
| 22 | </ul> |
||
| 23 | |||
| 24 | <p> |
||
| 25 | The <strong>Tomcat Host Manager</strong> application is a part of |
||
| 26 | Tomcat installation, by default available using the following |
||
| 27 | context: <code>/host-manager</code>. You can use the host manager in the |
||
| 28 | following ways: |
||
| 29 | </p> |
||
| 30 | |||
| 31 | <ul> |
||
| 32 | <li> |
||
| 33 | Utilizing the graphical user interface, accessible at: |
||
| 34 | <code>{server}:{port}/host-manager/html</code>. |
||
| 35 | </li> |
||
| 36 | <li> |
||
| 37 | Utilizing a set of minimal HTTP requests suitable for scripting. |
||
| 38 | You can access this mode at: |
||
| 39 | <code>{server}:{port}/host-manager/text</code>. |
||
| 40 | </li> |
||
| 41 | </ul> |
||
| 42 | <p> |
||
| 43 | Both ways enable you to add, remove, start, and stop virtual hosts. Changes |
||
| 44 | may be persisted by using the <code>persist</code> command. This document |
||
| 45 | focuses on the text interface. For further information about the graphical |
||
| 46 | interface, see |
||
| 47 | <a href="html-host-manager-howto.html">Host Manager App -- HTML Interface</a>. |
||
| 48 | </p> |
||
| 49 | </div><h3 id="Configuring_Manager_Application_Access">Configuring Manager Application Access</h3><div class="text"> |
||
| 50 | <p><em>The description below uses <code>$CATALINA_HOME</code> to refer the |
||
| 51 | base Tomcat directory. It is the directory in which you installed |
||
| 52 | Tomcat, for example <code>C:\tomcat9</code>, or |
||
| 53 | <code>/usr/share/tomcat9</code>.</em></p> |
||
| 54 | |||
| 55 | <p> |
||
| 56 | The Host Manager application requires a user with one of the following |
||
| 57 | roles: |
||
| 58 | </p> |
||
| 59 | |||
| 60 | <ul> |
||
| 61 | <li> |
||
| 62 | <code>admin-gui</code> - use this role for the graphical web interface. |
||
| 63 | </li> |
||
| 64 | <li> |
||
| 65 | <code>admin-script</code> - use this role for the scripting web interface. |
||
| 66 | </li> |
||
| 67 | </ul> |
||
| 68 | |||
| 69 | <p> |
||
| 70 | To enable access to the text interface of the Host Manager application, |
||
| 71 | either grant your Tomcat user the appropriate role, or create a new one with |
||
| 72 | the correct role. For example, open |
||
| 73 | <code>${CATALINA_BASE}/conf/tomcat-users.xml</code> and enter the following: |
||
| 74 | </p> |
||
| 75 | <div class="codeBox"><pre><code><user username="test" password="chang3m3N#w" roles="admin-script"/></code></pre></div> |
||
| 76 | <p> |
||
| 77 | No further settings is needed. When you now access |
||
| 78 | <code>{server}:{port}/host-manager/text/${COMMAND}</code>,you are able to |
||
| 79 | log in with the created credentials. For example: |
||
| 80 | <div class="codeBox"><pre><code>$ curl -u ${USERNAME}:${PASSWORD} http://localhost:8080/host-manager/text/list |
||
| 81 | OK - Listed hosts |
||
| 82 | localhost:</code></pre></div> |
||
| 83 | </p> |
||
| 84 | <p> |
||
| 85 | If you are using a different realm you will need to add the necessary role |
||
| 86 | to the appropriate user(s) using the standard user management tools for that |
||
| 87 | realm. |
||
| 88 | </p> |
||
| 89 | </div><h3 id="List_of_Commands">List of Commands</h3><div class="text"> |
||
| 90 | <p>The following commands are supported:</p> |
||
| 91 | <ul> |
||
| 92 | <li>list</li> |
||
| 93 | <li>add</li> |
||
| 94 | <li>remove</li> |
||
| 95 | <li>start</li> |
||
| 96 | <li>stop</li> |
||
| 97 | <li>persist</li> |
||
| 98 | </ul> |
||
| 99 | <p> |
||
| 100 | In the following subsections, the username and password is assumed to be |
||
| 101 | <b>test:test</b>. For your environment, use credentials created in the |
||
| 102 | previous sections. |
||
| 103 | </p> |
||
| 104 | <div class="subsection"><h4 id="List_command">List command</h4><div class="text"> |
||
| 105 | <p> |
||
| 106 | Use the <b>list</b> command to see the available virtual hosts on your |
||
| 107 | Tomcat instance. |
||
| 108 | </p> |
||
| 109 | <p><i>Example command</i>:</p> |
||
| 110 | <code>curl -u test:test http://localhost:8080/host-manager/text/list</code> |
||
| 111 | <p><i>Example response</i>:</p> |
||
| 112 | <div class="codeBox"><pre><code>OK - Listed hosts |
||
| 113 | localhost:</code></pre></div> |
||
| 114 | </div></div> |
||
| 115 | <div class="subsection"><h4 id="Add_command">Add command</h4><div class="text"> |
||
| 116 | <p> |
||
| 117 | Use the <b>add</b> command to add a new virtual host. Parameters used |
||
| 118 | for the <b>add</b> command: |
||
| 119 | </p> |
||
| 120 | <ul> |
||
| 121 | <li>String <b>name</b>: Name of the virtual host. <b>REQUIRED</b></li> |
||
| 122 | <li>String <b>aliases</b>: Aliases for your virtual host.</li> |
||
| 123 | <li>String <b>appBase</b>: Base path for the application that will be |
||
| 124 | served by this virtual host. Provide relative or absolute path.</li> |
||
| 125 | <li>Boolean <b>manager</b>: If true, the Manager app is added to the |
||
| 126 | virtual host. You can access it with the <i>/manager</i> context.</li> |
||
| 127 | <li>Boolean <b>autoDeploy</b>: If true, Tomcat automatically redeploys |
||
| 128 | applications placed in the appBase directory.</li> |
||
| 129 | <li>Boolean <b>deployOnStartup</b>: If true, Tomcat automatically deploys |
||
| 130 | applications placed in the appBase directory on startup.</li> |
||
| 131 | <li>Boolean <b>deployXML</b>: If true, the <i>/META-INF/context.xml</i> |
||
| 132 | file is read and used by Tomcat.</li> |
||
| 133 | <li>Boolean <b>copyXML</b>: If true, Tomcat copies <i>/META-INF/context.xml</i> |
||
| 134 | file and uses the original copy regardless of updates to the application's |
||
| 135 | <i>/META-INF/context.xml</i> file.</li> |
||
| 136 | </ul> |
||
| 137 | <p><i>Example command</i>:</p> |
||
| 138 | <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> |
||
| 139 | <p><i>Example response</i>:</p> |
||
| 140 | <div class="codeBox"><pre><code>add: Adding host [www.awesomeserver.com]</code></pre></div> |
||
| 141 | </div></div> |
||
| 142 | <div class="subsection"><h4 id="Remove_command">Remove command</h4><div class="text"> |
||
| 143 | <p> |
||
| 144 | Use the <b>remove</b> command to remove a virtual host. Parameters used |
||
| 145 | for the <b>remove</b> command: |
||
| 146 | </p> |
||
| 147 | <ul> |
||
| 148 | <li>String <b>name</b>: Name of the virtual host to be removed. |
||
| 149 | <b>REQUIRED</b></li> |
||
| 150 | </ul> |
||
| 151 | <p><i>Example command</i>:</p> |
||
| 152 | <div class="codeBox"><pre><code>curl -u test:test http://localhost:8080/host-manager/text/remove?name=www.awesomeserver.com</code></pre></div> |
||
| 153 | <p><i>Example response</i>:</p> |
||
| 154 | <div class="codeBox"><pre><code>remove: Removing host [www.awesomeserver.com]</code></pre></div> |
||
| 155 | </div></div> |
||
| 156 | <div class="subsection"><h4 id="Start_command">Start command</h4><div class="text"> |
||
| 157 | <p> |
||
| 158 | Use the <b>start</b> command to start a virtual host. Parameters used |
||
| 159 | for the <b>start</b> command: |
||
| 160 | </p> |
||
| 161 | <ul> |
||
| 162 | <li>String <b>name</b>: Name of the virtual host to be started. |
||
| 163 | <b>REQUIRED</b></li> |
||
| 164 | </ul> |
||
| 165 | <p><i>Example command</i>:</p> |
||
| 166 | <div class="codeBox"><pre><code>curl -u test:test http://localhost:8080/host-manager/text/start?name=www.awesomeserver.com</code></pre></div> |
||
| 167 | <p><i>Example response</i>:</p> |
||
| 168 | <div class="codeBox"><pre><code>OK - Host www.awesomeserver.com started</code></pre></div> |
||
| 169 | </div></div> |
||
| 170 | <div class="subsection"><h4 id="Stop_command">Stop command</h4><div class="text"> |
||
| 171 | <p> |
||
| 172 | Use the <b>stop</b> command to stop a virtual host. Parameters used |
||
| 173 | for the <b>stop</b> command: |
||
| 174 | </p> |
||
| 175 | <ul> |
||
| 176 | <li>String <b>name</b>: Name of the virtual host to be stopped. |
||
| 177 | <b>REQUIRED</b></li> |
||
| 178 | </ul> |
||
| 179 | <p><i>Example command</i>:</p> |
||
| 180 | <div class="codeBox"><pre><code>curl -u test:test http://localhost:8080/host-manager/text/stop?name=www.awesomeserver.com</code></pre></div> |
||
| 181 | <p><i>Example response</i>:</p> |
||
| 182 | <div class="codeBox"><pre><code>OK - Host www.awesomeserver.com stopped</code></pre></div> |
||
| 183 | </div></div> |
||
| 184 | <div class="subsection"><h4 id="Persist_command">Persist command</h4><div class="text"> |
||
| 185 | <p> |
||
| 186 | Use the <b>persist</b> command to persist a virtual host into |
||
| 187 | <b>server.xml</b>. Parameters used for the <b>persist</b> command: |
||
| 188 | </p> |
||
| 189 | <ul> |
||
| 190 | <li>String <b>name</b>: Name of the virtual host to be persist. |
||
| 191 | <b>REQUIRED</b></li> |
||
| 192 | </ul> |
||
| 193 | <p> |
||
| 194 | This functionality is disabled by default. To enable this option, you must |
||
| 195 | configure the <code>StoreConfigLifecycleListener</code> listener first. |
||
| 196 | To do so, add the following listener to your <i>server.xml</i>: |
||
| 197 | </p> |
||
| 198 | <div class="codeBox"><pre><code><Listener className="org.apache.catalina.storeconfig.StoreConfigLifecycleListener"/></code></pre></div> |
||
| 199 | <p><i>Example command</i>:</p> |
||
| 200 | <div class="codeBox"><pre><code>curl -u test:test http://localhost:8080/host-manager/text/persist?name=www.awesomeserver.com</code></pre></div> |
||
| 201 | <p><i>Example response</i>:</p> |
||
| 202 | <div class="codeBox"><pre><code>OK - Configuration persisted</code></pre></div> |
||
| 203 | <p><i>Example manual entry</i>:</p> |
||
| 204 | <div class="codeBox"><pre><code><Host appBase="www.awesomeserver.com" name="www.awesomeserver.com" deployXML="false" unpackWARs="false"> |
||
| 205 | </Host></code></pre></div> |
||
| 206 | </div></div> |
||
| 207 | </div></div></div></div></div><footer><div id="footer"> |
||
| 208 | Copyright © 1999-2025, The Apache Software Foundation |
||
| 209 | <br> |
||
| 210 | Apache Tomcat, Tomcat, Apache, the Apache Tomcat logo and the Apache logo |
||
| 211 | are either registered trademarks or trademarks of the Apache Software |
||
| 212 | Foundation. |
||
| 213 | </div></footer></div></body></html> |