Author: rjung
Date: Mon Dec 22 18:05:17 2014
New Revision: 1647362
URL: http://svn.apache.org/r1647362
Log:
Dcos update:
- explain syntax for boolean properties
in worker docs and iis docs
- standardize on true and false in docs
because lower-case is what most configs actually use
- use bold markup instead of quotation marks
because it is the majority markup
- wrap some very long lines
- Fix some grammar in changelog
- Clarify meaning of "strip_session" (IIS)
resp. "JkStripSession" (Apache)
- Replace one occurence of "dynamically" by "automatically"
- Fix one typo "ForwarDirectories" to "ForwardDirectories"
Modified:
tomcat/jk/trunk/xdocs/generic_howto/loadbalancers.xml
tomcat/jk/trunk/xdocs/generic_howto/timeouts.xml
tomcat/jk/trunk/xdocs/generic_howto/workers.xml
tomcat/jk/trunk/xdocs/miscellaneous/changelog.xml
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/workers.xml
tomcat/jk/trunk/xdocs/webserver_howto/apache.xml
Modified: tomcat/jk/trunk/xdocs/generic_howto/loadbalancers.xml
URL:
http://svn.apache.org/viewvc/tomcat/jk/trunk/xdocs/generic_howto/loadbalancers.xml?rev=1647362&r1=1647361&r2=1647362&view=diff
==============================================================================
--- tomcat/jk/trunk/xdocs/generic_howto/loadbalancers.xml (original)
+++ tomcat/jk/trunk/xdocs/generic_howto/loadbalancers.xml Mon Dec 22 18:05:17
2014
@@ -83,9 +83,9 @@ not need to appear in the <code>worker.l
load balancer to it suffices.</li>
<li><b>sticky_session</b> specifies whether requests with SESSION ID's should
be routed
back to the same Tomcat instance that created the session. You can set
sticky_session to
-<b>False</b> when Tomcat is using a session manager which can share session
data across
+<b>false</b> when Tomcat is using a session manager which can share session
data across
multiple instances of Tomcat - or if your application is stateless.
-By default sticky_session is set to <b>True</b>.</li>
+By default sticky_session is set to <b>true</b>.</li>
<li><b>lbfactor</b> can be added to each member worker to configure individual
strengths for the members. A higher <code>lbfactor</code> will lead to more
requests being balanced to that worker. The factors must be given by integers
and the
Modified: tomcat/jk/trunk/xdocs/generic_howto/timeouts.xml
URL:
http://svn.apache.org/viewvc/tomcat/jk/trunk/xdocs/generic_howto/timeouts.xml?rev=1647362&r1=1647361&r2=1647362&view=diff
==============================================================================
--- tomcat/jk/trunk/xdocs/generic_howto/timeouts.xml (original)
+++ tomcat/jk/trunk/xdocs/generic_howto/timeouts.xml Mon Dec 22 18:05:17 2014
@@ -259,9 +259,9 @@ on the Tomcat side to prevent idle conne
<p>
Furthermore using the boolean attribute <b>socket_keepalive</b> you can
set a standard socket option, that automatically sends TCP keepalive packets
-after some idle time on each connection. By default this is set to "False".
+after some idle time on each connection. By default this is set to
<b>false</b>.
If you suspect idle connection drops by firewalls you should set this to
-"True".
+<b>true</b>.
</p>
<p>
Unfortunately the default intervals and algorithms for these packets
Modified: tomcat/jk/trunk/xdocs/generic_howto/workers.xml
URL:
http://svn.apache.org/viewvc/tomcat/jk/trunk/xdocs/generic_howto/workers.xml?rev=1647362&r1=1647361&r2=1647362&view=diff
==============================================================================
--- tomcat/jk/trunk/xdocs/generic_howto/workers.xml (original)
+++ tomcat/jk/trunk/xdocs/generic_howto/workers.xml Mon Dec 22 18:05:17 2014
@@ -253,7 +253,9 @@ other workers managed by the lb worker.
</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 Tomcat process death will not "kill" the entire site.
+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
+Tomcat process death will not "kill" the entire site.
The following table specifies some properties that the lb worker can accept:
<ul>
<li><b>balance_workers</b> is a comma separated list of workers that the load
balancer need to manage.
@@ -261,8 +263,9 @@ As long as these workers should only be
there is no need to also put them into the worker.list property.
This directive can be used multiple times for the same load balancer.</li>
<li><b>sticky_session</b> specifies whether requests with SESSION ID's should
be routed back to the same
-Tomcat worker. Set sticky_session to False when Tomcat is using a Session
Manager which
-can persist session data across multiple instances of Tomcat. By default
sticky_session is set to True.</li>
+Tomcat worker. Set sticky_session to <b>false</b> when Tomcat is using a
Session Manager which
+can persist session data across multiple instances of Tomcat. By default
sticky_session is set to
+<b>true</b>.</li>
</ul>
</p>
Modified: tomcat/jk/trunk/xdocs/miscellaneous/changelog.xml
URL:
http://svn.apache.org/viewvc/tomcat/jk/trunk/xdocs/miscellaneous/changelog.xml?rev=1647362&r1=1647361&r2=1647362&view=diff
==============================================================================
--- tomcat/jk/trunk/xdocs/miscellaneous/changelog.xml (original)
+++ tomcat/jk/trunk/xdocs/miscellaneous/changelog.xml Mon Dec 22 18:05:17 2014
@@ -2200,7 +2200,8 @@
Added ForwardLocalAddress JkOptions flag for passing local instead remote
address. Useful for remote addr valve. (mturk)
</update>
- <fix>Fix that worker not used, when stopped flag is true. (pero)
+ <fix>Fix that worker does not get used, when stopped flag is set to
+ <b>true</b>. (pero)
</fix>
<update>
Add loadbalance default worker secret attribute to the documentation
(pero)
@@ -2222,8 +2223,8 @@
Add worker secret attribute to the documentation (pero)
</update>
<update>
- Add a stopped flag to worker configuration. Set flag True and
- complete traffic to worker is stopped.
+ Add a stopped flag to worker configuration. Set flag to <b>true</b> and
+ the complete traffic to the worker will be stopped.
Also update the Ant JkStatusUpdateTask at Tomcat 5.5.10 release.
Only usefull in a replicated session cluster.(pero)
</update>
Modified: tomcat/jk/trunk/xdocs/reference/apache.xml
URL:
http://svn.apache.org/viewvc/tomcat/jk/trunk/xdocs/reference/apache.xml?rev=1647362&r1=1647361&r2=1647362&view=diff
==============================================================================
--- tomcat/jk/trunk/xdocs/reference/apache.xml (original)
+++ tomcat/jk/trunk/xdocs/reference/apache.xml Mon Dec 22 18:05:17 2014
@@ -472,7 +472,8 @@ has been introduced in version 1.2.21.
<attribute name="JkStripSession" required="false"><p>
If this directive is set to On in some virtual server,
the session IDs <code>;jsessionid=...</code> will be
-removed for non matched URLs.
+removed for URLs which are not forwarded but instead are
+handled by the local server.
<br/>
This directive is only allowed inside VirtualHost.
<br/>
@@ -821,14 +822,14 @@ local file that matches (this is done by
</p>
<p>
-If ForwardDirectories is set to false (default) and Apache doesn't find any
+If ForwardDirectories is set to <b>false</b> (default) and Apache doesn't find
any
files that match, Apache will serve the content of the directory (if directive
Options specifies Indexes for that directory) or a <code>403 Forbidden</code>
response (if
directive Options doesn't specify Indexes for that directory).
</p>
<p>
-If ForwardDirectories is set to true and Apache doesn't find any files that
+If ForwardDirectories is set to <b>true</b> and Apache doesn't find any files
that
match, the request will be forwarded to Tomcat for resolution. This is used in
cases when Apache cannot see the index files on the file system for various
reasons: Tomcat is running on a different machine, the JSP file has been
Modified: tomcat/jk/trunk/xdocs/reference/iis.xml
URL:
http://svn.apache.org/viewvc/tomcat/jk/trunk/xdocs/reference/iis.xml?rev=1647362&r1=1647361&r2=1647362&view=diff
==============================================================================
--- tomcat/jk/trunk/xdocs/reference/iis.xml (original)
+++ tomcat/jk/trunk/xdocs/reference/iis.xml Mon Dec 22 18:05:17 2014
@@ -75,6 +75,15 @@ ISAPI redirector reads configuration fro
<p>
<b>"HKEY_LOCAL_MACHINE\SOFTWARE\Apache Software Foundation\Jakarta Isapi
Redirector\1.0"</b>
</p>
+<p>
+Attributes described below as a "string value representing a boolean"
+can be set either using the numbers <b>0</b> (false) and <b>1</b> (true)
+as values, or <b>off</b> (false) and <b>on</b> (true) or any other string
+starting with the letters <b>f</b> (false), <b>n</b> (false),
+<b>t</b> (true) or <b>y</b> (true).
+The values are taken case insensitive. In this documentation we will stick
+to <b>false</b> and <b>true</b>.
+</p>
<attributes name="Key Name">
<attribute name="extension_uri" required="true"><p>
A string value pointing to the ISAPI extension
<b>/jakarta/isapi_redirect.dll</b>
@@ -131,14 +140,12 @@ A DWORD value specifying the time in sec
<p>This directive has been added in version 1.2.20</p>
</attribute>
<attribute name="strip_session" required="false"><p>
-A string value representing a boolean. If it is set to true,
-URL session suffixes of the form ";jsessionid=..." get stripped of URLs,
-even if the are served locally by the web server.
+A string value representing a boolean. If it is set to <b>true</b>,
+URL session suffixes of the form ";jsessionid=..." get stripped of
+URLs, if the are served locally by the web server.
</p>
<p>
-A true value can be represented by the string "1" or any string starting
-with the letters "T" or "t". A false value will be assumed for "0"
-or any string starting with "F" or "f". The default value is false.
+The default value is false.
</p>
<p>This directive has been added in version 1.2.21</p>
</attribute>
@@ -186,18 +193,16 @@ and problematic are re-encoded.
<p>The default value since version 1.2.24 is "proxy". Before it was
"parsed".</p>
</attribute>
<attribute name="reject_unsafe" required="false"><p>
-A string value representing a boolean. If it is set to true,
-URLs containing percent signs '%' or backslashes '\'
+A string value representing a boolean. If it is set to <b>true</b>,
+URLs still containing percent signs '%' or backslashes '\'
after decoding will be rejected.
</p>
<p>
-Most web apps do not use such URLs. By enabling "reject_unsafe" you
+Most web apps do not use such URLs. By enabling <b>reject_unsafe</b> you
can block several well known URL encoding attacks.
</p>
<p>
-A true value can be represented by the string "1" or any string starting
-with the letters "T" or "t". A false value will be assumed for "0"
-or any string starting with "F" or "f". The default value is false.
+The default value is false.
</p>
<p>This directive has been added in version 1.2.24</p>
</attribute>
@@ -253,13 +258,11 @@ case is formatted by replacing <code>%d<
<p>This directive has been added in version 1.2.27</p>
</attribute>
<attribute name="enable_chunked_encoding" required="false"><p>
-A string value representing a boolean. If it is set to true,
+A string value representing a boolean. If it is set to <b>true</b>,
chunked encoding is supported by the server.
</p>
<p>
-A true value can be represented by the string "1" or any string starting
-with the letters "T" or "t". A false value will be assumed for "0"
-or any string starting with "F" or "f". The default value is false.
+The default value is false.
</p>
<p>This directive has been added in version 1.2.27. Until version 1.2.30 it
was considered experimental and only available when a special build containing
@@ -275,7 +278,9 @@ This has the advantage that you can use
The redirector will check for the properties file during initialisation, and
use it in preference to the registry if present.
</p>
<p>
-Create a properties file in the same directory as the ISAPI redirector called
<b>isapi_redirect.properties</b> i.e. with the same name as the ISAPI
redirector DLL but with a <em>.properties</em> extension. A sample
isapi_redirect.properties can be found under the conf directory.
+Create a properties file in the same directory as the ISAPI redirector called
<b>isapi_redirect.properties</b> i.e.
+with the same name as the ISAPI redirector DLL but with a <em>.properties</em>
extension.
+A sample isapi_redirect.properties can be found under the conf directory.
</p>
<p>
The property names and values in the properties file are the same as for the
registry settings described above. For example:
@@ -313,7 +318,7 @@ worker_mount_file=c:\tomcat\conf\uriwork
</ul>
</p>
<p>Starting with version 1.2.27 two environment variables are
-dynamically added to the environment that can be used inside
+automatically added to the environment that can be used inside
<code>.properties</code> files.
<ul>
<li>JKISAPI_PATH - Full path to the ISAPI Redirector.
Modified: tomcat/jk/trunk/xdocs/reference/status.xml
URL:
http://svn.apache.org/viewvc/tomcat/jk/trunk/xdocs/reference/status.xml?rev=1647362&r1=1647361&r2=1647362&view=diff
==============================================================================
--- tomcat/jk/trunk/xdocs/reference/status.xml (original)
+++ tomcat/jk/trunk/xdocs/reference/status.xml Mon Dec 22 18:05:17 2014
@@ -276,7 +276,7 @@ access to the status worker URLs you hav
attributes of status workers are helpful. The attribute "read_only" disables
all features of
the status worker, that can be used to change configurations or runtime status
of the other workers.
A read_only status worker will not allow access to the edit, update, reset or
recover actions.
-The default value is "False", ie. read/write. To enable read_only you need to
set it to "True".
+The default value is <b>false</b>, ie. read/write. To enable read_only you
need to set it to <b>true</b>.
</p>
<p>
You could configure two status workers, one has read_only and will be made
available to a larger
@@ -284,7 +284,7 @@ admin group, the other one will be used
<source>
worker.list=jk-watch
worker.jk-watch.type=status
-worker.jk-watch.read_only=True
+worker.jk-watch.read_only=true
worker.jk-watch.mount=/user/status/jk
worker.list=jk-manage
worker.jk-manage.type=status
@@ -306,7 +306,7 @@ The user list can be split over multiple
</p>
<p>
By default, the user names are matched case sensitively. Starting with version
1.2.21 you can set
-the attribute <b>user_case_insensitive</b> to "True". Then the comparison will
be made case insensitive.
+the attribute <b>user_case_insensitive</b> to <b>true</b>. Then the comparison
will be made case insensitive.
</p>
</subsection>
Modified: tomcat/jk/trunk/xdocs/reference/workers.xml
URL:
http://svn.apache.org/viewvc/tomcat/jk/trunk/xdocs/reference/workers.xml?rev=1647362&r1=1647361&r2=1647362&view=diff
==============================================================================
--- tomcat/jk/trunk/xdocs/reference/workers.xml (original)
+++ tomcat/jk/trunk/xdocs/reference/workers.xml Mon Dec 22 18:05:17 2014
@@ -97,6 +97,13 @@ Whitespace at the beginning and the end
Comments can be placed in any line and start with a hash sign '#'.
Any line contents behind the hash sign get ignored.
</p>
+<p>
+Boolean properties can be set either using the numbers <b>0</b> (false) and
<b>1</b> (true)
+as values, or <b>off</b> (false) and <b>on</b> (true) or any other string
starting with the
+letters <b>f</b> (false), <b>n</b> (false), <b>t</b> (true) or <b>y</b> (true).
+The values are taken case insensitive. In this documentation we will stick
+to <b>false</b> and <b>true</b>.
+</p>
</subsection>
<subsection name="Global Properties">
@@ -264,12 +271,12 @@ This feature has been added in <b>jk 1.2
</p>
</directive>
-<directive name="socket_keepalive" default="False" required="false">
+<directive name="socket_keepalive" default="false" required="false">
This directive should be used when you have a firewall between your webserver
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>.
+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
have information about the cut and couldn't handle it.
@@ -497,10 +504,10 @@ can be used only with mod_jk versions 1.
there is no need to also put them into the <b>worker.list</b> property.</warn>
</directive>
-<directive name="sticky_session" default="True" required="false">
+<directive name="sticky_session" default="true" required="false">
Specifies whether requests with SESSION ID's should be routed back to the same
-Tomcat worker. If sticky_session is set to <b>True</b> or <b>1</b> sessions
are sticky, otherwise
-sticky_session is set to <b>False</b>. Set sticky_session to <b>False</b> when
Tomcat
+Tomcat worker. If sticky_session is set to <b>true</b> sessions are sticky,
otherwise
+sticky_session is set to <b>false</b>. Set sticky_session to <b>false</b> when
Tomcat
is using a Session Manager which can persist session data across multiple
instances of Tomcat.
<p>
@@ -510,13 +517,13 @@ environment variable <b>JK_STICKY_IGNORE
</p>
</directive>
-<directive name="sticky_session_force" default="False" required="false">
+<directive name="sticky_session_force" default="false" required="false">
Specifies whether requests with SESSION ID's for workers that are in error
state
-should be rejected. If sticky_session_force is set to <b>True</b> or <b>1</b>
+should be rejected. If sticky_session_force is set to <b>true</b>
and the worker that matches that SESSION ID is in error state, client will
-receive 500 (Server Error). If set to <b>False</b> or <b>0</b> failover on
+receive 500 (Server Error). If set to <b>false</b> failover on
another worker will be issued with loosing client session. This directive is
-used only when you set <b>sticky_session=True</b>.
+used only when you set <b>sticky_session=true</b>.
<p>
This feature has been added in <b>jk 1.2.9</b>.
</p>
@@ -624,8 +631,8 @@ Instead it is responsible for the load b
<directive name="css" default="" required="false">
Specifies the url for cascading stylesheet to use.
</directive>
-<directive name="read_only" default="False" required="false">
-A status worker with read_only=True will not allow any operations,
+<directive name="read_only" default="false" required="false">
+A status worker with read_only=true will not allow any operations,
that change the runtime state or configuration of the other workers.
These are edit/update/reset/recover.
<p>
@@ -644,9 +651,9 @@ This directive can be used multiple time
This feature has been added in <b>jk 1.2.20</b>.
</p>
</directive>
-<directive name="user_case_insensitive" default="False" required="false">
+<directive name="user_case_insensitive" default="false" required="false">
By default, the user names are matched case sensitively. You can set
-user_case_insensitive=True to make the comparison case insensitive.
+user_case_insensitive=true to make the comparison case insensitive.
This may be especially useful on the Windows platform.
<p>
This feature has been added in <b>jk 1.2.21</b>.
@@ -1067,7 +1074,7 @@ This feature has been added in <b>jk 1.2
</p>
</directive>
-<directive name="set_session_cookie" workers="LB" default="False"
required="false">
+<directive name="set_session_cookie" workers="LB" default="false"
required="false">
Activates generation of session stickyness cookies. Typically you don't need
this.
<p>
Some web frameworks replace Tomcat session management and use a different way
@@ -1076,7 +1083,7 @@ end of the session ID is lost and we no
As a workaround you can use the following steps:
<ul>
<li>Choose a non-standard cookie name using the "session_cookie"
attribute.</li>
-<li>Activate cookie sending by setting the attribute "set_session_cookie" to
"True".</li>
+<li>Activate cookie sending by setting the attribute "set_session_cookie" to
<b>true</b>.</li>
<li>Set the attribute "session_cookie_path" to the correct application URI,
like
e.g. "/myapp/".</li>
</ul>
@@ -1093,7 +1100,7 @@ This feature has been added in <b>jk 1.2
</directive>
<directive name="session_cookie_path" workers="LB" default="" required="false">
-This attribute is only used if "set_session_cookie" is set to "True".
+This attribute is only used if "set_session_cookie" is set to <b>true</b>.
See "set_session_cookie" for a description. If the value of
"session_cookie_path"
is empty (default), then the send cookie will not contain a PATH information.
<p>
@@ -1101,7 +1108,7 @@ This feature has been added in <b>jk 1.2
</p>
</directive>
-<directive name="prefer_ipv6" workers="AJP" default="0" required="false">
+<directive name="prefer_ipv6" workers="AJP" default="false" required="false">
When compiled with IPV6 support, this directive forces IPV6 address
resolution for host names which have both IPV6 and IPV4 addresses. In case
there is
no IPV6 address defined for the given hostname this directive in ineffective.
This directive will
@@ -1173,18 +1180,18 @@ A comma separated list of workers that t
need to manage.
</directive>
-<directive name="disabled" successor="activation" default="False"
required="false">
+<directive name="disabled" successor="activation" default="false"
required="false">
<warn>This directive has been deprecated since 1.2.19.</warn>
-If set to <b>True</b> or <b>1</b> the worker will be disabled if member
+If set to <b>true</b> the worker will be disabled if member
of load balancer. This flag can be changed at runtime using status worker.
<p>
This feature has been added in <b>jk 1.2.9</b>.
</p>
</directive>
-<directive name="stopped" successor="activation" default="False"
required="false">
+<directive name="stopped" successor="activation" default="false"
required="false">
<warn>This directive has been deprecated since 1.2.19.</warn>
-If set to <b>True</b> or <b>1</b> the worker will be stopped if member
+If set to <b>true</b> the worker will be stopped if member
of load balancer. The flag is needed for stop complete traffic of a sticky
session
worker. It is only useful, when you have a cluster that replicated the
sessions.
This flag can be changed at runtime using status worker.
Modified: tomcat/jk/trunk/xdocs/webserver_howto/apache.xml
URL:
http://svn.apache.org/viewvc/tomcat/jk/trunk/xdocs/webserver_howto/apache.xml?rev=1647362&r1=1647361&r2=1647362&view=diff
==============================================================================
--- tomcat/jk/trunk/xdocs/webserver_howto/apache.xml (original)
+++ tomcat/jk/trunk/xdocs/webserver_howto/apache.xml Mon Dec 22 18:05:17 2014
@@ -618,14 +618,14 @@ local file that matches (this is done by
</p>
<p>
-If ForwardDirectories is set to false (default) and Apache doesn't find any
+If ForwardDirectories is set to <b>false</b> (default) and Apache doesn't find
any
files that match, Apache will serve the content of the directory (if directive
Options specifies Indexes for that directory) or a <code>403 Forbidden</code>
response (if
directive Options doesn't specify Indexes for that directory).
</p>
<p>
-If ForwarDirectories is set to true and Apache doesn't find any files that
+If ForwardDirectories is set to <b>true</b> and Apache doesn't find any files
that
match, the request will be forwarded to Tomcat for resolution. This is used in
cases when Apache cannot see the index files on the file system for various
reasons: Tomcat is running on a different machine, the JSP file has been
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org
