Modified: tomcat/jk/trunk/xdocs/reference/apache.xml URL: http://svn.apache.org/viewvc/tomcat/jk/trunk/xdocs/reference/apache.xml?rev=1848904&r1=1848903&r2=1848904&view=diff ============================================================================== --- tomcat/jk/trunk/xdocs/reference/apache.xml (original) +++ tomcat/jk/trunk/xdocs/reference/apache.xml Thu Dec 13 22:03:14 2018 @@ -42,10 +42,10 @@ Exceptions from this rule are again expl See especially JkMountCopy. </p> <warn> -Warning: If Apache and Tomcat are configured to serve content from +<strong><span style="color: red;">Warning:</span> If Apache and Tomcat are configured to serve content from the same file system location then care must be taken to ensure that Apache is not able to serve inappropriate content such as the contents of the WEB-INF -directory or JSP source code. +directory or JSP source code.</strong> </warn> <p> This could occur if the Apache DocumentRoot @@ -524,12 +524,9 @@ We'll discuss here the mod_jk directive <b>JkWorkersFile</b> specify the location where mod_jk will find the workers definitions. Take a look at <a href="workers.html">Workers documentation</a> for detailed description. -<source> - JkWorkersFile /etc/httpd/conf/workers.properties +<source>JkWorkersFile /etc/httpd/conf/workers.properties </source> -<br/> -<br/> </p> </subsection> @@ -539,8 +536,7 @@ Take a look at <a href="workers.html">Wo <b>JkLogFile</b> specify the location where mod_jk is going to place its log file. </p> -<source> - JkLogFile /var/log/httpd/mod_jk.log +<source>JkLogFile /var/log/httpd/mod_jk.log </source> <p> @@ -548,8 +544,7 @@ Since JK 1.2.3 for Apache 2.x and JK 1.2 be used for piped logging: </p> -<source> - JkLogFile "|/usr/bin/rotatelogs /var/log/httpd/mod_jk.log 86400" +<source>JkLogFile "|/usr/bin/rotatelogs /var/log/httpd/mod_jk.log 86400" </source> <p> @@ -575,14 +570,11 @@ set the log level between: </li> </ul> -<source> - JkLogLevel info +<source>JkLogLevel info </source> <p> <code>info</code> should be your default selection for normal operations. -<br/> -<br/> </p> <p> @@ -590,16 +582,10 @@ set the log level between: See above for details. </p> -<source> - JkLogStampFormat "[%Y-%m-%d %H:%M:%S.%Q] " +<source>JkLogStampFormat "[%Y-%m-%d %H:%M:%S.%Q] " </source> <p> -<br/> -<br/> -</p> - -<p> You can log mod_jk information using the Apache standard module <b>mod_log_config</b>. The module sets several notes in the Apache notes table. Most of them are are only useful in combination with a load balancer worker. @@ -635,14 +621,11 @@ Most of them are are only useful in comb <attribute name="JK_LB_LAST_STATE" required="false">Load balancer: Error state for the last worker tried</attribute> </attributes> -<source> - LogFormat "%h %l %u %t \"%r\" %>s %b %{JK_WORKER_NAME}n %{JK_LB_FIRST_NAME}n \ - %{JK_LB_FIRST_BUSY}n %{JK_LB_LAST_NAME}n %{JK_LB_LAST_BUSY}n" mod_jk_log - CustomLog logs/access_log mod_jk_log +<source>LogFormat "%h %l %u %t \"%r\" %>s %b %{JK_WORKER_NAME}n %{JK_LB_FIRST_NAME}n \ + %{JK_LB_FIRST_BUSY}n %{JK_LB_LAST_NAME}n %{JK_LB_LAST_BUSY}n" mod_jk_log +CustomLog logs/access_log mod_jk_log </source> -<br/> -<br/> </p> <p> @@ -673,12 +656,9 @@ here is a list of the available request <attribute name="%R" required="false">Real worker name</attribute> </attributes> -<source> - JkRequestLogFormat "%w %V %T" +<source>JkRequestLogFormat "%w %V %T" </source> -<br/> -<br/> </p> </subsection> @@ -687,8 +667,6 @@ here is a list of the available request <p> The directive JkOptions allow you to set many forwarding options which will enable (+) or disable (-) following option. Without any leading signs, options will be enabled. -<br/> -<br/> </p> <p> @@ -700,8 +678,6 @@ It was "ForwardURICompatUnparsed" in ver You can turn the default off by switching on one of the other two options. You should leave this at it's default value, unless you have a very good reason to change it. -<br/> -<br/> </p> <p> @@ -709,10 +685,7 @@ All options are inherited from the globa Options that support enabling (plus options) and disabling (minus options), are inherited in the following way: <br/> -<br/> options(vhost) = plus_options(global) - minus_options(global) + plus_options(vhost) - minus_options(vhost) -<br/> -<br/> </p> <p> @@ -721,12 +694,9 @@ will be partially reencoded after proces before forwarding to Tomcat. This will be compatible with local URL manipulation by mod_rewrite and with URL encoded session ids. -<source> - JkOptions +ForwardURIProxy +<source>JkOptions +ForwardURIProxy </source> -<br/> -<br/> </p> <p> @@ -736,12 +706,9 @@ It will always forward the original requ URIs with mod_rewrite and then forwarding the rewritten URI will not work. -<source> - JkOptions +ForwardURICompatUnparsed +<source>JkOptions +ForwardURICompatUnparsed </source> -<br/> -<br/> </p> <p> @@ -752,12 +719,9 @@ This is less spec compliant and is <b>no prefix JkMount. This option will allow to rewrite URIs with mod_rewrite before forwarding. -<source> - JkOptions +ForwardURICompat +<source>JkOptions +ForwardURICompat </source> -<br/> -<br/> </p> <p> @@ -767,20 +731,15 @@ Explicit path components like ".." will This will not work in combination with URL encoded session IDs, but it will allow to rewrite URIs with mod_rewrite before forwarding. -<source> - JkOptions +ForwardURIEscaped +<source>JkOptions +ForwardURIEscaped </source> -<br/> -<br/> </p> <p> JkOptions <b>RejectUnsafeURI</b> will block all URLs, which contain percent signs '%' or backslashes '\' after decoding. -<br/> -<br/> </p> <p> Most web apps do not use such URLs. Using the option RejectUnsafeURI, you @@ -791,12 +750,9 @@ is not set. You can also realise such a check with mod_rewrite, which is more powerful but also slightly more complicated. -<source> - JkOptions +RejectUnsafeURI +<source>JkOptions +RejectUnsafeURI </source> -<br/> -<br/> </p> <p> @@ -818,8 +774,6 @@ ignored if used. JkOptions <b>ForwardDirectories</b> is used in conjunction with <b>DirectoryIndex</b> directive of Apache. As such mod_dir should be available to Apache, statically or dynamically (DSO) -<br/> -<br/> </p> <p> @@ -848,11 +802,8 @@ ones visible only to Tomcat (i.e. if Apa that's going to get served). This is important if there is more then one type of file that Tomcat normally serves - for instance Velocity pages and JSP pages. -<source> - JkOptions +ForwardDirectories +<source>JkOptions +ForwardDirectories </source> -<br/> -<br/> </p> <p> @@ -861,11 +812,8 @@ of the Apache HTTP Server instead remote Tomcat remote address valve for allowing connections only from configured Apache servers. -<source> - JkOptions +ForwardLocalAddress +<source>JkOptions +ForwardLocalAddress </source> -<br/> -<br/> </p> <p> @@ -875,11 +823,8 @@ uses the logical address as provided by mod_remoteip sets the logical IP address to the client IP forwarded by proxies in the <code>X-Forwarded-For</code> header. -<source> - JkOptions +ForwardPhysicalAddress +<source>JkOptions +ForwardPhysicalAddress </source> -<br/> -<br/> </p> <p> @@ -889,24 +834,18 @@ a strong performance penalty for Apache more often than would normally be required (ie: at the end of each response). -<source> - JkOptions +FlushPackets +<source>JkOptions +FlushPackets </source> -<br/> -<br/> </p> <p> JkOptions <b>FlushHeader</b>, you ask mod_jk to flush Apache's connection buffer after the response headers have been received from Tomcat. -<source> - JkOptions +FlushHeader +<source>JkOptions +FlushHeader </source> -<br/> -<br/> </p> <p> @@ -922,12 +861,9 @@ If a firewall between Apache and Tomcat try to use the worker attribute socket_keepalive in combination with an appropriate TCP keepalive value in your OS. -<source> - JkOptions +DisableReuse +<source>JkOptions +DisableReuse </source> -<br/> -<br/> </p> <p> @@ -935,12 +871,9 @@ JkOptions <b>ForwardKeySize</b>, you ask required by Servlet API 2.3. This flag shouldn't be set when servlet engine is Tomcat 3.2.x (on by default). -<source> - JkOptions +ForwardKeySize +<source>JkOptions +ForwardKeySize </source> -<br/> -<br/> </p> <p> @@ -954,12 +887,9 @@ will not have the possibility to validat bug would be fixed by passing on the <code>SSL_CLIENT_CERT_CHAIN</code> to Tomcat via the AJP connector. <br/> This directive exists only since version 1.2.22. -<source> - JkOptions +ForwardSSLCertChain +<source>JkOptions +ForwardSSLCertChain </source> -<br/> -<br/> </p> <p> @@ -974,14 +904,10 @@ via request.getAttribute(attributeName). Note that the variables send via JkEnvVar will not be listed in request.getAttributeNames(). <br/> -<br/> The variables are inherited from the global server to virtual hosts. -<source> - JkEnvVar SSL_CLIENT_V_START undefined +<source>JkEnvVar SSL_CLIENT_V_START undefined </source> -<br/> -<br/> </p> </subsection> @@ -996,17 +922,15 @@ you can change settings such as the work In general the structure of a JkMount directive is: </p> -<source> - JkMount [URL prefix] [Worker name] +<source>JkMount [URL prefix] [Worker name] </source> -<source> - # send all requests ending in .jsp to worker1 - JkMount /*.jsp worker1 - # send all requests ending /servlet to worker1 - JkMount /*/servlet/ worker1 - # send all requests jsp requests to files located in /otherworker will go worker2 - JkMount /otherworker/*.jsp worker2 +<source># send all requests ending in .jsp to worker1 +JkMount /*.jsp worker1 +# send all requests ending /servlet to worker1 +JkMount /*/servlet/ worker1 +# send all requests jsp requests to files located in /otherworker will go worker2 +JkMount /otherworker/*.jsp worker2 </source> <p> @@ -1018,11 +942,10 @@ to a particular URL. The purpose is to b types from mounted context. The following example mounts /servlet/* context, but all .gif files that belongs to that context are not served. </p> -<source> - # send all requests ending with /servlet to worker1 - JkMount /servlet/* worker1 - # do not send requests ending with .gif to worker1 - JkUnMount /servlet/*.gif worker1 +<source># send all requests ending with /servlet to worker1 +JkMount /servlet/* worker1 +# do not send requests ending with .gif to worker1 +JkUnMount /servlet/*.gif worker1 </source> <p> JkUnMount takes precedence over JkMount directives, meaning that the JK @@ -1033,26 +956,24 @@ JkMount and in the JkUnMount are the sam <p> The following example will block all .gif files although there is a JkMount for them: </p> -<source> - # do not send requests ending with .gif to worker1 - JkUnMount /*.gif worker1 - # The .gif files will not be mounted cause JkUnMount takes - # precedence over JkMount directive - JkMount /servlet/*.gif worker1 +<source># do not send requests ending with .gif to worker1 +JkUnMount /*.gif worker1 +# The .gif files will not be mounted cause JkUnMount takes +# precedence over JkMount directive +JkMount /servlet/*.gif worker1 </source> <p> Starting with version 1.2.26 of JK you can apply a JkUnMount to any worker, by using the star character '*' as the worker name in the JkUnMount. More complex patterns in JkUnMount worker names are not allowed. </p> -<source> - # Mapping the webapps myapp1 and myapp2: - /myapp1/*=worker1 - /myapp2/*=worker2 - # Exclude the all subdirectories static for all workers: - !/*/static/*=* - # Exclude some suffixes for all workers: - !*.html=* +<source># Mapping the webapps myapp1 and myapp2: +/myapp1/*=worker1 +/myapp2/*=worker2 +# Exclude the all subdirectories static for all workers: +!/*/static/*=* +# Exclude some suffixes for all workers: +!*.html=* </source> <p> <b>JkAutoAlias</b> directive automatically <b>Alias</b> webapp context directories into @@ -1071,26 +992,24 @@ with a single path element and no versio <li>parallel deployment (e.g. .../webapps/foo##v00.05.12)</li> </ul> </p> -<source> - # enter the full path to the tomcat webapps directory - JkAutoAlias /opt/tomcat/webapps +<source># enter the full path to the tomcat webapps directory +JkAutoAlias /opt/tomcat/webapps </source> <p>The following example shows how to serve a dynamic context by Tomcat and static using Apache. The webapps directory has to be accessible by Apache.</p> -<source> - # enter the full path to the tomcat webapps directory - JkAutoAlias /opt/tomcat/webapps - - # Mount 'examples' directory. It's physical location - # is assumed to be in the /opt/tomcat/webapps/examples - # ajp13w is a worker defined in the workers.properties - JkMount /examples/* ajp13w - - # Unmount desired static content from examples webapp. - # This content will be served by the Apache directly. - JkUnMount /*.gif ajp13w +<source># enter the full path to the tomcat webapps directory +JkAutoAlias /opt/tomcat/webapps + +# Mount 'examples' directory. It's physical location +# is assumed to be in the /opt/tomcat/webapps/examples +# ajp13w is a worker defined in the workers.properties +JkMount /examples/* ajp13w + +# Unmount desired static content from examples webapp. +# This content will be served by the Apache directly. +JkUnMount /*.gif ajp13w </source> <p>Note that you can have a single JkAutoAlias directive per virtual host inside your httpd.conf @@ -1101,25 +1020,23 @@ version. It is a convenient method for s usually set inside <b>workers.propeties</b> file. The parameter for that directive is raw line from workers.properties file. </p> -<source> - # Just like workers.properties but exact line is prefixed - # with JkWorkerProperty - - # Minimal jk configuration - JkWorkerProperty worker.list=ajp13w - JkWorkerProperty worker.ajp13w.type=ajp13 - JkWorkerProperty worker.ajp13w.host=localhost - JkWorkerProperty worker.ajp13w.port=8009 +<source># Just like workers.properties but exact line is prefixed +# with JkWorkerProperty + +# Minimal jk configuration +JkWorkerProperty worker.list=ajp13w +JkWorkerProperty worker.ajp13w.type=ajp13 +JkWorkerProperty worker.ajp13w.host=localhost +JkWorkerProperty worker.ajp13w.port=8009 </source> <p> <b>JkMountFile</b> is a new directive available from JK 1.2.9 version. It is used for dynamic updates of mount points at runtime. When the mount file is changed, JK will reload it's content. </p> -<source> - # Load mount points +<source># Load mount points - JkMountFile conf/uriworkermap.properties +JkMountFile conf/uriworkermap.properties </source> <p>If the mount point uri starts with an exclamation mark '!' it defines an exclusion in the same way JkUnMount does. @@ -1128,14 +1045,13 @@ the mount point will only be disabled. A by deleting the minus sign and waiting for the JkMountFile to reload. An exclusion can be disabled by prefixing it with a minus sign. </p> -<source> - # Sample uriworkermap.properties file +<source># Sample uriworkermap.properties file - /examples/*=ajp13w - # Do not map .gif files - !/*.gif=ajp13w - # Make jsp examples initially disabled - -/examples/jsp/*=ajp13w +/examples/*=ajp13w +# Do not map .gif files +!/*.gif=ajp13w +# Make jsp examples initially disabled +-/examples/jsp/*=ajp13w </source> <p>At run time you can change the content of this file. For example removing minus signs will enable the previously disabled uri mappings. @@ -1146,8 +1062,6 @@ points within 60 second interval. <p> There is no way to delete entries by dynamic reloading, but you can disable or exclude mappings. -<br/> -<br/> </p> </subsection> @@ -1186,20 +1100,19 @@ of this variable via the <b>JkWorkerIndi You can also define exclusions from mod_jk forwards by setting the environment variable <b>no-jk</b>. </p> -<source> - # Automatically map all encoded urls - <Location *;jsessionid=> - SetHandler jakarta-servlet - SetEnv JK_WORKER_NAME my_worker - </Location> - - # Map all subdirs to workers via naming rule - # and exclude static content. - <Location /apps/> - SetHandler jakarta-servlet - SetEnvIf REQUEST_URI ^/apps/([^/]*)/ JK_WORKER_NAME=$1 - SetEnvIf REQUEST_URI ^/apps/([^/]*)/static no-jk - </Location> +<source># Automatically map all encoded urls +<Location *;jsessionid=> + SetHandler jakarta-servlet + SetEnv JK_WORKER_NAME my_worker +</Location> + +# Map all subdirs to workers via naming rule +# and exclude static content. +<Location /apps/> + SetHandler jakarta-servlet + SetEnvIf REQUEST_URI ^/apps/([^/]*)/ JK_WORKER_NAME=$1 + SetEnvIf REQUEST_URI ^/apps/([^/]*)/static no-jk +</Location> </source> </subsection> <subsection name="Advanced Environment Variables">
Modified: tomcat/jk/trunk/xdocs/reference/iis.xml URL: http://svn.apache.org/viewvc/tomcat/jk/trunk/xdocs/reference/iis.xml?rev=1848904&r1=1848903&r2=1848904&view=diff ============================================================================== --- tomcat/jk/trunk/xdocs/reference/iis.xml (original) +++ tomcat/jk/trunk/xdocs/reference/iis.xml Thu Dec 13 22:03:14 2018 @@ -290,8 +290,7 @@ A sample isapi_redirect.properties can b The property names and values in the properties file are the same as for the registry settings described above. For example: </p> <p> -<source> -# Configuration file for the Tomcat ISAPI Redirector +<source># Configuration file for the Tomcat ISAPI Redirector # The path to the ISAPI Redirector Extension, relative to the website # This must be in a virtual directory with execute privileges @@ -331,8 +330,7 @@ automatically added to the environment t </li> </ul> </p> -<p><source> -# Use the logs in the installation path of ISAPI Redirector +<p><source># Use the logs in the installation path of ISAPI Redirector log_file=$(JKISAPI_PATH)\$(JKISAPI_NAME).log </source></p> </section> @@ -347,8 +345,7 @@ To configure log rotation, configure a < If both are specified, the <b>log_rotationtime</b> will take precedence, and <b>log_filesize</b> will be ignored. <br/>For example, to configure daily rotation of the log file: </p> -<source> -# Configuration file for the Tomcat ISAPI Redirector +<source># Configuration file for the Tomcat ISAPI Redirector ... # Full path to the log file for the ISAPI Redirector @@ -365,8 +362,7 @@ log_rotationtime=86400 <p> Or to configure rotation of the log file when it reaches 5MB in size: </p> -<source> -# Configuration file for the Tomcat ISAPI Redirector +<source># Configuration file for the Tomcat ISAPI Redirector ... # Full path to the log file for the ISAPI Redirector @@ -397,8 +393,7 @@ as powerful as Apache HTTP Server's mod_ <p> The rule is in the form original-url-prefix=forward-url-prefix. For example: </p> -<source> -# Simple rewrite rules, making examples +<source># Simple rewrite rules, making examples # available under shorter URLs /jsp/=/examples/jsp/ /servlets/=/examples/servlets/ @@ -406,8 +401,7 @@ The rule is in the form original-url-pre <p> You can also use regular expressions, if you prefix the rule with a tilde <code>~</code>: </p> -<source> -# Complex rewrite rule, prefixing "/examples/" +<source># Complex rewrite rule, prefixing "/examples/" # to the first path component of all requests ~/([^/]*)=/examples/$1 </source> Modified: tomcat/jk/trunk/xdocs/reference/status.xml URL: http://svn.apache.org/viewvc/tomcat/jk/trunk/xdocs/reference/status.xml?rev=1848904&r1=1848903&r2=1848904&view=diff ============================================================================== --- tomcat/jk/trunk/xdocs/reference/status.xml (original) +++ tomcat/jk/trunk/xdocs/reference/status.xml Thu Dec 13 22:03:14 2018 @@ -30,7 +30,6 @@ <body> <section name="Introduction"> -<br/> <p> Tomcat Connectors has a special type of worker, the so-called status worker. The status worker does not forward requests to Tomcat instances. Instead it allows @@ -54,9 +53,7 @@ The documentation of the status worker s </section> <section name="Usage Patterns"> -<br/> <subsection name="Actions"> -<br/> <p> The status worker knows about the following actions: <ul> @@ -101,7 +98,6 @@ The dump action has been added in versio </subsection> <subsection name="Output Format"> -<br/> <p> For most actions you can choose between 4 output formats. <ul> @@ -128,7 +124,6 @@ The "edit" action does only make sense f </subsection> <subsection name="User Interface Features"> -<br/> <p> In the HTML view, there is an <b>automatic refresh</b> feature, implemented via the meta refresh option of HTML. Once you start the automatic refresh, the UI will will respect it for all actions @@ -170,7 +165,6 @@ The last three minimisation features hav </subsection> <subsection name="Special Considerations concerning URL Maps and Virtual Hosts"> -<br/> <p> <b>Note: </b>The following restriction has been removed starting with version 1.2.26. </p> @@ -185,7 +179,6 @@ of the virtual host the status worker ha </subsection> <subsection name="Logging"> -<br/> <p> The status worker will log changes made to the configuration with log level "info" to the usual JK log file. Invalid requests will be logged with log level "warn". If you want to report some @@ -196,16 +189,13 @@ broken behaviour, log file content of le </section> <section name="Configuration"> -<br/> <subsection name="Basic Configuration"> -<br/> <p> The basic configuration of a status worker is very similar to that of a usual ajp worker. You need to specify a name for the worker, and the URLs you want to map to it. The first part of the configuration happens in the workers.properties file. We define a worker named mystatus of type status: -<source> -worker.list=mystatus +<source>worker.list=mystatus worker.mystatus.type=status </source> Then we define a URL, which should be mapped to this worker, i.e. the URL we use @@ -213,8 +203,7 @@ to reach the functionality of the status for the web server of your choice. Possibilities are maps inside uriworkermap.properties, an additional mount attribute in workers.properties, or JkMount for the Apache HTTP Server. Here's an example for a uriworkermap.properties line: -<source> -/private/admin/mystatus=mystatus +<source>/private/admin/mystatus=mystatus </source> The URI pattern is case sensitive. </p> @@ -230,19 +219,16 @@ and then allow special groups of people </subsection> <subsection name="Output Customisation"> -<br/> <p> There are a couple of attributes for the workers.properties entries, which allow to customise various aspects of the output of the status worker. </p> <p> The attribute <b>css</b> can be set to the URL of a stylesheet: -<source> -worker.mystatus.css=/private/admin/static/mystatus.css +<source>worker.mystatus.css=/private/admin/static/mystatus.css </source> When writing HTML output, the status worker then includes the line -<source> -<link rel="stylesheet" type="text/css" href="/private/admin/static/mystatus.css" /> +<source><link rel="stylesheet" type="text/css" href="/private/admin/static/mystatus.css" /> </source> There is no sample stylesheet included with the mod_jk release, and by default the attribute css is empty, so no stylesheet reference will be included in the pages. The HTML code @@ -269,7 +255,6 @@ be inserted at the beginning of the docu </subsection> <subsection name="Securing Access"> -<br/> <p> We urge you to use the builtin access control features of your web server to control access to the status worker URLs you have chosen. Nevertheless two configuration @@ -281,8 +266,7 @@ The default value is <b>false</b>, ie. r <p> You could configure two status workers, one has read_only and will be made available to a larger admin group, the other one will be used fully featured, but only by fewer people: -<source> -worker.list=jk-watch +<source>worker.list=jk-watch worker.jk-watch.type=status worker.jk-watch.read_only=true worker.jk-watch.mount=/user/status/jk @@ -311,7 +295,6 @@ the attribute <b>user_case_insensitive</ </subsection> <subsection name="Service Availability Rating"> -<br/> <p> For load balancing workers the status worker shows some interesting overview information. It categorises the members of the load balancer into the classes "good", "bad" and degraded". @@ -378,7 +361,6 @@ can be found. </section> <section name="Request Parameters"> -<br/> <p> This section should help you building automation scripts based on the jk status management interface. This interface is stable in the sense, that we only expect @@ -388,7 +370,6 @@ and Text to be kept stable. So please us output in your automation scripts. </p> <subsection name="Actions"> -<br/> <p> The action is determined by the parameter <b>cmd</b>. It can have the values "list", "show", "edit", "update", "reset", "recover", "version" and "dump". If you omit the <b>cmd</b> parameter, @@ -400,7 +381,6 @@ The action "dump" has been added in vers </p> </subsection> <subsection name="Output Format"> -<br/> <p> The format is determined by the parameter <b>mime</b>. It can have the values "html", "xml", "txt" and "prop". If you omit the <b>mime</b> parameter, the default "html" @@ -408,7 +388,6 @@ will be used. The action "edit" (the edi </p> </subsection> <subsection name="Worker Selection"> -<br/> <p> Actions that operate on a single worker need one or two additional parameters to select this worker. The parameter <b>w</b> contains the name of the worker from the worker list. @@ -418,14 +397,12 @@ name of the sub worker. </p> </subsection> <subsection name="Automatic Refresh"> -<br/> <p> During automatic refresh, the parameter <b>re</b> contain the refresh interval in seconds. If you omit this parameter, automatic refresh will be off. </p> </subsection> <subsection name="Hide Options"> -<br/> <p> The parameter <b>opt</b> contains a bit mask of activated options. The default is 0, so by default no options are activated. The following options exist: @@ -462,7 +439,6 @@ Values 0x0040-0x0100 have been added in </p> </subsection> <subsection name="Data Parameters for the standard Update Action"> -<br/> <p> You can use the edit action with a final click to the update button, to change settings of workers. But you can also make direct calls to the update action. The following request parameters @@ -563,7 +539,6 @@ For the details of all parameters, we re </p> </subsection> <subsection name="Aspect Editing for Load Balancer Members"> -<br/> <p> You can use the edit action to edit all settings for a load balancer or for a member of a load balancer respectively on one page. If you want to edit one Modified: tomcat/jk/trunk/xdocs/reference/uriworkermap.xml URL: http://svn.apache.org/viewvc/tomcat/jk/trunk/xdocs/reference/uriworkermap.xml?rev=1848904&r1=1848903&r2=1848904&view=diff ============================================================================== --- tomcat/jk/trunk/xdocs/reference/uriworkermap.xml (original) +++ tomcat/jk/trunk/xdocs/reference/uriworkermap.xml Thu Dec 13 22:03:14 2018 @@ -31,7 +31,6 @@ <body> <section name="Introduction"> -<br/> <p> The forwarding of requests from the web server to tomcat gets configured by defining mapping rules. Such a rule maps requests to workers. The request part of the map is described by a URI pattern, @@ -81,55 +80,47 @@ The following sections describe these as </section> <section name="Syntax"> -<br/> <subsection name="Line format"> -<br/> <p> The file has a line based format. There are no continuation characters, so each rule needs to be defined on a single line. Each rule is a pair consisting of a URI pattern and a worker name, combined by an equals sign '=': -<source> - /myapp=myworker +<source>/myapp=myworker </source> The URI pattern is case sensitive. </p> </subsection> <subsection name="Comments, white space"> -<br/> <p> All text after and including the character '#' gets ignored and can be used for comments. Leading and trailing white space gets trimmed around the URI pattern and also around the worker name. The following definitions are all equivalent: -<source> - # This is a white space example +<source># This is a white space example +/myapp=myworker /myapp=myworker - /myapp=myworker - /myapp = myworker +/myapp = myworker </source> </p> </subsection> <subsection name="URI patterns"> -<br/> <p> Inside the URI pattern three special characters can be used, '*', '?' and '|'. The character '*' is a wildchar that matches any number of arbitrary characters in the URI, '?' matches exactly one character. Each URI pattern has to start with the character '/', or with '*' or with '?', optionally prefixed by any combination of the modifiers '!' and '-' (see next section). -<source> - # Mapping the URI /myapp1 and everything under /myapp1/: - /myapp1=myworker-a - /myapp1/*=myworker-a - # Mapping all URI which end with a common suffix: - *.jsp=myworker - *.do=myworker +<source># Mapping the URI /myapp1 and everything under /myapp1/: +/myapp1=myworker-a +/myapp1/*=myworker-a +# Mapping all URI which end with a common suffix: +*.jsp=myworker +*.do=myworker </source> Since the first case of mapping a certain location and everything inside it is very common, the character '|' gives a handy shortcut: -<source> - # Mapping the URI /myapp1 and everything under /myapp1/: - /myapp1|/*=myworker-a +<source># Mapping the URI /myapp1 and everything under /myapp1/: +/myapp1|/*=myworker-a </source> The pattern 'X|Y' is exactly equivalent to the two maps 'X' and 'XY'. </p> @@ -137,36 +128,32 @@ The pattern 'X|Y' is exactly equivalent </section> <section name="Exclusion, Disabling and Priorities"> -<br/> <subsection name="Exclusions and rule disabling"> -<br/> <p> Exclusion rules allows to define exclusions from URI rules, which would forward requests to tomcat. If the exclusion rule matches, the request will not be forwarded. This is usually used to serve static content by the web server. A rule is an exclusion rule, if it is suffixed with '!': -<source> - # Mapping the URI /myapp and everything under /myapp/: - /myapp|/*=myworker - # Exclude the subdirectory static: - !/myapp/static|/*=myworker - # Exclude some suffixes: - !*.html=myworker +<source># Mapping the URI /myapp and everything under /myapp/: +/myapp|/*=myworker +# Exclude the subdirectory static: +!/myapp/static|/*=myworker +# Exclude some suffixes: +!*.html=myworker </source> An exclusion rule overrides a normal mapping rule only, if the worker names in the normal rule and in the exclusion rule are the same. Starting with version 1.2.26 of JK you can apply an exclusion rule to any worker, by using the star character '*' as the worker name in the exclusion rule. More complex patterns in exclusion worker names are not allowed. -<source> - # Mapping the webapps /myapp1 and /myapp2: - /myapp1|/*=myworker1 - /myapp2|/*=myworker2 - # Exclude the all subdirectories static for all workers: - !/*/static|/*=* - # Exclude some suffixes for all workers: - !*.html=* +<source># Mapping the webapps /myapp1 and /myapp2: +/myapp1|/*=myworker1 +/myapp2|/*=myworker2 +# Exclude the all subdirectories static for all workers: +!/*/static|/*=* +# Exclude some suffixes for all workers: +!*.html=* </source> </p> <p> @@ -174,17 +161,15 @@ Rule disabling comes into play, if your and you want to disable any rule defined previously. Since the uriworkermap file gets reloaded dynamically, you can use this to temporarily disable request forwarding: A rule gets disabled, if it is suffixed with '-': -<source> - # We are not in maintenance. - # The maintenance rule got defined somewhere else. - -/*=maintenance +<source># We are not in maintenance. +# The maintenance rule got defined somewhere else. +-/*=maintenance </source> Exclusion rules can get disabled as well, then the rule starts with '-!'. </p> </subsection> <subsection name="Mapping priorities"> -<br/> <p> The most restrictive URI pattern is applied first. More precisely the URI patterns are sorted by the number of '/' characters in the pattern (highest number first), and @@ -208,36 +193,31 @@ different worker targets. </section> <section name="Rule extensions"> -<br/> <p> Rule extensions were added in version 1.2.27 and are not available in earlier versions. </p> <subsection name="Syntax"> -<br/> <p> Rule extensions are additional attributes, that can be attached to any rule. They are added at the end of the rule, each extension separated by a semicolon: -<source> - # This is an extension example, - # setting a reply_timeout of 1 minute - # only for this mapping. - /myapp=myworker;reply_timeout=60000 - # - # This is an example using multiple extensions - /myapp=myloadbalancer;reply_timeout=60000;stopped=member1 +<source># This is an extension example, +# setting a reply_timeout of 1 minute +# only for this mapping. +/myapp=myworker;reply_timeout=60000 +# +# This is an example using multiple extensions +/myapp=myloadbalancer;reply_timeout=60000;stopped=member1 </source> Attributes set via rule extensions always overwrite conflicting configurations in the worker definition file. </p> </subsection> <subsection name="Extension reply_timeout"> -<br/> <p> The extension <code>reply_timeout</code> sets a reply timeout for a single mapping rule. -<source> - # Setting a reply_timeout of 1 minute - # only for this mapping. - /myapp=myworker;reply_timeout=60000 +<source># Setting a reply_timeout of 1 minute +# only for this mapping. +/myapp=myworker;reply_timeout=60000 </source> It overrides any <code>reply_timeout</code> defined for the worker. The extension allows to set a reasonable default reply timeout to the worker, and a more relaxed @@ -247,14 +227,12 @@ For a general description of reply timeo </p> </subsection> <subsection name="Extension sticky_ignore"> -<br/> <p> The extension <code>sticky_ignore</code> will disable session stickyness for a single mapping rule. -<source> - # Disable session stickyness - # only for this mapping. - /myapp/loginform.jsp=myworker;sticky_ignore=1 +<source># Disable session stickyness +# only for this mapping. +/myapp/loginform.jsp=myworker;sticky_ignore=1 </source> This extension can be useful to optimize load balancing when using cookie based session stickyness. In this case, as long as she keeps @@ -269,7 +247,6 @@ This extension is available since versio </p> </subsection> <subsection name="Extension stateless"> -<br/> <p> The extension <code>stateless</code> is only useful when using session based load balancing. In this case normally any request which does not come with @@ -277,41 +254,35 @@ a session id counts as a new session. If the <code>stateless</code> extension, then the requests matching the mapping rule will not count as a new session, even if they do not come with a session id. -<source> - # Don't let static content trash our session balancing - /myapp/static/*=myworker;stateless=1 +<source># Don't let static content trash our session balancing +/myapp/static/*=myworker;stateless=1 </source> This extension is available since version 1.2.33. </p> </subsection> <subsection name="Extensions active/disabled/stopped"> -<br/> <p> The extensions <code>active</code>, <code>disabled</code>, and <code>stopped</code> can be used in a load balancer mapping rule to set selected members of the load balancer into a special activation state. -<source> - # Stop forwarding only for member1 of loadbalancer - /myapp=myloadbalancer;stopped=member1 +<source># Stop forwarding only for member1 of loadbalancer +/myapp=myloadbalancer;stopped=member1 </source> Multiple members must be separated by commas or white space: -<source> - # Stop forwarding for member01 and member02 of loadbalancer - # Disable forwarding for member21 and member22 of loadbalancer - /myapp=myloadbalancer;stopped=member01,member02;disabled=member21,member22 +<source># Stop forwarding for member01 and member02 of loadbalancer +# Disable forwarding for member21 and member22 of loadbalancer +/myapp=myloadbalancer;stopped=member01,member02;disabled=member21,member22 </source> For the precise meaning of the activation states see the description of <a href="../reference/workers.html#Advanced Worker Directives">activation</a>. </p> </subsection> <subsection name="Extension fail_on_status"> -<br/> <p> The extension <code>fail_on_status</code> can be used in any rule: -<source> - # Send 503 instead of 404 and 500, - # and if we get a 503 also set the worker to error - /myapp=myworker;fail_on_status=-404,-500,503 +<source># Send 503 instead of 404 and 500, +# and if we get a 503 also set the worker to error +/myapp=myworker;fail_on_status=-404,-500,503 </source> Multiple status codes must be separated by commas. For the precise meaning of the attribute see the description of @@ -319,7 +290,6 @@ For the precise meaning of the attribute </p> </subsection> <subsection name="Extension use_server_errors"> -<br/> <p> The extension <code>use_server_errors</code> allows to let the web server send an error page, instead of the backend (e.g. Tomcat) error page. @@ -332,16 +302,14 @@ Any request send to the backend, that re code bigger or equal to <code>use_server_errors</code>, will be answered to the client with the error page of the web server for this status code. -<source> - # Use web server error page for all errors - /myapp=myworker;use_server_errors=400 - # Use web server error page only for technical errors - /myotherapp=myworker;use_server_errors=500 +<source># Use web server error page for all errors +/myapp=myworker;use_server_errors=400 +# Use web server error page only for technical errors +/myotherapp=myworker;use_server_errors=500 </source> </p> </subsection> <subsection name="Extensions controlling load balancer stickyness"> -<br/> <p> The extensions <ul> @@ -358,39 +326,34 @@ per mount. See their descriptions in the </section> <section name="Virtual host integration"> -<br/> <subsection name="ISAPI redirector for Microsoft IIS"> -<br/> <p> When using the ISAPI redirector for Microsoft IIS you can restrict individual rules to special virtual hosts by prefixing the URI pattern with the virtual host information. The rules is that the url must be prefixed with the host name. -<source> - # Use www.foo.org as virtual host - /www.foo.org/myapp/*=myworker - # Use www.bar.org as virtual host - /www.bar.org/myapp/*=myworker - # Normal mapping - /mysecondapp/*=myworker +<source># Use www.foo.org as virtual host +/www.foo.org/myapp/*=myworker +# Use www.bar.org as virtual host +/www.bar.org/myapp/*=myworker +# Normal mapping +/mysecondapp/*=myworker </source> </p> <p> Note that /mysecondapp/* will be mapped to all virtual hosts present. In case one needs to prevent the mappings to some particular virtual host then the exclusion rule must be used -<source> - # Make sure the myapp is accessible by all virtual hosts - /myapp/*=myworker - # Disable mapping myapp for www.foo.org virtual host - !/www.foo.org/myapp/*=myworker +<source># Make sure the myapp is accessible by all virtual hosts +/myapp/*=myworker +# Disable mapping myapp for www.foo.org virtual host +!/www.foo.org/myapp/*=myworker </source> </p> </subsection> <subsection name="mod_jk for Apache HTTP Server"> -<br/> <p> For the Apache HTTP Server you can define individual uriworkermap files per virtual host. The directive JkMountFile can be used in the main server and in each virtual host. @@ -402,7 +365,6 @@ mounts from the main server, you can set </section> <section name="Dynamic reloading"> -<br/> <p> When a request is being processed, tomcat connectors check the file modification time of the uriworkermap file. To keep the performance penalty low, this happens only, @@ -428,7 +390,6 @@ rule as disabled in the new file. Rules </section> <section name="Status worker integration"> -<br/> <p> The configuration view of the status worker also shows the various mapping rules. After each worker's configuration, the rules are listed, that forward to this worker. Modified: tomcat/jk/trunk/xdocs/reference/workers.xml URL: http://svn.apache.org/viewvc/tomcat/jk/trunk/xdocs/reference/workers.xml?rev=1848904&r1=1848903&r2=1848904&view=diff ============================================================================== --- tomcat/jk/trunk/xdocs/reference/workers.xml (original) +++ tomcat/jk/trunk/xdocs/reference/workers.xml Thu Dec 13 22:03:14 2018 @@ -30,7 +30,6 @@ <body> <section name="Introduction"> -<br/> <p> A <b>Tomcat worker</b> is a Tomcat instance that is waiting to execute servlets or any other content on behalf of some web server. For example, we can have a web server such as @@ -68,13 +67,11 @@ explains how to work with it. </section> <section name="Configuration File Basics"> -<br/> <p>Defining workers to the Tomcat web server plugin can be done using a properties file (a sample file named workers.properties is available in the conf/ directory). </p> <subsection name="Format, Comments, Whitespace"> -<br/> <p> The lines in the file define properties. The general format is </p> @@ -107,7 +104,6 @@ to <b>false</b> and <b>true</b>. </subsection> <subsection name="Global Properties"> -<br/> <p> These directives have global scope. </p> @@ -137,7 +133,6 @@ This feature has been added in <b>jk 1.2 </subsection> <subsection name="Worker Properties"> -<br/> <p> Each worker configuration directive consists of three words separated by a dot: </p> @@ -155,7 +150,6 @@ The name of the worker can contain only </subsection> <subsection name="Variables, Environment Variables"> -<br/> <p> You can define and use variables in the workers.properties file. To define a variable you use the syntax: @@ -175,7 +169,6 @@ a variable with the same name and use th </subsection> <subsection name="Property Inheritance"> -<br/> <p>Often one wants to use the same property values for various workers. To reduce duplication of configuration lines and to ease the maintenance of the file, you can inherit properties from one worker to another, or even @@ -212,9 +205,7 @@ This feature has been added in <b>jk 1.2 </section> <section name="List of All Worker Directives"> -<br/> <subsection name="Mandatory Directives"> -<br/> <p>Mandatory directives are the one that each worker <b>must</b> contain. Without them the worker will be unavailable or will misbehave. Those directives will be marked with a <strong>strong</strong> font in the following tables. </p> @@ -238,7 +229,6 @@ is obsolete. </subsection> <subsection name="Connection Directives"> -<br/> <p>Connection directives defines the parameters needed to connect and maintain the connections pool of persistent connections between JK and remote Tomcat. </p> @@ -457,7 +447,6 @@ other worker, then it will receive five </subsection> <subsection name="Load Balancing Directives"> -<br/> <p>Load balancer is a virtual worker that does not really communicate with Tomcat workers. Instead it is responsible for the management of several "real" workers. The worker is supposed to be a load balancer if it's worker type is <b>lb</b>. @@ -684,7 +673,6 @@ number of member workers. </subsection> <subsection name="Status Worker Directives"> -<br /> <p> The status worker does not communicate with Tomcat. Instead it is responsible for the load balancer management. @@ -809,7 +797,6 @@ This feature has been added in <b>jk 1.2 </subsection> <subsection name="Advanced Worker Directives"> -<br /> <p> This table lists more advanced configuration options. Most of them only apply to some types of workers. We use the abbreviations <b>AJP</b> for ajp13/ajp14 workers @@ -1198,7 +1185,6 @@ This feature has been added in <b>jk 1.2 </subsection> <subsection name="Deprecated Worker Directives"> -<br/> <p>The following directives have been deprecated in the past. We include their documentation in case you need to use an older version of mod_jk. We urge you to update and not use them any more. Please migrate your existing configurations. Added: tomcat/jk/trunk/xdocs/tomcat-docs.xsl URL: http://svn.apache.org/viewvc/tomcat/jk/trunk/xdocs/tomcat-docs.xsl?rev=1848904&view=auto ============================================================================== --- tomcat/jk/trunk/xdocs/tomcat-docs.xsl (added) +++ tomcat/jk/trunk/xdocs/tomcat-docs.xsl Thu Dec 13 22:03:14 2018 @@ -0,0 +1,560 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<!-- Content Stylesheet for "tomcat-docs" Documentation --> + +<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"; + version="3.0"> + + + <!-- Output method --> + <xsl:output method="html" + html-version="5.0" + encoding="UTF-8" + indent="no" + doctype-system="about:legacy-compat"/> + + + <!-- Defined parameters (overrideable) --> + <xsl:param name="home-name" select="'The Tomcat Project'"/> + <xsl:param name="home-href" select="'https://tomcat.apache.org/'"/> + <xsl:param name="home-logo" select="'/images/tomcat.png'"/> + <xsl:param name="home-stylesheet" select="'/images/docs-stylesheet.css'"/> + <xsl:param name="apache-logo" select="'/images/asf-logo.svg'"/> + <xsl:param name="subdir" select="''"/> + <xsl:param name="relative-path" select="'.'"/> + <xsl:param name="version" select="'1.2.x'"/> + <xsl:param name="majorversion" select="'1'"/> + <xsl:param name="majorminorversion" select="'1.2'"/> + <xsl:param name="build-date" select="'MMM d yyyy'"/> + <xsl:param name="build-date-iso-8601" select="'yyyy-MM-dd'"/> + <xsl:param name="year" select="'yyyy'"/> + <xsl:param name="buglink" select="'https://bz.apache.org/bugzilla/show_bug.cgi?id='"/> + <xsl:param name="revlink" select="'https://svn.apache.org/viewvc?view=rev&rev='"/> + <xsl:param name="doclink" select="'https://tomcat.apache.org/connectors-doc'"/> + <xsl:param name="sylink" select="'https://tomcat.apache.org/security-jk.html'"/> + <xsl:param name="dllink" select="'https://tomcat.apache.org/download-connectors.cgi'"/> + <xsl:param name="sitedir" select="''"/> + <xsl:param name="filename" select="'-'"/> + + <!-- Defined variables (non-overrideable) --> + <xsl:variable name="commentslink"><xsl:value-of select="$relative-path"/>/comments.html</xsl:variable> + <xsl:variable name="project-xml-filename"><xsl:value-of select="$subdir"/>project.xml</xsl:variable> + <xsl:variable name="project" + select="document($project-xml-filename)/project"/> + + <!-- Process an entire document into an HTML page --> + <xsl:template match="document"> +<html lang="en"> +<head> + <!-- Note: XLST seems to always output a + <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> + when method="html", + therefore we can't use + <meta charset="UTF-8"/>. + + In XHTML, this is not needed as the encoding will be + specified in the XML declaration. + --> + + <xsl:variable name="css-src"> + <xsl:value-of select="$relative-path"/><xsl:value-of select="$home-stylesheet"/> + </xsl:variable> + <link href="{$css-src}" rel="stylesheet" type="text/css"/> + + <title><xsl:value-of select="$project/title"/> (<xsl:value-of select="$version"/>) - <xsl:value-of select="properties/title"/></title> + <xsl:for-each select="properties/author"> + <xsl:variable name="name"> + <xsl:value-of select="."/> + </xsl:variable> + <!-- + <xsl:variable name="email"> + <xsl:value-of select="@email"/> + </xsl:variable> + --> + <meta name="author" content="{$name}"/> + </xsl:for-each> + + <!-- Script for ASF Comments System. --> + <!-- + Use data-* attributes for retrieval of XSLT-generated data + in JavaScript. + Use this approach rather than directly inserting text + in a JS string literal as that would cause + problems when the string contains special characters + like ", ', \n etc. + --> + <xsl:variable name="comments-identifier"> + <xsl:value-of select="$sitedir"/><xsl:value-of select="$subdir"/><xsl:value-of select="substring($filename,1,string-length($filename)-4)"/> + </xsl:variable> + <xsl:if test="not(properties/no-comments)"> + <script type="application/javascript" + data-comments-identifier="{$comments-identifier}"><![CDATA[ + "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> + </xsl:if> + </head> + + <body> + <div id="wrapper"> + <!-- Header --> + <header><div id="header"> + <div> + <div> + <xsl:if test="$project/logo"> + <xsl:variable name="src"> + <xsl:value-of select="$relative-path"/><xsl:value-of select="$home-logo"/> + </xsl:variable> + <div class="logo noPrint"> + <a href="{$project/@href}"><img alt="Tomcat Home" src="{$src}"/></a> + </div> + </xsl:if> + + <div style="height: 1px;"/> + <xsl:variable name="src"> + <xsl:value-of select="$relative-path"/><xsl:value-of select="$apache-logo"/> + </xsl:variable> + <div class="asfLogo noPrint"> + <a href="https://www.apache.org/"; target="_blank"><img src="{$src}" alt="The Apache Software Foundation" style="width: 266px; height: 83px;"/></a> + </div> + <h1><xsl:value-of select="$project/title"/></h1> + <!-- version and build-date aren't available, so we can't display them + <div class="versionInfo"> + Version <xsl:value-of select="$version"/>, + <time datetime="{$build-date-iso-8601}"><xsl:value-of select="$build-date"/></time> + </div> + --> + <div style="height: 1px;"/> + <div style="clear: left;"/> + </div> + </div> + </div></header> + + <div id="middle"> + <div> + <div id="mainLeft" class="noprint"> + <div> + <!-- Navigation --> + <nav> + <xsl:apply-templates select="$project/body/menu"/> + </nav> + </div> + </div> + <div id="mainRight"> + <div id="content"> + <!-- Main Part --> + <h2><xsl:value-of select="properties/title"/></h2> + <xsl:apply-templates select="body/section"/> + + <!-- Comments Section --> + <xsl:if test="not(properties/no-comments)"> + <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="{$commentslink}">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> + </xsl:if> + + </div> + </div> + </div> + </div> + + <!-- Footer --> + <footer><div id="footer"> + Copyright © 1999-<xsl:value-of select="$year"/>, The Apache Software Foundation + </div></footer> +</div> +</body> +</html> + + + </xsl:template> + + + <!-- Process a menu for the navigation bar --> + <xsl:template match="menu"> + <div> + <h2><xsl:value-of select="@name"/></h2> + <ul> + <xsl:apply-templates select="item"/> + </ul> + </div> + </xsl:template> + + + <!-- Process a menu item for the navigation bar --> + <xsl:template match="item"> + <xsl:variable name="href"> + <xsl:value-of select="@href"/> + </xsl:variable> + <li><a href="{$href}"><xsl:value-of select="@name"/></a></li> + </xsl:template> + + + <!-- Process a documentation section --> + <xsl:template match="section"> + <xsl:variable name="name2"> + <xsl:choose> + <xsl:when test="@anchor"> + <xsl:value-of select="@anchor" /> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="@name"/> + </xsl:otherwise> + </xsl:choose> + </xsl:variable> + <xsl:variable name="name"> + <xsl:value-of select="translate($name2, ' #', '__')"/> + </xsl:variable> + + + <!-- Section heading --> + <h3 id="{$name}"> + <xsl:if test="@rtext"> + <!-- Additional right-aligned text cell in section heading. It is used by changelog.xml --> + <span style="float: right;"> + <xsl:value-of select="@rtext"/> + </span><xsl:text> </xsl:text> <!-- Ensure a space follows after </span> --> + </xsl:if> + <xsl:value-of select="@name"/> + </h3> + <!-- Section body --> + <div class="text"> + <xsl:apply-templates/> + </div> + + </xsl:template> + + + <!-- Process a documentation subsection --> + <xsl:template match="subsection"> + <xsl:variable name="name2"> + <xsl:choose> + <xsl:when test="@anchor"> + <xsl:value-of select="@anchor" /> + </xsl:when> + <xsl:otherwise> + <xsl:if test=" + count(//*[self::section or self::subsection][@name=current()/@name]) > 1 + "> + <xsl:value-of select="concat(parent::*[self::section or self::subsection]/@name, '/')"/> + </xsl:if> + <xsl:value-of select="@name"/> + </xsl:otherwise> + </xsl:choose> + </xsl:variable> + <xsl:variable name="name"> + <xsl:value-of select="translate($name2, ' #', '__')"/> + </xsl:variable> + + <div class="subsection"> + <!-- Subsection heading --> + <!-- TODO: When a <subsection> is nested in another <subsection>, + the output should be <h5>, not <h4>. Same with <h6>. --> + <h4 id="{$name}"> + <xsl:value-of select="@name"/> + </h4> + <!-- Subsection body --> + <div class="text"> + <xsl:apply-templates/> + </div> + </div> + + </xsl:template> + + + <!-- Generate table of contents --> + <xsl:template match="toc"> + <ul><xsl:apply-templates mode="toc" select="following::section"/></ul> + </xsl:template> + + <xsl:template mode="toc" match="section|subsection"> + <xsl:variable name="name2"> + <xsl:choose> + <xsl:when test="@anchor"> + <xsl:value-of select="@anchor" /> + </xsl:when> + <xsl:otherwise> + <xsl:if test="local-name()='subsection' and + count(//*[self::section or self::subsection][@name=current()/@name]) > 1 + "> + <xsl:value-of select="concat(parent::*[self::section or self::subsection]/@name, '/')"/> + </xsl:if> + <xsl:value-of select="@name"/> + </xsl:otherwise> + </xsl:choose> + </xsl:variable> + <xsl:variable name="name"> + <xsl:value-of select="translate($name2, ' #', '__')"/> + </xsl:variable> + <li><a href="#{$name}"><xsl:value-of select="@name"/></a> + <xsl:if test="subsection"> + <ol><xsl:apply-templates mode="toc" select="subsection"/></ol> + </xsl:if> + </li> + </xsl:template> + + + <!-- Process a source code example --> + <xsl:template match="source"> + <div class="codeBox"> + <pre> + <xsl:if test="@wrapped='true'"> + <xsl:attribute name="class">wrap</xsl:attribute> + </xsl:if> + <code><xsl:apply-templates/></code> + </pre> + </div> + </xsl:template> + + <!-- Process an attributes list with nested attribute elements --> + <xsl:template match="attributes"> + <table class="defaultTable"> + <tr> + <th style="width: 15%;"> + Attribute + </th> + <th style="width: 85%;"> + Description + </th> + </tr> + <xsl:for-each select="attribute"> + <tr> + <td> + <xsl:if test="@required = 'true'"> + <strong><code class="attributeName"><xsl:value-of select="@name"/></code></strong> + </xsl:if> + <xsl:if test="@required != 'true'"> + <code class="attributeName"><xsl:value-of select="@name"/></code> + </xsl:if> + </td> + <td> + <xsl:apply-templates/> + </td> + </tr> + </xsl:for-each> + </table> + </xsl:template> + + <!-- Process an directives list with nested directive elements --> + <xsl:template match="directives"> + <table class="defaultTable"> + <tr> + <th style="width: 15%;"> + Directive + </th> + <th style="width: 10%;text-align:center"> + Default + </th> + <th style="width: 75%;"> + Description + </th> + </tr> + <xsl:for-each select="directive"> + <tr> + <td> + <xsl:if test="@required = 'true'"> + <strong><code class="attributeName"><xsl:value-of select="@name"/></code></strong> + </xsl:if> + <xsl:if test="@required != 'true'"> + <code class="attributeName"><xsl:value-of select="@name"/></code> + </xsl:if> + </td> + <xsl:choose> + <xsl:when test="@default != ''"> + <td style="text-align:center"> + <code><xsl:value-of select="@default"/></code> + </td> + </xsl:when> + <xsl:otherwise> + <td style="text-align:center"> + <code>-</code> + </td> + </xsl:otherwise> + </xsl:choose> + <td> + <xsl:apply-templates/> + </td> + </tr> + </xsl:for-each> + </table> + </xsl:template> + + <!-- Process a properties list with nested property elements --> + <xsl:template match="properties"> + <table class="defaultTable"> + <tr> + <th style="width: 15%;"> + Property + </th> + <th style="width: 85%;"> + Description + </th> + </tr> + <xsl:for-each select="property"> + <tr> + <td> + <code class="propertyName"><xsl:value-of select="@name"/></code> + </td> + <td> + <xsl:apply-templates/> + </td> + </tr> + </xsl:for-each> + </table> + </xsl:template> + + <!-- Changelog related tags --> + <xsl:template match="changelog"> + <ul class="changelog"> + <xsl:apply-templates/> + </ul> + </xsl:template> + + <xsl:template match="changelog/add"> + <xsl:variable name="src"><xsl:value-of select="$relative-path"/>/images/add.gif</xsl:variable> + <li> + <img alt="Add: " class="icon" src="{$src}"/><xsl:apply-templates/> + </li> + </xsl:template> + + <xsl:template match="changelog/update"> + <xsl:variable name="src"><xsl:value-of select="$relative-path"/>/images/update.gif</xsl:variable> + <li> + <img alt="Update: " class="icon" src="{$src}"/><xsl:apply-templates/> + </li> + </xsl:template> + + <xsl:template match="changelog/design"> + <xsl:variable name="src"><xsl:value-of select="$relative-path"/>/images/design.gif</xsl:variable> + <li> + <img alt="Design: " class="icon" src="{$src}"/><xsl:apply-templates/> + </li> + </xsl:template> + + <xsl:template match="changelog/docs"> + <xsl:variable name="src"><xsl:value-of select="$relative-path"/>/images/docs.gif</xsl:variable> + <li> + <img alt="Docs: " class="icon" src="{$src}"/><xsl:apply-templates/> + </li> + </xsl:template> + + <xsl:template match="changelog/fix"> + <xsl:variable name="src"><xsl:value-of select="$relative-path"/>/images/fix.gif</xsl:variable> + <li> + <img alt="Fix: " class="icon" src="{$src}"/><xsl:apply-templates/> + </li> + </xsl:template> + + <xsl:template match="changelog/scode"> + <xsl:variable name="src"><xsl:value-of select="$relative-path"/>/images/code.gif</xsl:variable> + <li> + <img alt="Code: " class="icon" src="{$src}"/><xsl:apply-templates/> + </li> + </xsl:template> + + <!-- Link to a bug report --> + <xsl:template match="bug"> + <xsl:variable name="link"><xsl:value-of select="$buglink"/><xsl:value-of select="text()"/></xsl:variable> + <a href="{$link}"><xsl:apply-templates/></a> + </xsl:template> + + <!-- Link to a SVN revision report --> + <xsl:template match="rev"> + <xsl:variable name="link"><xsl:value-of select="$revlink"/><xsl:value-of select="text()"/></xsl:variable> + <a href="{$link}">r<xsl:apply-templates/></a> + </xsl:template> + + <!-- Link to online docs --> + <xsl:template match="doc"> + <xsl:variable name="link"><xsl:value-of select="$doclink"/><xsl:value-of select="@path"/></xsl:variable> + <a href="{$link}"><xsl:apply-templates/></a> + </xsl:template> + + <!-- Link to security page --> + <xsl:template match="security"> + <xsl:variable name="link"><xsl:value-of select="$sylink"/></xsl:variable> + <a href="{$link}"><xsl:apply-templates/></a> + </xsl:template> + + <!-- Link to download page --> + <xsl:template match="download"> + <xsl:variable name="link"><xsl:value-of select="$dllink"/></xsl:variable> + <a href="{$link}"><xsl:apply-templates/></a> + </xsl:template> + + <!-- Version numbers --> + <xsl:template match="version-major-minor"> + <xsl:value-of select="$majorminorversion"/> + </xsl:template> + <xsl:template match="version-major"> + <xsl:value-of select="$majorversion"/> + </xsl:template> + + <!-- Process everything else by just passing it through --> + <xsl:template match="*|@*"> + <xsl:copy> + <xsl:apply-templates select="@*|*|text()"/> + </xsl:copy> + </xsl:template> + +</xsl:stylesheet> Modified: tomcat/jk/trunk/xdocs/webserver_howto/apache.xml URL: http://svn.apache.org/viewvc/tomcat/jk/trunk/xdocs/webserver_howto/apache.xml?rev=1848904&r1=1848903&r2=1848904&view=diff ============================================================================== --- tomcat/jk/trunk/xdocs/webserver_howto/apache.xml (original) +++ tomcat/jk/trunk/xdocs/webserver_howto/apache.xml Thu Dec 13 22:03:14 2018 @@ -246,9 +246,8 @@ in Tomcat and put the following include (make sure you replace $TOMCAT_HOME with the correct path for your Tomcat installation: </p> -<source> - #To be added at the end of your httpd.conf - Include $TOMCAT_HOME/conf/jk/mod_jk.conf-auto +<source># To be added at the end of your httpd.conf +Include $TOMCAT_HOME/conf/jk/mod_jk.conf-auto </source> <p> @@ -264,14 +263,13 @@ element in the server.xml file as per th <b>Please note that this example is specific to Tomcat 5.x, unlike other sections of this document which also apply to previous Tomcat branches.</b> </p> -<source> +<source>... +<Engine ...> ... - <Engine ...> - ... <Listener className="org.apache.jk.config.ApacheConfig" modJk="/path/to/mod_jk.so" /> - ... - </Engine> ... +</Engine> +... </source> <p> @@ -309,21 +307,20 @@ to their real needs. Here is a simple configuration: </p> -<source> - # Load mod_jk module - LoadModule jk_module modules/mod_jk.so - # Add the module (activate this lne for Apache 1.3) - # AddModule mod_jk.c - # Where to find workers.properties - JkWorkersFile /etc/httpd/conf/workers.properties - # Where to put jk shared memory - JkShmFile /var/log/httpd/mod_jk.shm - # Where to put jk logs - JkLogFile /var/log/httpd/mod_jk.log - # Set the jk log level [debug/error/info] - JkLogLevel info - # Send requests for context /examples to worker named worker1 - JkMount /examples/* worker1 +<source># Load mod_jk module +LoadModule jk_module modules/mod_jk.so +# Add the module (activate this lne for Apache 1.3) +# AddModule mod_jk.c +# Where to find workers.properties +JkWorkersFile /etc/httpd/conf/workers.properties +# Where to put jk shared memory +JkShmFile /var/log/httpd/mod_jk.shm +# Where to put jk logs +JkLogFile /var/log/httpd/mod_jk.log +# Set the jk log level [debug/error/info] +JkLogLevel info +# Send requests for context /examples to worker named worker1 +JkMount /examples/* worker1 </source> </subsection> @@ -338,12 +335,9 @@ We'll discuss here the mod_jk directives <p> <b>JkWorkersFile</b> specify the location where mod_jk will find the workers definitions. -<source> - JkWorkersFile /etc/httpd/conf/workers.properties +<source>JkWorkersFile /etc/httpd/conf/workers.properties </source> -<br/> -<br/> </p> </subsection> @@ -352,8 +346,7 @@ We'll discuss here the mod_jk directives <b>JkLogFile</b> specify the location where mod_jk is going to place its log file. </p> -<source> - JkLogFile /var/log/httpd/mod_jk.log +<source>JkLogFile /var/log/httpd/mod_jk.log </source> <p> @@ -361,8 +354,7 @@ Since JK 1.2.3 for Apache 2.x and JK 1.2 be used for piped logging: </p> -<source> - JkLogFile "|/usr/bin/rotatelogs /var/log/httpd/mod_jk.log 86400" +<source>JkLogFile "|/usr/bin/rotatelogs /var/log/httpd/mod_jk.log 86400" </source> <p> @@ -382,14 +374,11 @@ set the log level between: </li> </ul> -<source> - JkLogLevel info +<source>JkLogLevel info </source> <p> <code>info</code> should be your default selection for normal operations. -<br/> -<br/> </p> <p> @@ -397,34 +386,22 @@ set the log level between: See the mod_jk <a href="../reference/apache.html">Apache HTTP Server reference</a> for details. </p> -<source> - JkLogStampFormat "[%y-%m-%d %H:%M:%S.%Q] " +<source>JkLogStampFormat "[%y-%m-%d %H:%M:%S.%Q] " </source> <p> -<br/> -<br/> -</p> - -<p> You can log mod_jk information using the Apache standard module <b>mod_log_config</b>. The module sets several notes in the Apache notes table. Most of them are are only useful in combination with a load balancer worker. See the mod_jk <a href="../reference/apache.html">Apache HTTP Server reference</a> for details. </p> -<source> - LogFormat "%h %l %u %t \"%r\" %>s %b %{JK_WORKER_NAME}n %{JK_LB_FIRST_NAME}n \ - %{JK_LB_FIRST_BUSY}n %{JK_LB_LAST_NAME}n %{JK_LB_LAST_BUSY}n" mod_jk_log - CustomLog logs/access_log mod_jk_log +<source>LogFormat "%h %l %u %t \"%r\" %>s %b %{JK_WORKER_NAME}n %{JK_LB_FIRST_NAME}n \ + %{JK_LB_FIRST_BUSY}n %{JK_LB_LAST_NAME}n %{JK_LB_LAST_BUSY}n" mod_jk_log +CustomLog logs/access_log mod_jk_log </source> <p> -<br/> -<br/> -</p> - -<p> You can also log a request protocol in the mod_jk log file instead of the access log. This is not recommended and mostly a backward compatibility feature. The directive <b>JkRequestLogFormat</b> will configure the format @@ -432,23 +409,15 @@ of this protocol. It gets configured and See the mod_jk <a href="../reference/apache.html">Apache HTTP Server reference</a> for details. </p> -<source> - JkRequestLogFormat "%w %V %T" +<source>JkRequestLogFormat "%w %V %T" </source> -<p> -<br/> -<br/> -</p> - </subsection> <subsection name="Forwarding"> <p> The directive JkOptions allow you to set many forwarding options which will enable (+) or disable (-) following option. Without any leading signs, options will be enabled. -<br/> -<br/> </p> <p> @@ -460,8 +429,6 @@ It was "ForwardURICompatUnparsed" in ver You can turn the default off by switching on one of the other two options. You should leave this at it's default value, unless you have a very good reason to change it. -<br/> -<br/> </p> <p> @@ -469,10 +436,8 @@ All options are inherited from the globa Options that support enabling (plus options) and disabling (minus options), are inherited in the following way: <br/> -<br/> options(vhost) = plus_options(global) - minus_options(global) + plus_options(vhost) - minus_options(vhost) <br/> -<br/> </p> <p> @@ -481,12 +446,9 @@ will be partially reencoded after proces before forwarding to Tomcat. This will be compatible with local URL manipulation by mod_rewrite and with URL encoded session ids. -<source> - JkOptions +ForwardURIProxy +<source>JkOptions +ForwardURIProxy </source> -<br/> -<br/> </p> <p> @@ -496,12 +458,9 @@ It will always forward the original requ URIs with mod_rewrite and then forwarding the rewritten URI will not work. -<source> - JkOptions +ForwardURICompatUnparsed +<source>JkOptions +ForwardURICompatUnparsed </source> -<br/> -<br/> </p> <p> Using JkOptions <b>ForwardURICompat</b>, the forwarded URI will @@ -511,12 +470,9 @@ This is less spec compliant and is <b>no prefix JkMount. This option will allow to rewrite URIs with mod_rewrite before forwarding. -<source> - JkOptions +ForwardURICompat +<source>JkOptions +ForwardURICompat </source> -<br/> -<br/> </p> <p> Using JkOptions <b>ForwardURIEscaped</b>, the forwarded URI will @@ -525,20 +481,15 @@ Explicit path components like ".." will This will not work in combination with URL encoded session IDs, but it will allow to rewrite URIs with mod_rewrite before forwarding. -<source> - JkOptions +ForwardURIEscaped +<source>JkOptions +ForwardURIEscaped </source> -<br/> -<br/> </p> <p> JkOptions <b>RejectUnsafeURI</b> will block all URLs, which contain percent signs '%' or backslashes '\' after decoding. -<br/> -<br/> </p> <p> Most web apps do not use such URLs. Using the option RejectUnsafeURI, you @@ -549,12 +500,9 @@ is not set. You can also realise such a check with mod_rewrite, which is more powerful but also slightly more complicated. -<source> - JkOptions +RejectUnsafeURI +<source>JkOptions +RejectUnsafeURI </source> -<br/> -<br/> </p> <p> @@ -576,8 +524,6 @@ ignored if used. JkOptions <b>ForwardDirectories</b> is used in conjunction with <b>DirectoryIndex</b> directive of Apache. As such mod_dir should be available to Apache, statically or dynamically (DSO) -<br/> -<br/> </p> <p> @@ -606,11 +552,8 @@ ones visible only to Tomcat (i.e. if Apa that's going to get served). This is important if there is more then one type of file that Tomcat normally serves - for instance Velocity pages and JSP pages. -<source> - JkOptions +ForwardDirectories +<source>JkOptions +ForwardDirectories </source> -<br/> -<br/> </p> <p> @@ -619,11 +562,8 @@ of the Apache HTTP Server instead of rem Tomcat remote address valve for allowing connections only from configured Apache servers. -<source> - JkOptions +ForwardLocalAddress +<source>JkOptions +ForwardLocalAddress </source> -<br/> -<br/> </p> <p> @@ -633,11 +573,8 @@ uses the logical address as provided by mod_remoteip sets the logical IP address to the client IP forwarded by proxies in the <code>X-Forwarded-For</code> header. -<source> - JkOptions +ForwardPhysicalAddress +<source>JkOptions +ForwardPhysicalAddress </source> -<br/> -<br/> </p> <p> @@ -647,24 +584,18 @@ a strong performance penalty for Apache more often than would normally be required (ie: at the end of each response). -<source> - JkOptions +FlushPackets +<source>JkOptions +FlushPackets </source> -<br/> -<br/> </p> <p> JkOptions <b>FlushHeader</b>, you ask mod_jk to flush Apache's connection buffer after the response headers have been received from Tomcat. -<source> - JkOptions +FlushHeader +<source>JkOptions +FlushHeader </source> -<br/> -<br/> </p> <p> @@ -680,12 +611,9 @@ If a firewall between Apache and Tomcat try to use the worker attribute socket_keepalive in combination with an appropriate TCP keepalive value in your OS. -<source> - JkOptions +DisableReuse +<source>JkOptions +DisableReuse </source> -<br/> -<br/> </p> <p> @@ -693,12 +621,9 @@ JkOptions <b>ForwardKeySize</b>, you ask required by Servlet API 2.3. This flag shouldn't be set when servlet engine is Tomcat 3.2.x (off by default). -<source> - JkOptions +ForwardKeySize +<source>JkOptions +ForwardKeySize </source> -<br/> -<br/> </p> <p> @@ -712,12 +637,9 @@ will not have the possibility to validat bug would be fixed by passing on the <code>SSL_CLIENT_CERT_CHAIN</code> to Tomcat via the AJP connector. <br/> This directive exists only since version 1.2.22. -<source> - JkOptions +ForwardSSLCertChain +<source>JkOptions +ForwardSSLCertChain </source> -<br/> -<br/> </p> <p> @@ -732,14 +654,10 @@ via request.getAttribute(attributeName). Note that the variables send via JkEnvVar will not be listed in request.getAttributeNames(). <br/> -<br/> The variables are inherited from the global server to virtual hosts. -<source> - JkEnvVar SSL_CLIENT_V_START undefined +<source>JkEnvVar SSL_CLIENT_V_START undefined </source> -<br/> -<br/> </p> </subsection> @@ -755,15 +673,14 @@ you can change settings such as the work In general the structure of a JkMount directive is: </p> -<source> JkMount [URL prefix] [Worker name]</source> +<source>JkMount [URL prefix] [Worker name]</source> -<source> - # send all requests ending in .jsp to worker1 - JkMount /*.jsp worker1 - # send all requests ending /servlet to worker1 - JkMount /*/servlet/ worker1 - # send all requests jsp requests to files located in /otherworker will go worker2 - JkMount /otherworker/*.jsp worker2 +<source># send all requests ending in .jsp to worker1 +JkMount /*.jsp worker1 +# send all requests ending /servlet to worker1 +JkMount /*/servlet/ worker1 +# send all requests jsp requests to files located in /otherworker will go worker2 +JkMount /otherworker/*.jsp worker2 </source> <p> @@ -790,15 +707,14 @@ application's web.xml. document space for a VirtualHost: </p> -<source> - # Static files in the examples webapp are served by Apache - Alias /examples /vat/tomcat3/webapps/examples - # All requests go to worker1 by default - JkMount /* worker1 - # Serve html, jpg and gif using Apache - JkUnMount /*.html worker1 - JkUnMount /*.jpg worker1 - JkUnMount /*.gif worker1 +<source># Static files in the examples webapp are served by Apache +Alias /examples /vat/tomcat3/webapps/examples +# All requests go to worker1 by default +JkMount /* worker1 +# Serve html, jpg and gif using Apache +JkUnMount /*.html worker1 +JkUnMount /*.jpg worker1 +JkUnMount /*.gif worker1 </source> <p> @@ -811,27 +727,26 @@ You could use <b>no-jk</b> env var to fi directive when jk and alias/userdir URLs matches. </p> -<source> - # All URL goes to tomcat except the one containing /home - <VirtualHost *:80> - ServerName testxxx.mysys - DocumentRoot /www/testxxx/htdocs - - # Use SetEnvIf to set no-jk when /home/ is encountered - SetEnvIf Request_URI "/home/*" no-jk - - # Now /home will goes to /home/dataxxx/ - Alias /home /home/dataxxx/ - - <Directory "/home/dataxxx"> - Options Indexes MultiViews - AllowOverride None - Require all granted - </Directory> +<source># All URL goes to tomcat except the one containing /home +<VirtualHost *:80> + ServerName testxxx.mysys + DocumentRoot /www/testxxx/htdocs + +# Use SetEnvIf to set no-jk when /home/ is encountered + SetEnvIf Request_URI "/home/*" no-jk + +# Now /home will goes to /home/dataxxx/ + Alias /home /home/dataxxx/ + + <Directory "/home/dataxxx"> + Options Indexes MultiViews + AllowOverride None + Require all granted + </Directory> - JkMount /* myssys-xxx + JkMount /* myssys-xxx - </VirtualHost> +</VirtualHost> </source> @@ -846,16 +761,15 @@ or a Web Archive *.war within the Tomcat <code>HTTP 403, Access Forbidden</code> </p> -<source> - # Static files in all Tomcat webapp context directories are served by Apache - JkAutoAlias /var/tomcat3/webapps - - # All requests go to worker1 by default - JkMount /* ajp13 - # Serve html, jpg and gif using Apache - JkUnMount /*.html ajp13 - JkUnMount /*.jpg ajp13 - JkUnMount /*.gif ajp13 +<source># Static files in all Tomcat webapp context directories are served by Apache +JkAutoAlias /var/tomcat3/webapps + +# All requests go to worker1 by default +JkMount /* ajp13 +# Serve html, jpg and gif using Apache +JkUnMount /*.html ajp13 +JkUnMount /*.jpg ajp13 +JkUnMount /*.gif ajp13 </source> <p> @@ -902,8 +816,7 @@ To create the configure script just type <subsection name="Using configure to build mod_jk"> <p>Here's how to use configure to prepare mod_jk for building, just type: -<source> -./configure [autoconf arguments] [mod_jk arguments] +<source>./configure [autoconf arguments] [mod_jk arguments] </source> </p> Modified: tomcat/jk/trunk/xdocs/webserver_howto/iis.xml URL: http://svn.apache.org/viewvc/tomcat/jk/trunk/xdocs/webserver_howto/iis.xml?rev=1848904&r1=1848903&r2=1848904&view=diff ============================================================================== --- tomcat/jk/trunk/xdocs/webserver_howto/iis.xml (original) +++ tomcat/jk/trunk/xdocs/webserver_howto/iis.xml Thu Dec 13 22:03:14 2018 @@ -191,8 +191,7 @@ Create a directory <b>${tomcat_home}\isa Allow the IIS process to create the ISAPI redirector log file. Modify the path as necessary if the log file is to be written to a different directory. Enter the following at a command prompt: -<source> ->icacls "C:\Program Files\Apache Software Foundation\Tomcat 9.0\isapi" /grant "IIS APPPOOL\DefaultAppPool":(OI)(CI)M +<source>>icacls "C:\Program Files\Apache Software Foundation\Tomcat 9.0\isapi" /grant "IIS APPPOOL\DefaultAppPool":(OI)(CI)M </source> On client operating systems with User Account Control (UAC) enabled, the command prompt must be opened using <b>Run as administrator</b> for the above command to @@ -206,8 +205,7 @@ operating system and place it in <b>${to Create <b>${tomcat_home}\isapi\isapi_redirect.properties</b> file to configure the ISAPI redirctor. Configuration can also be performed via registry settings - see below. The contents of this file should be: -<source> -extension_uri=/jakarta/isapi_redirect.dll +<source>extension_uri=/jakarta/isapi_redirect.dll log_file=C:\Program Files\Apache Software Foundation\Tomcat 9.0\isapi\isapi_redirect.log log_level=info worker_file=C:\Program Files\Apache Software Foundation\Tomcat 9.0\isapi\workers.properties @@ -219,8 +217,7 @@ Be careful so that Windows does not add Create <b>${tomcat_home}\isapi\workers.properties</b> file to configure the Tomcat instances that requests will be passed to. For a single Tomcat instance on the local machine the contents of this file should be: -<source> -worker.list=tomcat01 +<source>worker.list=tomcat01 worker.tomcat01.type=ajp13 worker.tomcat01.host=localhost worker.tomcat01.port=8009 @@ -230,8 +227,7 @@ worker.tomcat01.port=8009 Create <b>${tomcat_home}\isapi\uriworkermap.properties</b> file to configure which requests will be passed to Tomcat. To expose the examples web application the contents of this file should be: -<source> -/examples/*=tomcat01 +<source>/examples/*=tomcat01 </source> </li> <li> @@ -362,8 +358,7 @@ Adding a context to the ISAPI redirector your uriworkermap.properties and to add a line that looks like: </p> -<source> - /context/*=worker_name +<source>/context/*=worker_name </source> <p> @@ -373,8 +368,7 @@ As an example, if you want to add a cont uriworkermap.properties will be: </p> -<source> - /shop/*=defworker +<source>/shop/*=defworker </source> After saving uriworkermap.properties restart IIS and it will serve the new context. @@ -422,12 +416,11 @@ Configuring the redirector is somewhat h URL-Path pattern(s) which you want Tomcat to handle (usually only JSP files and servlets). This requires a change to the uriworkermap.properties: -<source> - For the examples context it requires to replace the following line - /examples/*=defworker - with the following two lines - /examples/*.jsp=defworker - /examples/servlet/*=defworker +<source>For the examples context it requires to replace the following line +/examples/*=defworker +with the following two lines +/examples/*.jsp=defworker +/examples/servlet/*=defworker </source> </p> @@ -440,8 +433,7 @@ whose name ends with .jsp. <p> You can even be more explicit and provide lines such as: -<source> - /example/servlets/chat=defworker +<source>/example/servlets/chat=defworker </source> </p> @@ -478,26 +470,24 @@ Defining additional workers is done in t </p> <p> -<source> - # An entry that lists all the workers defined - worker.list=worker1, worker2 - # Entries that define the host and port associated with each of these workers - worker.worker1.host=localhost - worker.worker1.port=8009 - worker.worker1.type=ajp13 - worker.worker2.host=otherhost - worker.worker2.port=8009 - worker.worker2.type=ajp13 +<source># An entry that lists all the workers defined +worker.list=worker1, worker2 +# Entries that define the host and port associated with each of these workers +worker.worker1.host=localhost +worker.worker1.port=8009 +worker.worker1.type=ajp13 +worker.worker2.host=otherhost +worker.worker2.port=8009 +worker.worker2.type=ajp13 </source> </p> <p> The above example defined two workers, now we can use these workers to serve two different contexts each with its own worker: -<source> - example uriworkermap.properties fragment - /examples/*=worker1 - /webpages/*=worker2 +<source>example uriworkermap.properties fragment +/examples/*=worker1 +/webpages/*=worker2 </source> </p> @@ -652,8 +642,7 @@ Then examine the last line in the IIS lo <p> If the last line contains: </p> -<source> - GET "/examples/ HTTP/1.1" 404 +<source>GET "/examples/ HTTP/1.1" 404 </source> <p> then the ISAPI redirector is not recognising that it should be handling requests for the "/examples" context. @@ -675,8 +664,7 @@ If these are set correctly, the ISAPI re <p>If the last line contains something like: </p> -<source> - GET "/jakarta/isapi_redirect.dll HTTP1.1" +<source>GET "/jakarta/isapi_redirect.dll HTTP1.1" </source> <p> @@ -688,8 +676,7 @@ but is not successful at getting Tomcat You should check the HTTP error code following GET "/...": </p> -<source> - Error 404 +<source>Error 404 GET "/..." 404 </source> @@ -706,9 +693,8 @@ Make sure the extension_uri data begins </li> </ul> -<source> - Error 500 - GET "/..." 500 +<source>Error 500 +GET "/..." 500 </source> <ul> @@ -720,10 +706,9 @@ Check the workers.properties file and ma </li> </ul> -<source> - Error 200 or 403 - GET "/..." 200 - GET "/..." 403 +<source>Error 200 or 403 +GET "/..." 200 +GET "/..." 403 </source> <ul> @@ -790,9 +775,8 @@ which indicates the ISAPI redirector is You should check the HTTP error code following GET "/...": </p> -<source> - Error 404 - GET "/..." 404 +<source>Error 404 +GET "/..." 404 </source> <ul> @@ -801,9 +785,8 @@ Make sure you entered the URL correctly. </li> </ul> -<source> - Error 500 - GET "/..." 500 +<source>Error 500 +GET "/..." 500 </source> <ul> @@ -818,10 +801,9 @@ Check the workers.properties file and ma </li> </ul> -<source> - Error 200 or 403 - GET "/..." 200 - GET "/..." 403 +<source>Error 200 or 403 +GET "/..." 200 +GET "/..." 403 </source> <ul> --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org For additional commands, e-mail: dev-h...@tomcat.apache.org
