update doc about embedding tomcat

Author: xfeep

CoreFeatures.md

@@ -23,7 +23,7 @@ With this feature  one java main thread can handle thousands of connections.
 1. One of  benifits of [Nginx](http://nginx.org/) is worker processes are automatically restarted by a master process if they crash
 1. Utilizes lazy headers and direct memory operation between [Nginx](http://nginx.org/) and JVM to fast handle dynamic contents from Clojure or Java code.
 1. Utilizes [Nginx](http://nginx.org/) zero copy file sending mechanism to fast handle static contents controlled by Clojure or Java code.
-1. Supports Linux x64, Linux x86 32bit, Win32, Win64  and Mac OS X. 
+1. Supports Linux x64, Linux x86 32bit, Win32, Win64  and Mac OS X. Freebsd version can also be got from Freebsd ports.
 
 By the way it is very fast, the benchmarks can be found [HERE(with wrk2)](https://github.com/ptaoussanis/clojure-web-server-benchmarks/).
 

CoreFeatures.md.html

@@ -27,7 +27,7 @@ <h1>
 <li>One of  benifits of <a href="http://nginx.org/">Nginx</a> is worker processes are automatically restarted by a master process if they crash</li>
 <li>Utilizes lazy headers and direct memory operation between <a href="http://nginx.org/">Nginx</a> and JVM to fast handle dynamic contents from Clojure or Java code.</li>
 <li>Utilizes <a href="http://nginx.org/">Nginx</a> zero copy file sending mechanism to fast handle static contents controlled by Clojure or Java code.</li>
-<li>Supports Linux x64, Linux x86 32bit, Win32, Win64  and Mac OS X. </li>
+<li>Supports Linux x64, Linux x86 32bit, Win32, Win64  and Mac OS X. Freebsd version can also be got from Freebsd ports.</li>
 </ol>
 
 <p>By the way it is very fast, the benchmarks can be found <a href="https://github.com/ptaoussanis/clojure-web-server-benchmarks/">HERE(with wrk2)</a>.</p>

More.md

@@ -636,6 +636,28 @@ callback({
 3.10 Embeding Tomcat
 -----------------
 
+### Which Version?
+
+Apache Tomcat version | Nginx-Clojure version|Nginx-Tomcat8 version
+------------ | -------------|-------------
+8.0.20 | >=0.4.x|0.1.x
+8.0.23,8.0.24 | >=0.4.x|0.2.x
+
+### Get Jar File
+
+We can get the released version from [clojars](https://clojars.org/nginx-clojure/nginx-tomcat8) or 
+the jar in [nginx-clojure binary release](https://sourceforge.net/projects/nginx-clojure/files/) 
+
+For get the latest version from the github source
+
+```shell
+git clone https://github.com/nginx-clojure/nginx-clojure
+cd nginx-tomcat8
+lein jar
+```
+
+### Configuration
+
 in nginx.conf
 
 ```nginx
@@ -678,7 +700,7 @@ in nginx.conf
       }
 ```
 
-### For performance
+### For Performance
 
 #### Disable Tomcat Access Log
 

More.md.html

@@ -606,6 +606,46 @@ <h2>
 <h2>
 <a id="user-content-310-embeding-tomcat" class="anchor" href="#310-embeding-tomcat" aria-hidden="true"><span class="octicon octicon-link"></span></a>3.10 Embeding Tomcat</h2>
 
+<h3>
+<a id="user-content-which-version" class="anchor" href="#which-version" aria-hidden="true"><span class="octicon octicon-link"></span></a>Which Version?</h3>
+
+<table>
+<thead>
+<tr>
+<th>Apache Tomcat version</th>
+<th>Nginx-Clojure version</th>
+<th>Nginx-Tomcat8 version</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>8.0.20</td>
+<td>&gt;=0.4.x</td>
+<td>0.1.x</td>
+</tr>
+<tr>
+<td>8.0.23,8.0.24</td>
+<td>&gt;=0.4.x</td>
+<td>0.2.x</td>
+</tr>
+</tbody>
+</table>
+
+<h3>
+<a id="user-content-get-jar-file" class="anchor" href="#get-jar-file" aria-hidden="true"><span class="octicon octicon-link"></span></a>Get Jar File</h3>
+
+<p>We can get the released version from <a href="https://clojars.org/nginx-clojure/nginx-tomcat8">clojars</a> or 
+the jar in <a href="https://sourceforge.net/projects/nginx-clojure/files/">nginx-clojure binary release</a> </p>
+
+<p>For get the latest version from the github source</p>
+
+<div class="highlight highlight-shell"><pre>git clone https://github.com/nginx-clojure/nginx-clojure
+<span class="pl-c1">cd</span> nginx-tomcat8
+lein jar</pre></div>
+
+<h3>
+<a id="user-content-configuration" class="anchor" href="#configuration" aria-hidden="true"><span class="octicon octicon-link"></span></a>Configuration</h3>
+
 <p>in nginx.conf</p>
 
 <div class="highlight highlight-nginx"><pre>      <span class="pl-k">location</span> <span class="pl-en">/ </span>{
@@ -647,7 +687,7 @@ <h2>
       }</pre></div>
 
 <h3>
-<a id="user-content-for-performance" class="anchor" href="#for-performance" aria-hidden="true"><span class="octicon octicon-link"></span></a>For performance</h3>
+<a id="user-content-for-performance" class="anchor" href="#for-performance" aria-hidden="true"><span class="octicon octicon-link"></span></a>For Performance</h3>
 
 <h4>
 <a id="user-content-disable-tomcat-access-log" class="anchor" href="#disable-tomcat-access-log" aria-hidden="true"><span class="octicon octicon-link"></span></a>Disable Tomcat Access Log</h4>

QuickStart.md

@@ -4,7 +4,7 @@ Quick Start
 Installation
 --------------
 
-1. Download the latest binaries release v0.3.0 from [here](https://sourceforge.net/projects/nginx-clojure/files/). 
+1. Download the latest binaries release v0.4.0 from [here](https://sourceforge.net/projects/nginx-clojure/files/). 
 1. Unzip the zip file downloaded then rename the file `nginx-${os-arc}` to `nginx`, eg. for linux is `nginx-linux-x64`
 
 >If you want to compile it with your own nginx please check [HERE](installation.html)
@@ -22,7 +22,7 @@ Configuration
 	jvm_var my_other_jars 'my_jar_dir/clojure-1.5.1.jar';
 		
 	### my app classpath, windows user should use ';' as the separator
-	jvm_options "-Djava.class.path=jars/nginx-clojure-0.2.5.jar:#{my_other_jars}";
+	jvm_options "-Djava.class.path=jars/nginx-clojure-0.4.0.jar:#{my_other_jars}";
 
   ###or we can put jars in some directories, e.g. jars-dir1, jars-dir2
   ###so that all jars or direct sub directories from these directories will be appended to the jvm classpath

QuickStart.md.html

@@ -5,7 +5,7 @@ <h2>
 <a id="user-content-installation" class="anchor" href="#installation" aria-hidden="true"><span class="octicon octicon-link"></span></a>Installation</h2>
 
 <ol>
-<li>Download the latest binaries release v0.3.0 from <a href="https://sourceforge.net/projects/nginx-clojure/files/">here</a>. </li>
+<li>Download the latest binaries release v0.4.0 from <a href="https://sourceforge.net/projects/nginx-clojure/files/">here</a>. </li>
 <li>Unzip the zip file downloaded then rename the file <code>nginx-${os-arc}</code> to <code>nginx</code>, eg. for linux is <code>nginx-linux-x64</code>
 </li>
 </ol>
@@ -29,7 +29,7 @@ <h2>
 <span class="pl-k">jvm_var</span> my_other_jars <span class="pl-s">'my_jar_dir/clojure-1.5.1.jar'</span>;
 
 <span class="pl-c">### my app classpath, windows user should use ';' as the separator</span>
-<span class="pl-k">jvm_options</span> <span class="pl-s">"-Djava.class.path=jars/nginx-clojure-0.2.5.jar:#{my_other_jars}"</span>;
+<span class="pl-k">jvm_options</span> <span class="pl-s">"-Djava.class.path=jars/nginx-clojure-0.4.0.jar:#{my_other_jars}"</span>;
 
 <span class="pl-c">###or we can put jars in some directories, e.g. jars-dir1, jars-dir2</span>
 <span class="pl-c">###so that all jars or direct sub directories from these directories will be appended to the jvm classpath</span>

configuration.html

@@ -76,7 +76,7 @@ <h6 id="project_tagline">Nginx module for embedding Clojure / Java / Groovy prog
 <!-- 						<li><a href="quickstart.html"><span class="glyphicon glyphicon-flash"></span> Quick Start</a></li> -->
 						<li><a href="installation.html"><span class="glyphicon glyphicon-hdd"></span> Installation</a></li>
 						<li><a href="configuration.html"><span class="glyphicon glyphicon-cog"></span> Configuration</a></li>
-						<li><a href="more.html#34-server-channel-for-long-polling--server-sent-events-sse"><span class="glyphicon glyphicon-envelope"></span>Server Channel for Long Polling & Server Sent Events</a></li>
+						<li><a href="more.html#34-server-channel-for-long-polling--server-sent-events-sse"><span class="glyphicon glyphicon-envelope"></span> Server Channel for Long Polling & Server Sent Events</a></li>
 						<li><a href="more.html#35-subpub--broadcast-event"><span class="glyphicon glyphicon-signal"></span> Sub/Pub services with Broadcast Events</a></li>
 						<li><a href="more.html#36-asynchronous-client-channel"><span class="glyphicon glyphicon-road"></span> Asynchronous Client Channel</a></li>
 						<li><a href="more.html#37--about-logging"><span class="glyphicon glyphicon-th-list"></span> About Logging</a></li>
@@ -634,7 +634,7 @@ <h3>
         <span class="pl-k">@Override</span>
         <span class="pl-k">public</span> <span class="pl-k">Object</span>[] <span class="pl-en">invoke</span>(<span class="pl-k">Map&lt;<span class="pl-smi">String</span>, <span class="pl-smi">Object</span>&gt;</span> <span class="pl-v">req</span>) {
             <span class="pl-smi">String</span> myhost <span class="pl-k">=</span> computeMyHost(req);
-            <span class="pl-smi">NginxClojureRT</span><span class="pl-k">.</span>setNGXVariable(((<span class="pl-smi">NginxJavaRequest</span>)req)<span class="pl-k">.</span>nativeRequest(), <span class="pl-s"><span class="pl-pds">"</span>myhost<span class="pl-pds">"</span></span>, myhost);
+            ((<span class="pl-smi">NginxJavaRequest</span>)req)<span class="pl-k">.</span>setNGXVariable(<span class="pl-s"><span class="pl-pds">"</span>myhost<span class="pl-pds">"</span></span>, myhost);
             <span class="pl-k">return</span> <span class="pl-c1">PHASE_DONE</span>;
         }
 

downloads.html

@@ -76,7 +76,7 @@ <h6 id="project_tagline">Nginx module for embedding Clojure / Java / Groovy prog
 <!-- 						<li><a href="quickstart.html"><span class="glyphicon glyphicon-flash"></span> Quick Start</a></li> -->
 						<li><a href="installation.html"><span class="glyphicon glyphicon-hdd"></span> Installation</a></li>
 						<li><a href="configuration.html"><span class="glyphicon glyphicon-cog"></span> Configuration</a></li>
-						<li><a href="more.html#34-server-channel-for-long-polling--server-sent-events-sse"><span class="glyphicon glyphicon-envelope"></span>Server Channel for Long Polling & Server Sent Events</a></li>
+						<li><a href="more.html#34-server-channel-for-long-polling--server-sent-events-sse"><span class="glyphicon glyphicon-envelope"></span> Server Channel for Long Polling & Server Sent Events</a></li>
 						<li><a href="more.html#35-subpub--broadcast-event"><span class="glyphicon glyphicon-signal"></span> Sub/Pub services with Broadcast Events</a></li>
 						<li><a href="more.html#36-asynchronous-client-channel"><span class="glyphicon glyphicon-road"></span> Asynchronous Client Channel</a></li>
 						<li><a href="more.html#37--about-logging"><span class="glyphicon glyphicon-th-list"></span> About Logging</a></li>
@@ -106,7 +106,7 @@ <h2>
 <a id="user-content-040-2015-07-06" class="anchor" href="#040-2015-07-06" aria-hidden="true"><span class="octicon octicon-link"></span></a>0.4.0 (2015-07-06)</h2>
 
 <ol>
-<li>New Feature: Service Side Websocket (issue #73)</li>
+<li>New Feature: Server Side Websocket (issue #73)</li>
 <li>New Feature: A build-in Jersey container to support java standard RESTful web services (JAX-RS 2.0) (issue #74)</li>
 <li>New Feature: Tomcat 8 embedding support (so servlet 3.1/jsp/sendfile/JSR-356 websocket work within nginx!) (issue #67)</li>
 <li>New Feature: Coroutined Based Client Socket Supports to Bind to Specified IP Address (issue #69)</li>

header.html

@@ -43,7 +43,7 @@ <h6 id="project_tagline">Nginx module for embedding Clojure / Java / Groovy prog
 <!-- 						<li><a href="quickstart.html"><span class="glyphicon glyphicon-flash"></span> Quick Start</a></li> -->
 						<li><a href="installation.html"><span class="glyphicon glyphicon-hdd"></span> Installation</a></li>
 						<li><a href="configuration.html"><span class="glyphicon glyphicon-cog"></span> Configuration</a></li>
-						<li><a href="more.html#34-server-channel-for-long-polling--server-sent-events-sse"><span class="glyphicon glyphicon-envelope"></span>Server Channel for Long Polling & Server Sent Events</a></li>
+						<li><a href="more.html#34-server-channel-for-long-polling--server-sent-events-sse"><span class="glyphicon glyphicon-envelope"></span> Server Channel for Long Polling & Server Sent Events</a></li>
 						<li><a href="more.html#35-subpub--broadcast-event"><span class="glyphicon glyphicon-signal"></span> Sub/Pub services with Broadcast Events</a></li>
 						<li><a href="more.html#36-asynchronous-client-channel"><span class="glyphicon glyphicon-road"></span> Asynchronous Client Channel</a></li>
 						<li><a href="more.html#37--about-logging"><span class="glyphicon glyphicon-th-list"></span> About Logging</a></li>

index.html

@@ -76,7 +76,7 @@ <h6 id="project_tagline">Nginx module for embedding Clojure / Java / Groovy prog
 <!-- 						<li><a href="quickstart.html"><span class="glyphicon glyphicon-flash"></span> Quick Start</a></li> -->
 						<li><a href="installation.html"><span class="glyphicon glyphicon-hdd"></span> Installation</a></li>
 						<li><a href="configuration.html"><span class="glyphicon glyphicon-cog"></span> Configuration</a></li>
-						<li><a href="more.html#34-server-channel-for-long-polling--server-sent-events-sse"><span class="glyphicon glyphicon-envelope"></span>Server Channel for Long Polling & Server Sent Events</a></li>
+						<li><a href="more.html#34-server-channel-for-long-polling--server-sent-events-sse"><span class="glyphicon glyphicon-envelope"></span> Server Channel for Long Polling & Server Sent Events</a></li>
 						<li><a href="more.html#35-subpub--broadcast-event"><span class="glyphicon glyphicon-signal"></span> Sub/Pub services with Broadcast Events</a></li>
 						<li><a href="more.html#36-asynchronous-client-channel"><span class="glyphicon glyphicon-road"></span> Asynchronous Client Channel</a></li>
 						<li><a href="more.html#37--about-logging"><span class="glyphicon glyphicon-th-list"></span> About Logging</a></li>
@@ -123,7 +123,7 @@ <h1>
 <li>One of  benifits of <a href="http://nginx.org/">Nginx</a> is worker processes are automatically restarted by a master process if they crash</li>
 <li>Utilizes lazy headers and direct memory operation between <a href="http://nginx.org/">Nginx</a> and JVM to fast handle dynamic contents from Clojure or Java code.</li>
 <li>Utilizes <a href="http://nginx.org/">Nginx</a> zero copy file sending mechanism to fast handle static contents controlled by Clojure or Java code.</li>
-<li>Supports Linux x64, Linux x86 32bit, Win32, Win64  and Mac OS X. </li>
+<li>Supports Linux x64, Linux x86 32bit, Win32, Win64  and Mac OS X. Freebsd version can also be got from Freebsd ports.</li>
 </ol>
 
 <p>By the way it is very fast, the benchmarks can be found <a href="https://github.com/ptaoussanis/clojure-web-server-benchmarks/">HERE(with wrk2)</a>.</p>
@@ -157,7 +157,7 @@ <h2>
 <div class="highlight highlight-xml"><pre>&lt;<span class="pl-ent">dependency</span>&gt;
   &lt;<span class="pl-ent">groupId</span>&gt;nginx-clojure&lt;/<span class="pl-ent">groupId</span>&gt;
   &lt;<span class="pl-ent">artifactId</span>&gt;nginx-clojure&lt;/<span class="pl-ent">artifactId</span>&gt;
-  &lt;<span class="pl-ent">version</span>&gt;0.3.0&lt;/<span class="pl-ent">version</span>&gt;
+  &lt;<span class="pl-ent">version</span>&gt;0.4.0&lt;/<span class="pl-ent">version</span>&gt;
 &lt;/<span class="pl-ent">dependency</span>&gt;</pre></div>
 
 <h1>

installation.html

@@ -76,7 +76,7 @@ <h6 id="project_tagline">Nginx module for embedding Clojure / Java / Groovy prog
 <!-- 						<li><a href="quickstart.html"><span class="glyphicon glyphicon-flash"></span> Quick Start</a></li> -->
 						<li><a href="installation.html"><span class="glyphicon glyphicon-hdd"></span> Installation</a></li>
 						<li><a href="configuration.html"><span class="glyphicon glyphicon-cog"></span> Configuration</a></li>
-						<li><a href="more.html#34-server-channel-for-long-polling--server-sent-events-sse"><span class="glyphicon glyphicon-envelope"></span>Server Channel for Long Polling & Server Sent Events</a></li>
+						<li><a href="more.html#34-server-channel-for-long-polling--server-sent-events-sse"><span class="glyphicon glyphicon-envelope"></span> Server Channel for Long Polling & Server Sent Events</a></li>
 						<li><a href="more.html#35-subpub--broadcast-event"><span class="glyphicon glyphicon-signal"></span> Sub/Pub services with Broadcast Events</a></li>
 						<li><a href="more.html#36-asynchronous-client-channel"><span class="glyphicon glyphicon-road"></span> Asynchronous Client Channel</a></li>
 						<li><a href="more.html#37--about-logging"><span class="glyphicon glyphicon-th-list"></span> About Logging</a></li>

more.html

@@ -76,7 +76,7 @@ <h6 id="project_tagline">Nginx module for embedding Clojure / Java / Groovy prog
 <!-- 						<li><a href="quickstart.html"><span class="glyphicon glyphicon-flash"></span> Quick Start</a></li> -->
 						<li><a href="installation.html"><span class="glyphicon glyphicon-hdd"></span> Installation</a></li>
 						<li><a href="configuration.html"><span class="glyphicon glyphicon-cog"></span> Configuration</a></li>
-						<li><a href="more.html#34-server-channel-for-long-polling--server-sent-events-sse"><span class="glyphicon glyphicon-envelope"></span>Server Channel for Long Polling & Server Sent Events</a></li>
+						<li><a href="more.html#34-server-channel-for-long-polling--server-sent-events-sse"><span class="glyphicon glyphicon-envelope"></span> Server Channel for Long Polling & Server Sent Events</a></li>
 						<li><a href="more.html#35-subpub--broadcast-event"><span class="glyphicon glyphicon-signal"></span> Sub/Pub services with Broadcast Events</a></li>
 						<li><a href="more.html#36-asynchronous-client-channel"><span class="glyphicon glyphicon-road"></span> Asynchronous Client Channel</a></li>
 						<li><a href="more.html#37--about-logging"><span class="glyphicon glyphicon-th-list"></span> About Logging</a></li>
@@ -702,6 +702,46 @@ <h2>
 <h2>
 <a id="user-content-310-embeding-tomcat" class="anchor" href="#310-embeding-tomcat" aria-hidden="true"><span class="octicon octicon-link"></span></a>3.10 Embeding Tomcat</h2>
 
+<h3>
+<a id="user-content-which-version" class="anchor" href="#which-version" aria-hidden="true"><span class="octicon octicon-link"></span></a>Which Version?</h3>
+
+<table>
+<thead>
+<tr>
+<th>Apache Tomcat version</th>
+<th>Nginx-Clojure version</th>
+<th>Nginx-Tomcat8 version</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>8.0.20</td>
+<td>&gt;=0.4.x</td>
+<td>0.1.x</td>
+</tr>
+<tr>
+<td>8.0.23,8.0.24</td>
+<td>&gt;=0.4.x</td>
+<td>0.2.x</td>
+</tr>
+</tbody>
+</table>
+
+<h3>
+<a id="user-content-get-jar-file" class="anchor" href="#get-jar-file" aria-hidden="true"><span class="octicon octicon-link"></span></a>Get Jar File</h3>
+
+<p>We can get the released version from <a href="https://clojars.org/nginx-clojure/nginx-tomcat8">clojars</a> or 
+the jar in <a href="https://sourceforge.net/projects/nginx-clojure/files/">nginx-clojure binary release</a> </p>
+
+<p>For get the latest version from the github source</p>
+
+<div class="highlight highlight-shell"><pre>git clone https://github.com/nginx-clojure/nginx-clojure
+<span class="pl-c1">cd</span> nginx-tomcat8
+lein jar</pre></div>
+
+<h3>
+<a id="user-content-configuration" class="anchor" href="#configuration" aria-hidden="true"><span class="octicon octicon-link"></span></a>Configuration</h3>
+
 <p>in nginx.conf</p>
 
 <div class="highlight highlight-nginx"><pre>      <span class="pl-k">location</span> <span class="pl-en">/ </span>{
@@ -743,7 +783,7 @@ <h2>
       }</pre></div>
 
 <h3>
-<a id="user-content-for-performance" class="anchor" href="#for-performance" aria-hidden="true"><span class="octicon octicon-link"></span></a>For performance</h3>
+<a id="user-content-for-performance" class="anchor" href="#for-performance" aria-hidden="true"><span class="octicon octicon-link"></span></a>For Performance</h3>
 
 <h4>
 <a id="user-content-disable-tomcat-access-log" class="anchor" href="#disable-tomcat-access-log" aria-hidden="true"><span class="octicon octicon-link"></span></a>Disable Tomcat Access Log</h4>