🔖 doc update for v0.5.1

Author: xfeep

Configuration.md

@@ -45,7 +45,7 @@ It 's a new feature since v0.2.5. We can define variables and reuse them in jvm_
 ```nginx
 
     ###define nginx_clojure_jar
-    jvm_var nginx_clojure_jar '/home/who/git/nginx-clojure/target/nginx-clojure-0.2.5.jar';
+    jvm_var nginx_clojure_jar '/home/who/git/nginx-clojure/target/nginx-clojure-0.5.1.jar';
     ###reference variable nginx_clojure_jar, starts with #{ different from nginx variable
     jvm_options "-javaagent:#{nginx_clojure_jar}=mb";
     jvm_options "-Xbootclasspath/a:#{nginx_clojure_jar}:jars/clojure-1.5.1.jar"; 

Configuration.md.html

@@ -37,7 +37,7 @@ <h3>
 <p>It 's a new feature since v0.2.5. We can define variables and reuse them in jvm_options to make configurations neat.</p>
 <div class="highlight highlight-source-nginx"><pre>
     <span class="pl-c">###define nginx_clojure_jar</span>
-    <span class="pl-k">jvm_var</span> nginx_clojure_jar <span class="pl-s">'/home/who/git/nginx-clojure/target/nginx-clojure-0.2.5.jar'</span>;
+    <span class="pl-k">jvm_var</span> nginx_clojure_jar <span class="pl-s">'/home/who/git/nginx-clojure/target/nginx-clojure-0.5.1.jar'</span>;
     <span class="pl-c">###reference variable nginx_clojure_jar, starts with #{ different from nginx variable</span>
     <span class="pl-k">jvm_options</span> <span class="pl-s">"-javaagent:#{nginx_clojure_jar}=mb"</span>;
     <span class="pl-k">jvm_options</span> <span class="pl-s">"-Xbootclasspath/a:#{nginx_clojure_jar}:jars/clojure-1.5.1.jar"</span>; 

CoreFeatures.md

@@ -1,7 +1,7 @@
 Core Features
 =================
 
-The latest release is v0.5.0, more detail changes about it can be found from [Release History](//nginx-clojure.github.io/downloads.html).
+The latest release is v0.5.1, more detail changes about it can be found from [Release History](//nginx-clojure.github.io/downloads.html).
 
 1. Compatible with [Ring](https://github.com/ring-clojure/ring/blob/master/SPEC) and obviously supports those Ring based frameworks, such as Compojure etc.
 1. Http Services by  using Clojure / Java / Groovy to write simple handlers for http services.
@@ -29,9 +29,9 @@ With this feature  one java main thread can handle thousands of connections.
 1. Support user defined http request method
 1. Compatible with the Nginx lastest most stable version 1.14.2. (Nginx 1.12.x, 1.8.x, 1.6.x, 1.4.x is also ok, older version is not tested and maybe works.)
 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. Freebsd version can also be got from Freebsd ports.
+1. Utilize lazy headers and direct memory operation between [Nginx](http://nginx.org/) and JVM to fast handle dynamic contents from Clojure or Java code.
+1. Utilize [Nginx](http://nginx.org/) zero copy file sending mechanism to fast handle static contents controlled by Clojure or Java code.
+1. Support 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/).
 
@@ -47,19 +47,19 @@ Nginx-Clojure has already been published to https://clojars.org/ whose maven rep
 </repository>
 ``` 
 
-After adding clojars repository, you can reference nginx-clojure 0.5.0 , e.g.
+After adding clojars repository, you can reference nginx-clojure 0.5.1 , e.g.
 
  Leiningen (clojure, no need to add clojars repository which is a default repository for Leiningen) 
 -----------------
 
 ```clojure
-[nginx-clojure "0.5.0"]
+[nginx-clojure "0.5.1"]
 ```
 Gradle (groovy/java)
 -----------------
 
 ```
-compile "nginx-clojure:nginx-clojure:0.5.0"
+compile "nginx-clojure:nginx-clojure:0.5.1"
 ```
 Maven
 -----------------
@@ -68,7 +68,7 @@ Maven
 <dependency>
   <groupId>nginx-clojure</groupId>
   <artifactId>nginx-clojure</artifactId>
-  <version>0.5.0</version>
+  <version>0.5.1</version>
 </dependency>
 ```
 

CoreFeatures.md.html

@@ -1,6 +1,6 @@
 <h1>
 <a id="user-content-core-features" class="anchor" href="#core-features" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Core Features</h1>
-<p>The latest release is v0.5.0, more detail changes about it can be found from <a href="//nginx-clojure.github.io/downloads.html" rel="nofollow">Release History</a>.</p>
+<p>The latest release is v0.5.1, more detail changes about it can be found from <a href="//nginx-clojure.github.io/downloads.html" rel="nofollow">Release History</a>.</p>
 <ol>
 <li>Compatible with <a href="https://github.com/ring-clojure/ring/blob/master/SPEC">Ring</a> and obviously supports those Ring based frameworks, such as Compojure etc.</li>
 <li>Http Services by  using Clojure / Java / Groovy to write simple handlers for http services.</li>
@@ -32,9 +32,9 @@ <h1>
 <li>Support user defined http request method</li>
 <li>Compatible with the Nginx lastest most stable version 1.14.2. (Nginx 1.12.x, 1.8.x, 1.6.x, 1.4.x is also ok, older version is not tested and maybe works.)</li>
 <li>One of  benifits of <a href="http://nginx.org/" rel="nofollow">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/" rel="nofollow">Nginx</a> and JVM to fast handle dynamic contents from Clojure or Java code.</li>
-<li>Utilizes <a href="http://nginx.org/" rel="nofollow">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. Freebsd version can also be got from Freebsd ports.</li>
+<li>Utilize lazy headers and direct memory operation between <a href="http://nginx.org/" rel="nofollow">Nginx</a> and JVM to fast handle dynamic contents from Clojure or Java code.</li>
+<li>Utilize <a href="http://nginx.org/" rel="nofollow">Nginx</a> zero copy file sending mechanism to fast handle static contents controlled by Clojure or Java code.</li>
+<li>Support 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>
 <h1>
@@ -44,20 +44,20 @@ <h1>
   &lt;<span class="pl-ent">id</span>&gt;clojars.org&lt;/<span class="pl-ent">id</span>&gt;
   &lt;<span class="pl-ent">url</span>&gt;http://clojars.org/repo&lt;/<span class="pl-ent">url</span>&gt;
 &lt;/<span class="pl-ent">repository</span>&gt;</pre></div>
-<p>After adding clojars repository, you can reference nginx-clojure 0.5.0 , e.g.</p>
+<p>After adding clojars repository, you can reference nginx-clojure 0.5.1 , e.g.</p>
 <h2>
 <a id="user-content-leiningen-clojure-no-need-to-add-clojars-repository-which-is-a-default-repository-for-leiningen" class="anchor" href="#leiningen-clojure-no-need-to-add-clojars-repository-which-is-a-default-repository-for-leiningen" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Leiningen (clojure, no need to add clojars repository which is a default repository for Leiningen)</h2>
-<div class="highlight highlight-source-clojure"><pre>[nginx-clojure <span class="pl-s"><span class="pl-pds">"</span>0.5.0<span class="pl-pds">"</span></span>]</pre></div>
+<div class="highlight highlight-source-clojure"><pre>[nginx-clojure <span class="pl-s"><span class="pl-pds">"</span>0.5.1<span class="pl-pds">"</span></span>]</pre></div>
 <h2>
 <a id="user-content-gradle-groovyjava" class="anchor" href="#gradle-groovyjava" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Gradle (groovy/java)</h2>
-<pre><code>compile "nginx-clojure:nginx-clojure:0.5.0"
+<pre><code>compile "nginx-clojure:nginx-clojure:0.5.1"
 </code></pre>
 <h2>
 <a id="user-content-maven" class="anchor" href="#maven" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Maven</h2>
 <div class="highlight highlight-text-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.5.0&lt;/<span class="pl-ent">version</span>&gt;
+  &lt;<span class="pl-ent">version</span>&gt;0.5.1&lt;/<span class="pl-ent">version</span>&gt;
 &lt;/<span class="pl-ent">dependency</span>&gt;</pre></div>
 <h1>
 <a id="user-content-more-documents" class="anchor" href="#more-documents" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>More Documents</h1>

Embed.md

@@ -9,7 +9,7 @@ Jar Repository
 For Clojure
 
 ```clojure
-[nginx-clojure/nginx-clojure-embed "0.4.3"]
+[nginx-clojure/nginx-clojure-embed "0.5.1"]
 ```
 
 For Java (Maven)
@@ -25,7 +25,7 @@ For Java (Maven)
 <dependency>
   <groupId>nginx-clojure</groupId>
   <artifactId>nginx-clojure-embed</artifactId>
-  <version>0.4.3</version>
+  <version>0.5.1</version>
 </dependency>
 ```
 

Embed.md.html

@@ -1,90 +1,74 @@
 <h1>
-<a id="user-content-nginx-clojure-embed" class="anchor" href="#nginx-clojure-embed" aria-hidden="true"><span class="octicon octicon-link"></span></a>nginx-clojure-embed</h1>
-
+<a id="user-content-nginx-clojure-embed" class="anchor" href="#nginx-clojure-embed" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>nginx-clojure-embed</h1>
 <p>Embeding Nginx-Clojure into a standard java/clojure app without additional Nginx process.
 It can make test/debug with nginx-clojure clojure/java handler quite easy.</p>
-
 <h1>
-<a id="user-content-jar-repository" class="anchor" href="#jar-repository" aria-hidden="true"><span class="octicon octicon-link"></span></a>Jar Repository</h1>
-
+<a id="user-content-jar-repository" class="anchor" href="#jar-repository" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Jar Repository</h1>
 <p>For Clojure</p>
-
-<div class="highlight highlight-source-clojure"><pre>[nginx-clojure/nginx-clojure-embed <span class="pl-s"><span class="pl-pds">"</span>0.4.3<span class="pl-pds">"</span></span>]</pre></div>
-
+<div class="highlight highlight-source-clojure"><pre>[nginx-clojure/nginx-clojure-embed <span class="pl-s"><span class="pl-pds">"</span>0.5.1<span class="pl-pds">"</span></span>]</pre></div>
 <p>For Java (Maven)</p>
-
 <div class="highlight highlight-text-xml"><pre>&lt;<span class="pl-ent">repository</span>&gt;
   &lt;<span class="pl-ent">id</span>&gt;clojars.org&lt;/<span class="pl-ent">id</span>&gt;
   &lt;<span class="pl-ent">url</span>&gt;http://clojars.org/repo&lt;/<span class="pl-ent">url</span>&gt;
 &lt;/<span class="pl-ent">repository</span>&gt;</pre></div>
-
 <div class="highlight highlight-text-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-embed&lt;/<span class="pl-ent">artifactId</span>&gt;
-  &lt;<span class="pl-ent">version</span>&gt;0.4.3&lt;/<span class="pl-ent">version</span>&gt;
+  &lt;<span class="pl-ent">version</span>&gt;0.5.1&lt;/<span class="pl-ent">version</span>&gt;
 &lt;/<span class="pl-ent">dependency</span>&gt;</pre></div>
-
 <h1>
-<a id="user-content-startstop-embedded-server" class="anchor" href="#startstop-embedded-server" aria-hidden="true"><span class="octicon octicon-link"></span></a>Start/Stop Embedded Server</h1>
-
+<a id="user-content-startstop-embedded-server" class="anchor" href="#startstop-embedded-server" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Start/Stop Embedded Server</h1>
 <p>For Clojure</p>
-
-<div class="highlight highlight-source-clojure"><pre>    <span class="pl-c">;;(1) Start it with ring handler and an options map</span>
-    <span class="pl-c">;;my-app can be a simple ring hanler or a compojure router.</span>
+<div class="highlight highlight-source-clojure"><pre>    <span class="pl-c"><span class="pl-c">;</span>;(1) Start it with ring handler and an options map</span>
+    <span class="pl-c"><span class="pl-c">;</span>;my-app can be a simple ring hanler or a compojure router.</span>
     (<span class="pl-en">run-server</span> my-app {<span class="pl-c1">:port</span> <span class="pl-c1">8080</span>})
 
 
-   <span class="pl-c">;;(2) Start it with a nginx.conf file</span>
+   <span class="pl-c"><span class="pl-c">;</span>;(2) Start it with a nginx.conf file</span>
     (<span class="pl-en">run-server</span> <span class="pl-s"><span class="pl-pds">"</span>/my-dir/nginx.conf<span class="pl-pds">"</span></span>)
 
-   <span class="pl-c">;;(3) Start it with a given work dir</span>
+   <span class="pl-c"><span class="pl-c">;</span>;(3) Start it with a given work dir</span>
     (<span class="pl-k">binding</span> [*nginx-work-dir* my-work-dir]
       (<span class="pl-en">run-server</span> ...))
-
-   <span class="pl-c">;;(4) Stop the server</span>
+   
+   <span class="pl-c"><span class="pl-c">;</span>;(4) Stop the server</span>
     (<span class="pl-en">stop-server</span>)</pre></div>
-
 <p>For Java</p>
-
-<div class="highlight highlight-source-java"><pre><span class="pl-c">//Start it with ring handler and an options map</span>
+<div class="highlight highlight-source-java"><pre><span class="pl-c"><span class="pl-c">//</span>Start it with ring handler and an options map</span>
 <span class="pl-smi">NginxEmbedServer</span><span class="pl-k">.</span>getServer()<span class="pl-k">.</span>start(<span class="pl-s"><span class="pl-pds">"</span>my.HelloHandler<span class="pl-pds">"</span></span>, <span class="pl-smi">ArrayMap</span><span class="pl-k">.</span>create(<span class="pl-s"><span class="pl-pds">"</span>port<span class="pl-pds">"</span></span>, <span class="pl-s"><span class="pl-pds">"</span>8081<span class="pl-pds">"</span></span>));
 
 
-<span class="pl-c">//Start it with with a nginx.conf file</span>
+<span class="pl-c"><span class="pl-c">//</span>Start it with with a nginx.conf file</span>
 <span class="pl-smi">NginxEmbedServer</span><span class="pl-k">.</span>getServer()<span class="pl-k">.</span>start(<span class="pl-s"><span class="pl-pds">"</span>/my-dir/nginx.conf<span class="pl-pds">"</span></span>);
 
-<span class="pl-c">//Start it with a given work dir</span>
+<span class="pl-c"><span class="pl-c">//</span>Start it with a given work dir</span>
 <span class="pl-smi">NginxEmbedServer</span><span class="pl-k">.</span>getServer()<span class="pl-k">.</span>setWorkDir(my<span class="pl-k">-</span>work<span class="pl-k">-</span>dir);
 <span class="pl-smi">NginxEmbedServer</span><span class="pl-k">.</span>getServer()<span class="pl-k">.</span>start(<span class="pl-c1">...</span>);
 
 
-<span class="pl-c">//Stop the server</span>
+<span class="pl-c"><span class="pl-c">//</span>Stop the server</span>
 <span class="pl-smi">NginxEmbedServer</span><span class="pl-k">.</span>getServer()<span class="pl-k">.</span>stop();</pre></div>
-
 <h1>
-<a id="user-content-default-options" class="anchor" href="#default-options" aria-hidden="true"><span class="octicon octicon-link"></span></a>Default Options</h1>
-
+<a id="user-content-default-options" class="anchor" href="#default-options" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Default Options</h1>
 <div class="highlight highlight-source-clojure"><pre>          <span class="pl-s"><span class="pl-pds">"</span>error-log<span class="pl-pds">"</span></span>, <span class="pl-s"><span class="pl-pds">"</span>logs/error.log<span class="pl-pds">"</span></span>,
           <span class="pl-s"><span class="pl-pds">"</span>max-connections<span class="pl-pds">"</span></span>, <span class="pl-s"><span class="pl-pds">"</span>1024<span class="pl-pds">"</span></span>,
           <span class="pl-s"><span class="pl-pds">"</span>access-log<span class="pl-pds">"</span></span>, <span class="pl-s"><span class="pl-pds">"</span>off<span class="pl-pds">"</span></span>,
           <span class="pl-s"><span class="pl-pds">"</span>keepalive-timeout<span class="pl-pds">"</span></span>, <span class="pl-s"><span class="pl-pds">"</span>65<span class="pl-pds">"</span></span>,
           <span class="pl-s"><span class="pl-pds">"</span>max-threads<span class="pl-pds">"</span></span>, <span class="pl-s"><span class="pl-pds">"</span>8<span class="pl-pds">"</span></span>,
           <span class="pl-s"><span class="pl-pds">"</span>host<span class="pl-pds">"</span></span>, <span class="pl-s"><span class="pl-pds">"</span>0.0.0.0<span class="pl-pds">"</span></span>,
           <span class="pl-s"><span class="pl-pds">"</span>port<span class="pl-pds">"</span></span>, <span class="pl-s"><span class="pl-pds">"</span>8080<span class="pl-pds">"</span></span>,</pre></div>
-
 <p>User defined zones</p>
-
-<div class="highlight highlight-source-clojure"><pre>          <span class="pl-c">;;;at nginx.conf top level</span>
+<div class="highlight highlight-source-clojure"><pre>          <span class="pl-c"><span class="pl-c">;</span>;;at nginx.conf top level</span>
           <span class="pl-s"><span class="pl-pds">"</span>global-user-defined<span class="pl-pds">"</span></span>, <span class="pl-s"><span class="pl-pds">"</span><span class="pl-pds">"</span></span>,
-
-          <span class="pl-c">;;;at nginx.conf http block</span>
+          
+          <span class="pl-c"><span class="pl-c">;</span>;;at nginx.conf http block</span>
           <span class="pl-s"><span class="pl-pds">"</span>http-user-defined<span class="pl-pds">"</span></span>, <span class="pl-s"><span class="pl-pds">"</span><span class="pl-pds">"</span></span>,
-
-          <span class="pl-c">;;at nginx.conf types mapping block</span>
+          
+          <span class="pl-c"><span class="pl-c">;</span>;at nginx.conf types mapping block</span>
           <span class="pl-s"><span class="pl-pds">"</span>types-user-defined<span class="pl-pds">"</span></span>, <span class="pl-s"><span class="pl-pds">"</span><span class="pl-pds">"</span></span>,
-
-          <span class="pl-c">;;at nginx.conf server block</span>
+          
+          <span class="pl-c"><span class="pl-c">;</span>;at nginx.conf server block</span>
           <span class="pl-s"><span class="pl-pds">"</span>server-user-defined<span class="pl-pds">"</span></span>, <span class="pl-s"><span class="pl-pds">"</span><span class="pl-pds">"</span></span>,
-
-          <span class="pl-c">;;at nginx.conf location block</span>
+          
+          <span class="pl-c"><span class="pl-c">;</span>;at nginx.conf location block</span>
           <span class="pl-s"><span class="pl-pds">"</span>location-user-defined<span class="pl-pds">"</span></span>, <span class="pl-s"><span class="pl-pds">"</span><span class="pl-pds">"</span></span> </pre></div>

HISTORY.md

@@ -4,6 +4,18 @@ Downloads & Release History
 1. [Binaries of Releases](http://sourceforge.net/projects/nginx-clojure/files/)
 1. [Sources of Releases](https://github.com/nginx-clojure/nginx-clojure/releases)
 
+## 0.5.1 (2019-11-23)
+
+1. Bug Fix: Connection hangs with header filter at thread-pool mode #209 #153
+1. Bug Fix: Body filter hangs when body size is larger than the value specified in proxy_buffers #219
+1. Bug Fix: Segment fault caused by request is marked as closed too late #222
+1. Code Style: Fix generic warnings in java code code-style #223 (Thanks to Michael @mgoblin)
+1. Bug Fix: NPE caused by damaged memory because unsafe modify response headers #198 
+1. Bug Fix: Wrong response for uncompressed message with PMCE enabled
+1. CI: both auto-triggered unit test and integration test use travis-ci
+
+
+
 ## 0.5.0 (2019-10-26)
 
 1. New Feature: Java 9, 10, 11, 12 support. But Java 6 and Java 7 are deprecated now.