Skip to content

Commit 8e02939

Browse files
committed
update doc for 0.5.3
1 parent 6aee9da commit 8e02939

7 files changed

+35
-41
lines changed

CoreFeatures.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
Core Features
22
=================
33

4-
The latest release is v0.5.2, more detail changes about it can be found from [Release History](//nginx-clojure.github.io/downloads.html).
4+
The latest release is v0.5.3, more detail changes about it can be found from [Release History](//nginx-clojure.github.io/downloads.html).
55

66
1. Compatible with [Ring](https://github.com/ring-clojure/ring/blob/master/SPEC) and obviously supports those Ring based frameworks, such as Compojure etc.
77
1. Http Services by using Clojure / Java / Groovy to write simple handlers for http services.
88
1. Nginx Access Handler by Clojure / Java / Groovy
99
1. Nginx Header Filter by Clojure / Java / Groovy
1010
1. Nginx Body Filter by Clojure / Java / Groovy
11-
1. **_NEW_**: Nginx Log Handler by Clojure / Java / Groovy
12-
1. **_NEW_**: HTTP V2 support in both standard edition and embedded edition which are compiled against Nginx 1.18.0
13-
1. **_NEW_**: Support Java 9, 10, 11, 12
11+
1. Nginx Log Handler by Clojure / Java / Groovy
12+
1. HTTP V2 support in both standard edition and embedded edition which are compiled against Nginx 1.18.0+
13+
1. Support Java 9, 10, 11, 12
1414
1. Pub/Sub Among Nginx Worker Processes
1515
1. Shared Map based on shared memory & Shared Map based Ring session store
1616
1. Support Sente, see [this PR](https://github.com/ptaoussanis/sente/pull/160)
@@ -27,7 +27,7 @@ With this feature one java main thread can handle thousands of connections.
2727
1. Long Polling & Server Sent Events
2828
1. Run initialization clojure code when nginx worker starting
2929
1. Support user defined http request method
30-
1. Compatible with the Nginx lastest most stable version 1.18.0. (Nginx 1.14.x, 1.12.x, 1.8.x, 1.6.x, 1.4.x is also ok, older version is not tested and maybe works.)
30+
1. Compatible with the Nginx lastest most stable version 1.20.2. (Nginx 1.18.x, 1.14.x, 1.12.x, 1.8.x, 1.6.x, 1.4.x is also ok, older version is not tested and maybe works.)
3131
1. One of benifits of [Nginx](http://nginx.org/) is worker processes are automatically restarted by a master process if they crash
3232
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.
3333
1. Utilize [Nginx](http://nginx.org/) zero copy file sending mechanism to fast handle static contents controlled by Clojure or Java code.
@@ -47,19 +47,19 @@ Nginx-Clojure has already been published to https://clojars.org/ whose maven rep
4747
</repository>
4848
```
4949

50-
After adding clojars repository, you can reference nginx-clojure 0.5.2 , e.g.
50+
After adding clojars repository, you can reference nginx-clojure 0.5.3 , e.g.
5151

5252
Leiningen (clojure, no need to add clojars repository which is a default repository for Leiningen)
5353
-----------------
5454

5555
```clojure
56-
[nginx-clojure "0.5.2"]
56+
[nginx-clojure "0.5.3"]
5757
```
5858
Gradle (groovy/java)
5959
-----------------
6060

6161
```
62-
compile "nginx-clojure:nginx-clojure:0.5.2"
62+
compile "nginx-clojure:nginx-clojure:0.5.3"
6363
```
6464
Maven
6565
-----------------
@@ -68,7 +68,7 @@ Maven
6868
<dependency>
6969
<groupId>nginx-clojure</groupId>
7070
<artifactId>nginx-clojure</artifactId>
71-
<version>0.5.2</version>
71+
<version>0.5.3</version>
7272
</dependency>
7373
```
7474

CoreFeatures.md.html

+9-12
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,15 @@
11
<h1>
22
<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>
3-
<p>The latest release is v0.5.2, more detail changes about it can be found from <a href="//nginx-clojure.github.io/downloads.html" rel="nofollow">Release History</a>.</p>
3+
<p>The latest release is v0.5.3, more detail changes about it can be found from <a href="//nginx-clojure.github.io/downloads.html" rel="nofollow">Release History</a>.</p>
44
<ol>
55
<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>
66
<li>Http Services by using Clojure / Java / Groovy to write simple handlers for http services.</li>
77
<li>Nginx Access Handler by Clojure / Java / Groovy</li>
88
<li>Nginx Header Filter by Clojure / Java / Groovy</li>
99
<li>Nginx Body Filter by Clojure / Java / Groovy</li>
10-
<li>
11-
<strong><em>NEW</em></strong>: Nginx Log Handler by Clojure / Java / Groovy</li>
12-
<li>
13-
<strong><em>NEW</em></strong>: HTTP V2 support in both standard edition and embedded edition which are compiled against Nginx 1.18.0</li>
14-
<li>
15-
<strong><em>NEW</em></strong>: Support Java 9, 10, 11, 12</li>
10+
<li>Nginx Log Handler by Clojure / Java / Groovy</li>
11+
<li>HTTP V2 support in both standard edition and embedded edition which are compiled against Nginx 1.18.0+</li>
12+
<li>Support Java 9, 10, 11, 12</li>
1613
<li>Pub/Sub Among Nginx Worker Processes</li>
1714
<li>Shared Map based on shared memory &amp; Shared Map based Ring session store</li>
1815
<li>Support Sente, see <a href="https://github.com/ptaoussanis/sente/pull/160">this PR</a>
@@ -30,7 +27,7 @@ <h1>
3027
<li>Long Polling &amp; Server Sent Events</li>
3128
<li>Run initialization clojure code when nginx worker starting</li>
3229
<li>Support user defined http request method</li>
33-
<li>Compatible with the Nginx lastest most stable version 1.18.0. (Nginx 1.14.x, 1.12.x, 1.8.x, 1.6.x, 1.4.x is also ok, older version is not tested and maybe works.)</li>
30+
<li>Compatible with the Nginx lastest most stable version 1.20.2. (Nginx 1.18.x, 1.14.x, 1.12.x, 1.8.x, 1.6.x, 1.4.x is also ok, older version is not tested and maybe works.)</li>
3431
<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>
3532
<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>
3633
<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>
@@ -44,20 +41,20 @@ <h1>
4441
&lt;<span class="pl-ent">id</span>&gt;clojars.org&lt;/<span class="pl-ent">id</span>&gt;
4542
&lt;<span class="pl-ent">url</span>&gt;http://clojars.org/repo&lt;/<span class="pl-ent">url</span>&gt;
4643
&lt;/<span class="pl-ent">repository</span>&gt;</pre></div>
47-
<p>After adding clojars repository, you can reference nginx-clojure 0.5.2 , e.g.</p>
44+
<p>After adding clojars repository, you can reference nginx-clojure 0.5.3 , e.g.</p>
4845
<h2>
4946
<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>
50-
<div class="highlight highlight-source-clojure"><pre>[nginx-clojure <span class="pl-s"><span class="pl-pds">"</span>0.5.2<span class="pl-pds">"</span></span>]</pre></div>
47+
<div class="highlight highlight-source-clojure"><pre>[nginx-clojure <span class="pl-s"><span class="pl-pds">"</span>0.5.3<span class="pl-pds">"</span></span>]</pre></div>
5148
<h2>
5249
<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>
53-
<pre><code>compile "nginx-clojure:nginx-clojure:0.5.2"
50+
<pre><code>compile "nginx-clojure:nginx-clojure:0.5.3"
5451
</code></pre>
5552
<h2>
5653
<a id="user-content-maven" class="anchor" href="#maven" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Maven</h2>
5754
<div class="highlight highlight-text-xml"><pre>&lt;<span class="pl-ent">dependency</span>&gt;
5855
&lt;<span class="pl-ent">groupId</span>&gt;nginx-clojure&lt;/<span class="pl-ent">groupId</span>&gt;
5956
&lt;<span class="pl-ent">artifactId</span>&gt;nginx-clojure&lt;/<span class="pl-ent">artifactId</span>&gt;
60-
&lt;<span class="pl-ent">version</span>&gt;0.5.2&lt;/<span class="pl-ent">version</span>&gt;
57+
&lt;<span class="pl-ent">version</span>&gt;0.5.3&lt;/<span class="pl-ent">version</span>&gt;
6158
&lt;/<span class="pl-ent">dependency</span>&gt;</pre></div>
6259
<h1>
6360
<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>

QuickStart.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Quick Start
44
Installation
55
--------------
66

7-
1. Download the latest binaries release v0.5.2 from [here](https://sourceforge.net/projects/nginx-clojure/files/).
7+
1. Download the latest binaries release v0.5.3 from [here](https://sourceforge.net/projects/nginx-clojure/files/).
88
1. Unzip the zip file downloaded then rename the file `nginx-${os-arc}` to `nginx`, eg. for linux is `nginx-linux-x64`
99

1010
>If you want to compile it with your own nginx please check [HERE](installation.html)
@@ -140,7 +140,7 @@ Start up
140140

141141
```nginx
142142
143-
$ cd nginx-clojure-0.5.2
143+
$ cd nginx-clojure-0.5.3
144144
$ ./nginx
145145
```
146146
If everything is ok, we can access our first http service by this url

QuickStart.md.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ <h1>
33
<h2>
44
<a id="user-content-installation" class="anchor" href="#installation" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Installation</h2>
55
<ol>
6-
<li>Download the latest binaries release v0.5.2 from <a href="https://sourceforge.net/projects/nginx-clojure/files/" rel="nofollow">here</a>.</li>
6+
<li>Download the latest binaries release v0.5.3 from <a href="https://sourceforge.net/projects/nginx-clojure/files/" rel="nofollow">here</a>.</li>
77
<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>
88
</li>
99
</ol>
@@ -134,7 +134,7 @@ <h2>
134134
<h2>
135135
<a id="user-content-start-up" class="anchor" href="#start-up" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Start up</h2>
136136
<div class="highlight highlight-source-nginx"><pre>
137-
$ <span class="pl-k">cd</span> nginx-clojure-0.5.2
137+
$ <span class="pl-k">cd</span> nginx-clojure-0.5.3
138138
$ ./<span class="pl-k">nginx</span></pre></div>
139139
<p>If everything is ok, we can access our first http service by this url</p>
140140
<div class="highlight highlight-source-nginx"><pre><span class="pl-c">### For Clojure</span>

index.html

+9-12
Original file line numberDiff line numberDiff line change
@@ -102,19 +102,16 @@ <h6 id="project_tagline">Nginx module for embedding Clojure / Java / Groovy prog
102102
<section id="main_content" class="inner">
103103
<h1>
104104
<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>
105-
<p>The latest release is v0.5.2, more detail changes about it can be found from <a href="//nginx-clojure.github.io/downloads.html" rel="nofollow">Release History</a>.</p>
105+
<p>The latest release is v0.5.3, more detail changes about it can be found from <a href="//nginx-clojure.github.io/downloads.html" rel="nofollow">Release History</a>.</p>
106106
<ol>
107107
<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>
108108
<li>Http Services by using Clojure / Java / Groovy to write simple handlers for http services.</li>
109109
<li>Nginx Access Handler by Clojure / Java / Groovy</li>
110110
<li>Nginx Header Filter by Clojure / Java / Groovy</li>
111111
<li>Nginx Body Filter by Clojure / Java / Groovy</li>
112-
<li>
113-
<strong><em>NEW</em></strong>: Nginx Log Handler by Clojure / Java / Groovy</li>
114-
<li>
115-
<strong><em>NEW</em></strong>: HTTP V2 support in both standard edition and embedded edition which are compiled against Nginx 1.18.0</li>
116-
<li>
117-
<strong><em>NEW</em></strong>: Support Java 9, 10, 11, 12</li>
112+
<li>Nginx Log Handler by Clojure / Java / Groovy</li>
113+
<li>HTTP V2 support in both standard edition and embedded edition which are compiled against Nginx 1.18.0+</li>
114+
<li>Support Java 9, 10, 11, 12</li>
118115
<li>Pub/Sub Among Nginx Worker Processes</li>
119116
<li>Shared Map based on shared memory &amp; Shared Map based Ring session store</li>
120117
<li>Support Sente, see <a href="https://github.com/ptaoussanis/sente/pull/160">this PR</a>
@@ -132,7 +129,7 @@ <h1>
132129
<li>Long Polling &amp; Server Sent Events</li>
133130
<li>Run initialization clojure code when nginx worker starting</li>
134131
<li>Support user defined http request method</li>
135-
<li>Compatible with the Nginx lastest most stable version 1.18.0. (Nginx 1.14.x, 1.12.x, 1.8.x, 1.6.x, 1.4.x is also ok, older version is not tested and maybe works.)</li>
132+
<li>Compatible with the Nginx lastest most stable version 1.20.2. (Nginx 1.18.x, 1.14.x, 1.12.x, 1.8.x, 1.6.x, 1.4.x is also ok, older version is not tested and maybe works.)</li>
136133
<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>
137134
<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>
138135
<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>
@@ -146,20 +143,20 @@ <h1>
146143
&lt;<span class="pl-ent">id</span>&gt;clojars.org&lt;/<span class="pl-ent">id</span>&gt;
147144
&lt;<span class="pl-ent">url</span>&gt;http://clojars.org/repo&lt;/<span class="pl-ent">url</span>&gt;
148145
&lt;/<span class="pl-ent">repository</span>&gt;</pre></div>
149-
<p>After adding clojars repository, you can reference nginx-clojure 0.5.2 , e.g.</p>
146+
<p>After adding clojars repository, you can reference nginx-clojure 0.5.3 , e.g.</p>
150147
<h2>
151148
<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>
152-
<div class="highlight highlight-source-clojure"><pre>[nginx-clojure <span class="pl-s"><span class="pl-pds">"</span>0.5.2<span class="pl-pds">"</span></span>]</pre></div>
149+
<div class="highlight highlight-source-clojure"><pre>[nginx-clojure <span class="pl-s"><span class="pl-pds">"</span>0.5.3<span class="pl-pds">"</span></span>]</pre></div>
153150
<h2>
154151
<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>
155-
<pre><code>compile "nginx-clojure:nginx-clojure:0.5.2"
152+
<pre><code>compile "nginx-clojure:nginx-clojure:0.5.3"
156153
</code></pre>
157154
<h2>
158155
<a id="user-content-maven" class="anchor" href="#maven" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Maven</h2>
159156
<div class="highlight highlight-text-xml"><pre>&lt;<span class="pl-ent">dependency</span>&gt;
160157
&lt;<span class="pl-ent">groupId</span>&gt;nginx-clojure&lt;/<span class="pl-ent">groupId</span>&gt;
161158
&lt;<span class="pl-ent">artifactId</span>&gt;nginx-clojure&lt;/<span class="pl-ent">artifactId</span>&gt;
162-
&lt;<span class="pl-ent">version</span>&gt;0.5.2&lt;/<span class="pl-ent">version</span>&gt;
159+
&lt;<span class="pl-ent">version</span>&gt;0.5.3&lt;/<span class="pl-ent">version</span>&gt;
163160
&lt;/<span class="pl-ent">dependency</span>&gt;</pre></div>
164161
<h1>
165162
<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>

more.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -265,7 +265,7 @@ <h3>
265265
<a id="user-content-send-messages-for-server-sent-events-sse" class="anchor" href="#send-messages-for-server-sent-events-sse" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Send Messages for Server Sent Events (SSE)</h3>
266266

267267
<p>First we can use <code>send-headers!</code>(Clojure) or <code>sendHeaders</code> (Java/Groovy) to send a SSE header. Then we
268-
can use <code>send!</code> (Clojure) or <code>send</code> (Java/Groovy) to send later messages. The last two parameters of the send
268+
can use <code>send!</code> (Clojure) or <code>send</code> (Java/Groovy) to send later messages. The last two parameters of a send
269269
function is used to flush a message or close the channel after sending the current message.</p>
270270

271271
<p>For Clojure:</p>
@@ -350,7 +350,7 @@ <h2>
350350
API is similar to Java 7 NIO.2 Asynchronous Channel and more details can be found from issue #37 and its comments
351351
<a href="https://github.com/nginx-clojure/nginx-clojure/issues/37">Asynchronous Channel API</a>.</p>
352352

353-
<p>Here's an example which is retrieving content from mirror.bit.edu.cn:8080 and sending it to the client. </p>
353+
<p>Here's an example which is retrieving content from mirror.bit.edu.cn:8080 and sending it to the client.</p>
354354

355355
<ul>
356356
<li><a href="https://github.com/nginx-clojure/nginx-clojure/blob/master/test/clojure/nginx/clojure/asyn_channel_handlers_for_test.clj">Clojure Example</a></li>

quickstart.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ <h1>
105105
<h2>
106106
<a id="user-content-installation" class="anchor" href="#installation" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Installation</h2>
107107
<ol>
108-
<li>Download the latest binaries release v0.5.2 from <a href="https://sourceforge.net/projects/nginx-clojure/files/" rel="nofollow">here</a>.</li>
108+
<li>Download the latest binaries release v0.5.3 from <a href="https://sourceforge.net/projects/nginx-clojure/files/" rel="nofollow">here</a>.</li>
109109
<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>
110110
</li>
111111
</ol>
@@ -236,7 +236,7 @@ <h2>
236236
<h2>
237237
<a id="user-content-start-up" class="anchor" href="#start-up" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Start up</h2>
238238
<div class="highlight highlight-source-nginx"><pre>
239-
$ <span class="pl-k">cd</span> nginx-clojure-0.5.2
239+
$ <span class="pl-k">cd</span> nginx-clojure-0.5.3
240240
$ ./<span class="pl-k">nginx</span></pre></div>
241241
<p>If everything is ok, we can access our first http service by this url</p>
242242
<div class="highlight highlight-source-nginx"><pre><span class="pl-c">### For Clojure</span>

0 commit comments

Comments
 (0)