Author: rjung
Date: Tue Sep 1 14:32:31 2015
New Revision: 1700577
URL: http://svn.apache.org/r1700577
Log:
Minor docs tweaks.
Modified:
tomcat/jk/trunk/xdocs/reference/apache.xml
tomcat/jk/trunk/xdocs/reference/iis.xml
tomcat/jk/trunk/xdocs/reference/status.xml
tomcat/jk/trunk/xdocs/reference/uriworkermap.xml
tomcat/jk/trunk/xdocs/reference/workers.xml
Modified: tomcat/jk/trunk/xdocs/reference/apache.xml
URL:
http://svn.apache.org/viewvc/tomcat/jk/trunk/xdocs/reference/apache.xml?rev=1700577&r1=1700576&r2=1700577&view=diff
==============================================================================
--- tomcat/jk/trunk/xdocs/reference/apache.xml (original)
+++ tomcat/jk/trunk/xdocs/reference/apache.xml Tue Sep 1 14:32:31 2015
@@ -24,14 +24,14 @@
<properties>
<author email="[email protected]">Mladen Turk</author>
- <title>Configuring Apache</title>
+ <title>Configuring mod_jk for the Apache HTTP Server</title>
</properties>
<body>
<section name="Configuration Directives">
<p>
-Most of the directives are allowed once in the global part of the Apache httpd
+Most of the directives are allowed once in the global part of the Apache HTTP
Server
configuration and once in every <VirtualHost> elements. Exceptions from
this rule are
explicitly listed in the table below.
</p>
@@ -42,15 +42,15 @@ Exceptions from this rule are again expl
See especially JkMountCopy.
</p>
<warn>
-Warning: If Apache httpd and Tomcat are configured to serve content from
-the same filing system location then care must be taken to ensure that httpd is
+Warning: 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.
</warn>
<p>
-This could occur if the httpd DocumentRoot
+This could occur if the Apache DocumentRoot
overlaps with a Tomcat Host's appBase or the docBase of any Context. It could
-also occur when using the httpd Alias directive with a Tomcat Host's appBase or
+also occur when using the Apache Alias directive with a Tomcat Host's appBase
or
the docBase of any Context.
</p>
<p>
@@ -71,7 +71,7 @@ value.
Enables setting worker properties inside Apache configuration file.
The syntax is the same as in the JkWorkersFile (usually workers.properties).
Simply prefix each line with "JkWorkerProperty" to put it directly into
-the Apache httpd config files.
+the Apache config files.
<br/>
This directive is allowed multiple times.
It must be put into the global part of the configuration.
@@ -95,7 +95,7 @@ drive and not an NFS share.
</p>
<p>
The shared memory contains configuration and runtime information for load
balancer
-workers and their members. It is need in order that all apache children
+workers and their members. It is need in order that all Apache children
<ul>
<li>share the same status information for load balancing members (OK, ERROR,
...),</li>
<li>share the information about load taken by the individual workers,</li>
@@ -181,8 +181,8 @@ This directive is available in jk1.2.7 v
Automatically Alias webapp context directories into the Apache
document space.
<br/>
-Care should be taken to ensure that only static content is served via httpd as
a
-result of using this directive. Any static content served by httpd will bypass
any
+Care should be taken to ensure that only static content is served via Apache
as a
+result of using this directive. Any static content served by Apache will
bypass any
security constraints defined in the application's web.xml.
<br/>
For inheritance rules, see: JkMountCopy.
@@ -238,7 +238,7 @@ This directive is only allowed once. It
the global part of the configuration.
<br/>
This directive has been added in version 1.2.27 of mod_jk.
-It is available only for httpd 2.x and above using APR libraries
+It is available only for Apache 2.x and above using APR libraries
including thread support.
</p></attribute>
<attribute name="JkLogFile" required="false"><p>
@@ -290,7 +290,7 @@ to add <code>SSLOptions +ExportCertData<
</p>
<p>
Specifically, mod_jk will export the following environment variables from
- Apache httpd to Tomcat under these request attributes as per the
+ Apache to Tomcat under these request attributes as per the
Servlet Specification 3.0, section 3.8:
</p>
<table>
@@ -554,7 +554,7 @@ be used for piped logging:
<p>
<b>JkLogLevel</b>
-set the log level between :
+set the log level between:
</p>
<ul>
@@ -601,7 +601,7 @@ See above for details.
<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 httpd notes table.
+The module sets several notes in the Apache notes table.
Most of them are are only useful in combination with a load balancer worker.
</p>
@@ -613,26 +613,26 @@ Most of them are are only useful in comb
Before version 1.2.26
only available if JkRequestLogFormat is set.</attribute>
<attribute name="JK_REQUEST_DURATION" required="false">Request duration in
seconds and microseconds.<br/>
Before version 1.2.26
only available if JkRequestLogFormat is set.</attribute>
- <attribute name="JK_LB_FIRST_NAME" required="false">Load-Balancer: Name of
the first worker tried</attribute>
- <attribute name="JK_LB_FIRST_TYPE" required="false">Load-Balancer: Type of
the first worker tried</attribute>
- <attribute name="JK_LB_FIRST_ACCESSED" required="false">Load-Balancer:
Access count for the first worker tried</attribute>
- <attribute name="JK_LB_FIRST_SESSIONS" required="false">Load-Balancer: Count
of created sessions for the first worker tried</attribute>
- <attribute name="JK_LB_FIRST_READ" required="false">Load-Balancer: Bytes
read for the first worker tried</attribute>
- <attribute name="JK_LB_FIRST_TRANSFERRED" required="false">Load-Balancer:
Bytes transferred for the first worker tried</attribute>
- <attribute name="JK_LB_FIRST_ERRORS" required="false">Load-Balancer: Error
count for the first worker tried</attribute>
- <attribute name="JK_LB_FIRST_BUSY" required="false">Load-Balancer: Busy
count for the first worker tried</attribute>
- <attribute name="JK_LB_FIRST_ACTIVATION" required="false">Load-Balancer:
Activation state for the first worker tried</attribute>
- <attribute name="JK_LB_FIRST_STATE" required="false">Load-Balancer: Error
state for the first worker tried</attribute>
- <attribute name="JK_LB_LAST_NAME" required="false">Load-Balancer: Name of
the last worker tried</attribute>
- <attribute name="JK_LB_LAST_TYPE" required="false">Load-Balancer: Type of
the last worker tried</attribute>
- <attribute name="JK_LB_LAST_ACCESSED" required="false">Load-Balancer: Access
count for the last worker tried</attribute>
- <attribute name="JK_LB_LAST_SESSIONS" required="false">Load-Balancer: Count
of created sessions for the last worker tried</attribute>
- <attribute name="JK_LB_LAST_READ" required="false">Load-Balancer: Bytes read
for the last worker tried</attribute>
- <attribute name="JK_LB_LAST_TRANSFERRED" required="false">Load-Balancer:
Bytes transferred for the last worker tried</attribute>
- <attribute name="JK_LB_LAST_ERRORS" required="false">Load-Balancer: Error
count for the last worker tried</attribute>
- <attribute name="JK_LB_LAST_BUSY" required="false">Load-Balancer: Busy count
for the last worker tried</attribute>
- <attribute name="JK_LB_LAST_ACTIVATION" required="false">Load-Balancer:
Activation state for the last worker tried</attribute>
- <attribute name="JK_LB_LAST_STATE" required="false">Load-Balancer: Error
state for the last worker tried</attribute>
+ <attribute name="JK_LB_FIRST_NAME" required="false">Load balancer: Name of
the first worker tried</attribute>
+ <attribute name="JK_LB_FIRST_TYPE" required="false">Load balancer: Type of
the first worker tried</attribute>
+ <attribute name="JK_LB_FIRST_ACCESSED" required="false">Load balancer:
Access count for the first worker tried</attribute>
+ <attribute name="JK_LB_FIRST_SESSIONS" required="false">Load balancer: Count
of created sessions for the first worker tried</attribute>
+ <attribute name="JK_LB_FIRST_READ" required="false">Load balancer: Bytes
read for the first worker tried</attribute>
+ <attribute name="JK_LB_FIRST_TRANSFERRED" required="false">Load balancer:
Bytes transferred for the first worker tried</attribute>
+ <attribute name="JK_LB_FIRST_ERRORS" required="false">Load balancer: Error
count for the first worker tried</attribute>
+ <attribute name="JK_LB_FIRST_BUSY" required="false">Load balancer: Busy
count for the first worker tried</attribute>
+ <attribute name="JK_LB_FIRST_ACTIVATION" required="false">Load balancer:
Activation state for the first worker tried</attribute>
+ <attribute name="JK_LB_FIRST_STATE" required="false">Load balancer: Error
state for the first worker tried</attribute>
+ <attribute name="JK_LB_LAST_NAME" required="false">Load balancer: Name of
the last worker tried</attribute>
+ <attribute name="JK_LB_LAST_TYPE" required="false">Load balancer: Type of
the last worker tried</attribute>
+ <attribute name="JK_LB_LAST_ACCESSED" required="false">Load balancer: Access
count for the last worker tried</attribute>
+ <attribute name="JK_LB_LAST_SESSIONS" required="false">Load balancer: Count
of created sessions for the last worker tried</attribute>
+ <attribute name="JK_LB_LAST_READ" required="false">Load balancer: Bytes read
for the last worker tried</attribute>
+ <attribute name="JK_LB_LAST_TRANSFERRED" required="false">Load balancer:
Bytes transferred for the last worker tried</attribute>
+ <attribute name="JK_LB_LAST_ERRORS" required="false">Load balancer: Error
count for the last worker tried</attribute>
+ <attribute name="JK_LB_LAST_BUSY" required="false">Load balancer: Busy count
for the last worker tried</attribute>
+ <attribute name="JK_LB_LAST_ACTIVATION" required="false">Load balancer:
Activation state for the last worker tried</attribute>
+ <attribute name="JK_LB_LAST_STATE" required="false">Load balancer: Error
state for the last worker tried</attribute>
</attributes>
<source>
@@ -717,7 +717,7 @@ options(vhost) = plus_options(global) -
<p>
Using JkOptions <b>ForwardURIProxy</b>, the forwarded URI
-will be partially reencoded after processing inside Apache httpd and
+will be partially reencoded after processing inside Apache and
before forwarding to Tomcat. This will be compatible with local
URL manipulation by mod_rewrite and with URL encoded session ids.
@@ -746,7 +746,7 @@ will not work.
<p>
Using JkOptions <b>ForwardURICompat</b>, the forwarded URI will
-be decoded by Apache httpd. Encoded characters will be decoded and
+be decoded by Apache. Encoded characters will be decoded and
explicit path components like ".." will already be resolved.
This is less spec compliant and is <b>not safe</b> if you are using
prefix JkMount. This option will allow to rewrite URIs with
@@ -835,7 +835,7 @@ bypassing your unmount rules.
<p>
JkOptions <b>ForwardDirectories</b> is used in conjunction with
<b>DirectoryIndex</b>
-directive of Apache web server. As such mod_dir should be available to Apache,
+directive of Apache. As such mod_dir should be available to Apache,
statically or dynamically (DSO)
<br/>
<br/>
@@ -876,9 +876,9 @@ file that Tomcat normally serves - for i
<p>
Setting JkOptions <b>ForwardLocalAddress</b>, you ask mod_jk to send the local
address,
-of the Apache web server instead remote client address. This can be used by
-Tomcat remote address valve for allowing connections only from registered
Apache
-web servers.
+of the Apache HTTP Server instead remote client address. This can be used by
the
+Tomcat remote address valve for allowing connections only from configured
Apache
+servers.
<source>
JkOptions +ForwardLocalAddress
@@ -950,7 +950,7 @@ TCP keepalive value in your OS.
</p>
<p>
-JkOptions <b>ForwardKeySize</b>, you ask mod_jk, when using ajp13, to forward
also the SSL Key Size as
+JkOptions <b>ForwardKeySize</b>, you ask mod_jk, when using ajp13, to forward
also the SSL Key Size as
required by Servlet API 2.3.
This flag shouldn't be set when servlet engine is Tomcat 3.2.x (on by default).
@@ -963,7 +963,7 @@ This flag shouldn't be set when servlet
</p>
<p>
-JkOptions <b>ForwardSSLCertChain</b>, you ask mod_jk, when using ajp13,
+JkOptions <b>ForwardSSLCertChain</b>, you ask mod_jk, when using ajp13,
to forward SSL certificate chain (off by default).
Mod_jk only passes the <code>SSL_CLIENT_CERT</code> to the AJP connector. This
is not a
problem with self-signed certificates or certificates directly signed by the
@@ -1077,34 +1077,33 @@ More complex patterns in JkUnMount worke
<b>JkAutoAlias</b> directive automatically <b>Alias</b> webapp context
directories into
the Apache document space. It enables Apache to serve a static context while
Tomcat
serving dynamic context. This directive is used for convenience so that you
don't
-have to put an apache Alias directive for each application directory inside
Tomcat's
+have to put an Apache Alias directive for each application directory inside
Tomcat's
webapp directory. For security reasons it is strongly recommended that JkMount
is used to pass all requests to Tomcat by default and JkUnMount is used to
-explicitly exclude static content to be served by httpd. It should also be
noted
-that content served by httpd will bypass any security constraints defined in
the
+explicitly exclude static content to be served by Apache. It should also be
noted
+that content served by Apache will bypass any security constraints defined in
the
application's web.xml.
</p>
<source>
# enter the full path to the tomcat webapps directory
- JkAutoAlias /opt/tomtact/webapps
+ 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>
+be accessible by Apache.</p>
<source>
# enter the full path to the tomcat webapps directory
- JkAutoAlias /opt/tomtact/webapps
+ JkAutoAlias /opt/tomcat/webapps
- # Mount 'servlets-examples' directory. It's physical location
- # is assumed to be in the /opt/tomtact/webapps/servlets-examples
+ # 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 /servlets-examples/* ajp13w
+ JkMount /examples/* ajp13w
- # Unmount desired static content from servlets-examples webapp.
- # This content will be served by the httpd directly.
- JkUnMount /servlets-examples/*.gif ajp13w
- JkUnMount /servlets-examples/*.jpg 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
@@ -1145,11 +1144,11 @@ An exclusion can be disabled by prefixin
<source>
# Sample uriworkermap.properties file
- /servlets-examples/*=ajp13w
- # Do not map .jpeg files
- !/servlets-examples/*.jpeg=ajp13w
+ /examples/*=ajp13w
+ # Do not map .gif files
+ !/*.gif=ajp13w
# Make jsp examples initially disabled
- -/jsp-examples/*=ajp13w
+ -/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.
Modified: tomcat/jk/trunk/xdocs/reference/iis.xml
URL:
http://svn.apache.org/viewvc/tomcat/jk/trunk/xdocs/reference/iis.xml?rev=1700577&r1=1700576&r2=1700577&view=diff
==============================================================================
--- tomcat/jk/trunk/xdocs/reference/iis.xml (original)
+++ tomcat/jk/trunk/xdocs/reference/iis.xml Tue Sep 1 14:32:31 2015
@@ -24,7 +24,7 @@
<properties>
<author email="[email protected]">Mladen Turk</author>
- <title>Configuring IIS</title>
+ <title>Configuring the ISAPI redirector for Microsoft IIS</title>
</properties>
<body>
@@ -35,7 +35,7 @@ The Tomcat redirector requires three ent
<ul>
<li>
-<b>isapi_redirect.dll</b> - The IIS server plugin, either obtain a pre-built
DLL or build it yourself (see the build section).
+<b>isapi_redirect.dll</b> - The IIS ISAPI redirector plugin, either obtain a
pre-built DLL or build it yourself (see the build section).
</li>
<li>
<b>workers.properties</b> - A file that describes the host(s) and port(s) used
by the workers (Tomcat processes).
@@ -70,7 +70,7 @@ because the library is not loadable into
</section>
<section name="Registry settings">
<p>
-ISAPI redirector reads configuration from the registry, create a new registry
key named :
+ISAPI redirector reads configuration from the registry, create a new registry
key named:
</p>
<p>
<b>"HKEY_LOCAL_MACHINE\SOFTWARE\Apache Software Foundation\Jakarta Isapi
Redirector\1.0"</b>
@@ -94,7 +94,7 @@ A value pointing to location where log f
<br/>If one of the log rotation settings (<b>log_rotationtime</b> or
<b>log_filesize</b>) are specified then the actual log file name is based on
this setting.
If the log file name includes any '%' characters, then it is treated as a
format string for <code>strftime(3)</code>,
e.g. <b>c:\tomcat\logs\isapi-%Y-%m-%d-%H_%M_%S.log</b>. Otherwise, the suffix
<em>.nnnnnnnnnn</em> is automatically added and is the time in seconds.
-A full list of format string substitutions can be found in the <a
href="http://httpd.apache.org/docs/2.0/programs/rotatelogs.html";>Apache
rotatelogs documentation</a>
+A full list of format string substitutions can be found in the <a
href="http://httpd.apache.org/docs/2.4/programs/rotatelogs.html";>Apache
rotatelogs documentation</a>
</p></attribute>
<attribute name="log_level" required="false"><p>
A string value for log level
@@ -336,7 +336,7 @@ log_file=$(JKISAPI_PATH)\$(JKISAPI_NAME)
<section name="Log file rotation">
<p>
The ISAPI redirector with version 1.2.31 can perform log rotation, with
configuration and behaviour similar to the
-<a
href="http://httpd.apache.org/docs/2.0/programs/rotatelogs.html";>rotatelogs</a>
program provided with Apache HTTP Server.
+<a
href="http://httpd.apache.org/docs/2.4/programs/rotatelogs.html";>rotatelogs</a>
program provided with Apache HTTP Server.
</p>
<p>
To configure log rotation, configure a <b>log_file</b>, and one of the
<b>log_rotationtime</b> or <b>log_filesize</b> options.
@@ -380,7 +380,7 @@ log_filesize=5M
The log will be rotated whenever the configured limit is reached, but only if
the log file name would change. If you configure
a log file name with <code>strftime(3)</code> format codes in it, then ensure
it specifies the same granularity
as the rotation time configured, e.g. <b>%Y-%m-%d</b> if rotating daily
(<b>log_rotationtime=86400</b>).
-<br/>See the <a
href="http://httpd.apache.org/docs/2.0/programs/rotatelogs.html";>rotatelogs</a>
documentation for more examples.
+<br/>See the <a
href="http://httpd.apache.org/docs/2.4/programs/rotatelogs.html";>rotatelogs</a>
documentation for more examples.
</p>
</section>
@@ -388,24 +388,24 @@ The log will be rotated whenever the con
<section name="Using a simple rewrite rules">
<p>
The ISAPI redirector with version 1.2.16 can do a simple URL rewriting.
Although not
-as powerful as Apache Httpd's mod_rewrite, it allows a simple exchange of
request URIs
+as powerful as Apache HTTP Server's mod_rewrite, it allows a simple exchange
of request URIs
</p>
<p>
The rule is in the form original-url-prefix=forward-url-prefix. For example:
</p>
<source>
-# Simple rewrite rules, making /jsp-examples
-# and /servlets-examples available under shorter URLs
-/jsp/=/jsp-examples/
-/servlets/=/servlets-examples/
+# Simple rewrite rules, making examples
+# available under shorter URLs
+/jsp/=/examples/jsp/
+/servlets/=/examples/servlets/
</source>
<p>
You can also use regular expressions, if you prefix the rule with a tilde
<code>~</code>:
</p>
<source>
-# Complex rewrite rule, adding "-examples"
+# Complex rewrite rule, prefixing "/examples/"
# to the first path component of all requests
-~/([^/]*)=/$1-examples
+~/([^/]*)=/examples/$1
</source>
<p>
Note that uriworkermap.properties must use the URLs before rewriting.
Modified: tomcat/jk/trunk/xdocs/reference/status.xml
URL:
http://svn.apache.org/viewvc/tomcat/jk/trunk/xdocs/reference/status.xml?rev=1700577&r1=1700576&r2=1700577&view=diff
==============================================================================
--- tomcat/jk/trunk/xdocs/reference/status.xml (original)
+++ tomcat/jk/trunk/xdocs/reference/status.xml Tue Sep 1 14:32:31 2015
@@ -175,7 +175,7 @@ The last three minimisation features hav
<b>Note: </b>The following restriction has been removed starting with version
1.2.26.
</p>
<p>
-The Apache module mod_jk makes use of the internal Apache httpd infrastructure
concerning
+The Apache module mod_jk makes use of the internal Apache HTTP Server
infrastructure concerning
virtual hosts. The downside of this is, that the status worker can only show
URL maps, for
the virtual host it is defined in. It is not able to reach the configuration
objects
for other virtual hosts. Of course you can define a status worker in any
virtual host you
@@ -211,8 +211,8 @@ worker.mystatus.type=status
Then we define a URL, which should be mapped to this worker, i.e. the URL we
use
to reach the functionality of the status worker. You can use any method mod_jk
supports
for the web server of your choice. Possibilities are maps inside
uriworkermap.properties,
-an additional mount attribute in workers.properties, or in Apache JkMount.
Here's an
-example for a uriworkermap.properties line:
+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>
Modified: tomcat/jk/trunk/xdocs/reference/uriworkermap.xml
URL:
http://svn.apache.org/viewvc/tomcat/jk/trunk/xdocs/reference/uriworkermap.xml?rev=1700577&r1=1700576&r2=1700577&view=diff
==============================================================================
--- tomcat/jk/trunk/xdocs/reference/uriworkermap.xml (original)
+++ tomcat/jk/trunk/xdocs/reference/uriworkermap.xml Tue Sep 1 14:32:31 2015
@@ -192,8 +192,8 @@ rules with equal numbers are sorted by t
</p>
<p>
If both distinctions still do not suffice, then the defining source of the
rule is considered.
-Rules defined in uriworkermap.properties come first, before rules defined by
JkMount (Apache)
-and inside workers.properties using the mount attribute.
+Rules defined in uriworkermap.properties come first, before rules defined by
JkMount
+(for the Apache HTTP Server) and inside workers.properties using the mount
attribute.
</p>
<p>
All disabled rules are ignored. Exclusion rules are applied after all normal
rules
@@ -360,10 +360,11 @@ per mount. See their descriptions in the
<section name="Virtual host integration">
<br/>
-<subsection name="IIS">
+<subsection name="ISAPI redirector for Microsoft IIS">
<br/>
<p>
-When using IIS you can restrict individual rules to special virtual hosts
+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>
@@ -388,10 +389,10 @@ the exclusion rule must be used
</p>
</subsection>
-<subsection name="Apache httpd">
+<subsection name="mod_jk for Apache HTTP Server">
<br/>
<p>
-For Apache you can define individual uriworkermap files per virtual host.
+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.
If a virtual host does not use JkMountfile, but JkMountCopy is set to 'On',
then it inherits the JkMountFile from the main server. If you want all vhost
to inherit
@@ -408,14 +409,14 @@ of the uriworkermap file. To keep the pe
if the last check happened at least n seconds ago.
</p>
<p>
-For Apache you can configure the interval "n" using the directive
JkMountFileReload,
-for IIS you would use the attribute worker_mount_reload.
+For the Apache HTTP Server you can configure the interval "n" using the
directive JkMountFileReload,
+for Microsoft IIS you would use the attribute worker_mount_reload.
The default value is 60 seconds. A value of "0" turns off the reloading.
</p>
<p>
If the file changed, it gets reloaded completely. If there exist rules coming
from other sources than the uriworkermap file (e.g. the workers.properties
mount
-attribute or JkMount with Apache httpd), the new uriworkermap file gets
dynamically
+attribute or JkMount for the Apache HTTP Server), the new uriworkermap file
gets dynamically
merged with these ones exactly like when you do a web server restart.
</p>
<p>
@@ -444,14 +445,14 @@ the type of the rule: Exact or Wildchar
</li>
<li>
and the source of the rule definition: 'worker definition' for the
workers.properties file (mount attribute),
-'JkMount' for Apache httpd JkMount and it's relatives and finally
'uriworkermap' for the uriworkermap file.
+'JkMount' for the Apache HTTP Server JkMount and it's relatives and finally
'uriworkermap' for the uriworkermap file.
</li>
</ul>
</p>
<p>
<b>Note: </b>The following restriction has been removed starting with version
1.2.26.
<br/>
-For Apache httpd, there is an important subtlety: the request going to the
status worker
+For the Apache HTTP Server, there is an important subtlety: the request going
to the status worker
gets executed in the context of some server (main or virtual). The status
worker will only show the
mapping rules, that are defined for this server (main or virtual).
<br/>
@@ -465,7 +466,7 @@ the URI pattern
</li>
<li>
and the source of the rule definition: 'worker definition' for the
workers.properties file (mount attribute),
-'JkMount' for Apache httpd JkMount and it's relatives and finally
'uriworkermap' for the uriworkermap file.
+'JkMount' for the Apache HTTP Server JkMount and it's relatives and finally
'uriworkermap' for the uriworkermap file.
</li>
</ul>
</p>
Modified: tomcat/jk/trunk/xdocs/reference/workers.xml
URL:
http://svn.apache.org/viewvc/tomcat/jk/trunk/xdocs/reference/workers.xml?rev=1700577&r1=1700576&r2=1700577&view=diff
==============================================================================
--- tomcat/jk/trunk/xdocs/reference/workers.xml (original)
+++ tomcat/jk/trunk/xdocs/reference/workers.xml Tue Sep 1 14:32:31 2015
@@ -34,7 +34,7 @@
<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
-Apache forwarding servlet requests to a Tomcat process (the worker) running
behind it.
+the Apache HTTP Server forwarding servlet requests to a Tomcat process (the
worker) running behind it.
</p>
<p>
The scenario described above is a very simple one;
@@ -144,7 +144,7 @@ Each worker configuration directive cons
<p><strong>worker.<worker
name>.<directive>=<value></strong></p>
<p>
The first word is always <b>worker</b>.
-The second word is the worker name you can choose. In the case of
load-balancing,
+The second word is the worker name you can choose. In the case of load
balancing,
the worker name has an additional meaning. Please consult the
<a href="../common_howto/loadbalancers.html">Load Balancer HowTo</a>.
</p>
@@ -220,16 +220,19 @@ be unavailable or will misbehave. Those
</p>
<directives>
<directive name="type" default="ajp13" required="true">
-Type of the worker (can be one of ajp13, ajp14, jni, lb or status). The type
of the worker
+Type of the worker (can be one of ajp12, ajp13, ajp14, jni, lb or status). The
type of the worker
defines the directives that can be applied to the worker.
<p>Type <b>ajp13</b> is the preferred worker type that JK uses for
communication
between web server and Tomcat. This type of worker uses sockets as
communication
-channel. For detailed description of the AJP13 protocol stack browse to
-<a href="../ajp/ajpv13a.html">AJPv13 protocol specification</a>
+channel. For detailed description of the ajp13 protocol stack browse to
+<a href="../ajp/ajpv13a.html">AJPv13 protocol specification</a>. Type
<b>lb</b> is
+used for <a href="../common_howto/loadbalancers.html">load balancing
workers</a>,
+type <b>status</b> for <a href="../reference/status.html">status workers</a>.
</p>
-<p>Type <b>ajp14</b> is experimental and not recommended.
+<p>Type <b>ajp14</b> is experimental and not recommended, type <b>ajp12</b>
+is obsolete.
</p>
-<warn>JNI workers have been deprecated. They will likely not work. Do not use
them.</warn>
+<warn>JNI workers are no longer supported and will likely not work. Do not use
them.</warn>
</directive>
</directives>
</subsection>
@@ -284,13 +287,13 @@ This feature has been added in <b>jk 1.2
</directive>
<directive name="socket_keepalive" default="false" required="false">
-This directive should be used when you have a firewall between your webserver
+This directive should be used when you have a firewall between your web server
and the Tomcat engine, who tend to drop inactive connections. This flag will
tell the Operating System
to send <code>KEEP_ALIVE</code> messages on inactive connections (interval
depend on global OS settings,
generally 120 minutes), and thus prevent the firewall to cut inactive
connections.
To enable keepalive set this property value to <b>true</b>.
<p>
-The problem with Firewall cutting inactive connections is that sometimes,
neither webserver or Tomcat
+The problem with Firewall cutting inactive connections is that sometimes,
neither web server or Tomcat
have information about the cut and couldn't handle it.
</p>
</directive>
@@ -375,15 +378,16 @@ It will limit the number of those connec
process can made.
<p>
Connection pool size property is only used for multi threaded
-web servers such as Apache, IIS and Netscape/Sun. The connection_pool_size
property
+web servers such as the Apache HTTP Server, Microsoft IIS and the iPlanet Web
Server.
+The connection_pool_size property
needs to reflect the number of requests one web server process should
be able to send to a backend in parallel. Usually this is the same as
the number of threads per web server process. JK will discover
-this number for the Apache web server automatically and set the pool size to
+this number for the Apache HTTP Server automatically and set the pool size to
this value. For IIS the default value is 250 (before version 1.2.20: 10),
-for Netscape/Sun the default value is 1.
+for iPlanet the default value is 1.
</p>
-<p>We strongly recommend adjusting this value for IIS and the Netscape/Sun
+<p>We strongly recommend adjusting this value for IIS and iPlanet
to the number of requests one web server process should
be able to send to a backend in parallel. You should measure how many
connections
you need during peak activity without performance problems, and then add some
@@ -391,7 +395,7 @@ percentage depending on your growth rate
whether your web server processes are able to use at least as many threads,
as you configured as the pool size.
</p>
-<warn>Do not use connection_pool_size with values higher then 1 on <b>Apache
2.x prefork</b> or <b>Apache 1.3.x</b>!</warn>
+<warn>Do not use connection_pool_size with values higher then 1 on <b>Apache
2.x with prefork MPM</b> or <b>Apache 1.3.x</b>!</warn>
</directive>
<directive name="connection_pool_minsize" default="(pool+1)/2"
required="false">
@@ -399,7 +403,7 @@ Minimum size of the connection pool that
<p>
Its default value is (connection_pool_size+1)/2.
</p>
-<warn>Do not use connection_pool_size with values higher then 1 on <b>Apache
2.x prefork</b> or <b>Apache 1.3.x</b>!</warn>
+<warn>Do not use connection_pool_minsize with values higher then 1 on
<b>Apache 2.x with prefork MPM</b> or <b>Apache 1.3.x</b>!</warn>
<p>
This feature has been added in <b>jk 1.2.16</b>.
</p>
@@ -415,7 +419,7 @@ a new ajp13 thread on Tomcat side.
</p>
<p>
The problem is that after an ajp13 connection is created, the child won't drop
it
-until killed. And since the webserver will keep its childs/threads running
+until killed. And since the web server will keep its childs/threads running
to handle high-load, even it the child/thread handle only static contents, you
could
finish having many unused ajp13 threads on the Tomcat side.
</p>
@@ -440,7 +444,7 @@ This feature has been added in <b>jk 1.2
<directive name="lbfactor" default="1" required="false">
Only used for a member worker of a load balancer.
<p>
-The integer number lbfactor (load-balancing factor) is
+The integer number lbfactor (load balancing factor) is
<i>how much we expect this worker to work</i>, or
<i>the worker's work quota</i>. Load balancing factor is compared with other
workers
that makes the load balancer. For example if one worker has lb_factor 5 times
higher then
@@ -472,21 +476,21 @@ Load balancer management includes:
Instantiating the workers in the web server.
</li>
<li>
-Using the worker's load-balancing factor, perform weighed-round-robin load
balancing where
+Using the worker's load balancing factor, perform weighted round-robin load
balancing where
high lbfactor means stronger machine (that is going to handle more requests)
</li>
<li>
Keeping requests belonging to the same session executing on the same Tomcat
worker.
</li>
<li>
-Identifying failed Tomcat workers, suspending requests to them and instead
fall-backing on
+Identifying failed Tomcat workers, suspending requests to them and instead
fail over on
other workers managed by the lb worker.
</li>
</ul>
<p>
-The overall result is that workers managed by the same lb worker are
load-balanced
-(based on their lbfactor and current user session) and also fall-backed so a
single
+The overall result is that workers managed by the same lb worker are load
balanced
+(based on their lbfactor and current user session) and also fail over so a
single
Tomcat process death will not "kill" the entire site.
</p>
<warn>
@@ -524,7 +528,7 @@ sticky_session is set to <b>false</b>. S
is using a Session Manager which can persist session data across multiple
instances of Tomcat.
<p>
-The <b>sticky_session</b> setting can be overwritten using the Apache httpd
+The <b>sticky_session</b> setting can be overwritten using the Apache HTTP
Server
environment variable <b>JK_STICKY_IGNORE</b> and the worker map extension for
<b>sticky_ignore</b>. This has been added in version <b>1.2.33</b>.
</p>
@@ -572,7 +576,7 @@ without a session cookie or URL encoding
know, when a session is being invalidated, nor will it correct its load numbers
according to session timeouts or worker failover. If you know request URLs,
that will be
called without a session ID but should not be counted as new sessions, you
should
-add them to the <b>stateless</b> mapping rule extension or set the Apache HTTPD
+add them to the <b>stateless</b> mapping rule extension or set the Apache HTTP
Server
environment variable <b>JK_STATELESS</b> for them.
</p>
<p>
@@ -771,7 +775,7 @@ as a sub worker or member.
</p>
<advanceddirectives>
<directive name="connect_timeout" workers="AJP,SUB" default="0"
required="false">
-Connect timeout property told webserver to send a PING request on ajp13
connection after
+Connect timeout property told web server to send a PING request on ajp13
connection after
connection is established. The parameter is the delay in milliseconds to wait
for the PONG reply.
The default value zero disables the timeout (infinite timeout).
<p>
@@ -782,7 +786,7 @@ Disabled by default.
</directive>
<directive name="prepost_timeout" workers="AJP,SUB" default="0"
required="false">
-Prepost timeout property told webserver to send a PING request on ajp13
connection before
+Prepost timeout property told web server to send a PING request on ajp13
connection before
forwarding to it a request. The parameter is the delay in milliseconds to wait
for the PONG reply.
The default value zero disables the timeout (infinite timeout).
<p>
@@ -798,7 +802,7 @@ So this is not a timeout for the complet
for the maximum time between two packets received from Tomcat. Usually the
longest
pause is between sending the request and getting the first packet of the
response.
<p>
-If the timeout passes without any data received from Tomcat, the webserver will
+If the timeout passes without any data received from Tomcat, the web server
will
no longer wait for the rest of the response and send an error to the client
(browser).
Usually this does not mean, that the request is also aborted on the Tomcat
backend.
If the worker is a member of a load balancer, the load balancer might place the
@@ -806,11 +810,11 @@ worker into an error state and retry the
See also <b>max_reply_timeouts</b>, <b>retries</b> and <b>recovery_options</b>.
</p>
<p>
-By default (value zero) the webserver will wait forever which could be an
issue for you.
+By default (value zero) the web server will wait forever which could be an
issue for you.
If you set a reply_timeout, adjust it carefully if you have long running
servlets.
</p>
<p>
-The <b>reply_timeout</b> can be overwritten using the Apache httpd environment
variable
+The <b>reply_timeout</b> can be overwritten using the Apache HTTP Server
environment variable
<b>JK_REPLY_TIMEOUT</b> and the worker map extension for <b>reply_timeout</b>.
</p>
<p>
@@ -1163,13 +1167,13 @@ It will limit the number of those connec
process can make.
<p>
Cachesize property is used only for multi threaded
-web servers such as Apache 2.0 (worker), IIS and Netscape. The cachesize
property
+web servers such as Apache HTTP Server 2.x (all MPMs except prefork), IIS and
iPlanet. The cachesize property
should reflect the number of threads per child process. JK will discover
-the number of threads per child process on Apache 2 web server with worker-mpm
and set
-its default value to match the ThreadsPerChild Apache directive. For IIS the
default
-value is 10. For other web servers than Apache or IIS this value has to be set
manually.
+the number of threads per child process on the Apache HTTP Server with
threaded MPM and set
+its default value to match the current ThreadsPerChild Apache configuration.
For IIS the default
+value is 10. For web servers other than Apache or IIS this value has to be set
manually.
</p>
-<warn>Do not use cachesize with values higher then 1 on <b>Apache 2.x
prefork</b> or <b>Apache 1.3.x</b>!</warn>
+<warn>Do not use cachesize with values higher then 1 on <b>Apache 2.x with
prefork MPM</b> or <b>Apache 1.3.x</b>!</warn>
</directive>
<directive name="cache_timeout" successor="connection_pool_timeout"
default="0" required="false">
@@ -1183,7 +1187,7 @@ a new ajp13 thread on Tomcat side.
</p>
<p>
The problem is that after an ajp13 connection is created, the child won't drop
it
-until killed. And since the webserver will keep its childs/threads running
+until killed. And since the web server will keep its childs/threads running
to handle high-load, even it the child/thread handle only static contents, you
could
finish having many unused ajp13 threads on the Tomcat side.
</p>
@@ -1191,7 +1195,7 @@ finish having many unused ajp13 threads
<directive name="recycle_timeout" successor="connection_pool_timeout"
default="0" required="false">
<warn>This directive has been deprecated since 1.2.16.</warn>
-The number of seconds that told webserver to cut an ajp13 connection after
some time of
+The number of seconds that told web server to cut an ajp13 connection after
some time of
inactivity. When choosing an endpoint for a request and the assigned socket is
open, it will be
closed if it was not used for the configured time.
It's a good way to ensure that there won't too old threads living on Tomcat
side,
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
