Skip to content

Commit aef0e15

Browse files
committed
updated the docs
1 parent b9683d8 commit aef0e15

File tree

3 files changed

+90
-510
lines changed

3 files changed

+90
-510
lines changed

README

+9-72
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,8 @@ Synopsis
2020
}
2121

2222
Description
23-
With this module, Nginx can connect to AJP port directly. The backend
24-
connections can be keepalive, session sticky. The motivation of writing
25-
these modules is Nginx's high performance and robustness.
23+
With this module, Nginx can connect to AJP port directly. The motivation
24+
of writing these modules is Nginx's high performance and robustness.
2625

2726
Directives
2827
ajp_buffers
@@ -483,70 +482,6 @@ Directives
483482
writing. It may be used to prevent a worker process blocking for too
484483
long while spooling data.
485484

486-
jvm_route
487-
syntax: *jvm_route $cookie_SESSION_COOKIE[|session_url] [reverse]*
488-
489-
default: *none*
490-
491-
context: *upstream*
492-
493-
This directive comes from ngx_http_upstream_jvm_route_module
494-
(<http://code.google.com/p/nginx-upstream-jvm-route/>).
495-
496-
'$cookie_SESSION_COOKIE' specifies the session cookie name (0.7.24+).
497-
'session_url' specifies a different session name in the URL when the
498-
client does not accept a cookie. The session name is case-insensitive.
499-
In this module, if it does not find the session_url, it will use the
500-
session cookie name instead. So if the session name in cookie is the
501-
name with its in URL, you don't need give the session_url name.
502-
503-
With scanning this cookie, the module will send the request to right
504-
backend server. As far as I know, the resin's srun_id name is in the
505-
head of cookie. For example, requests with cookie value 'a$$$' are
506-
always sent to the server with the srun_id of 'a'. But tomcat's
507-
JSESSIONID is opposite, which is like '$$$.a'. The parameter of
508-
'reverse' specifies the cookie scanned from tail to head.
509-
510-
If the request fails to be sent to the chosen backend server, It will
511-
try another server with the Round-Robin mode until all the upstream
512-
servers tried. The directive ajp_next_upstream can specify in what cases
513-
the request will be transmitted to the next server. If you want to force
514-
the session sticky, you can set 'ajp_next_upstream off'.
515-
516-
jvm_route_status
517-
syntax: *jvm_route_status upstream_name*
518-
519-
default: *none*
520-
521-
*'context:* *location*
522-
523-
This directive comes from ngx_http_upstream_jvm_route_module
524-
(<http://code.google.com/p/nginx-upstream-jvm-route/>).
525-
526-
Set the location of pages return the status of the jvm_route peers.
527-
Example: location status { jvm_route_status backend; }
528-
529-
Parameters:
530-
531-
num: Maximum number of connections to cache. If there isn't enough room
532-
to cache new connections - last recently used connections will be kicked
533-
off the cache.
534-
server(in upstream)
535-
This directive comes from ngx_http_upstream_jvm_route_module
536-
(<http://code.google.com/p/nginx-upstream-jvm-route/>).
537-
538-
Main syntax is the same as the official directive. This module add these
539-
parameters:
540-
541-
'srun_id': identifies the backend JVM's name by cookie. The default
542-
srun_id's value is 'a'. The name can be more than one letter.
543-
'max_busy': the maximum of active connections with the backend server.
544-
The default value is 0 which means unlimited. If the server's active
545-
connections is higher than this parameter, it will not be chosen until
546-
the server is less busier. If all the servers are busy, Nginx will
547-
return 502.
548-
NOTE: This module does not support the parameter of 'backup' yet.
549-
550485
Installation
551486
Download the latest version of the release tarball of this module from
552487
github (<http://github.com/yaoweibin/nginx_ajp_module>)
@@ -555,9 +490,9 @@ Installation
555490
example, the version 1.2.0 (see nginx compatibility), and then build the
556491
source with this module:
557492

558-
$ wget 'http://nginx.org/download/nginx-1.2.0.tar.gz'
559-
$ tar -xzvf nginx-1.2.6.tar.gz
560-
$ cd nginx-1.2.6/
493+
$ wget 'http://nginx.org/download/nginx-1.4.4.tar.gz'
494+
$ tar -xzvf nginx-1.4.4.tar.gz
495+
$ cd nginx-1.4.4/
561496
$ ./configure --add-module=/path/to/nginx_ajp_module
562497

563498
$ make
@@ -569,10 +504,12 @@ Compatibility
569504
(<https://github.com/yaoweibin/nginx_ajp_module/tree/nginx-1.0>) branch.
570505
TODO
571506
SSL
572-
refactor with nginx-1.2.x
573507
Known Issues
574-
Developing
508+
*
509+
575510
Changelogs
511+
v0.2
512+
remove the jvm_route and keepalive module
576513
v0.1
577514
first release
578515
Authors

0 commit comments

Comments
 (0)