update for v0.4.1

Author: xfeep

.settings/ccw.repl.cmdhistory.prefs

@@ -1,2 +1,2 @@
-cmdhistory=["(render-md-file \\"/home/who/git/nginx-clojure.github.io/HISTORY.md\\")" "(render-md-file \\"/home/who/git/nginx-clojure.github.io/Configuration.md\\" )" " (render-md-file \\"/home/who/git/nginx-clojure.github.io/Configuration.md\\" )" "(render-md-file \\"/home/who/git/nginx-clojure.github.io/Configuration.md\\" )" "(render-md-file \\"/home/who/git/nginx-clojure.github.io/HISTORY.md\\")" " (render-md-file \\"/home/who/git/nginx-clojure.github.io/HISTORY.md\\")" "(render-md-file \\"/home/who/git/nginx-clojure.github.io/QuickStart.md\\")" "(render-md-file \\"/home/who/git/nginx-clojure.github.io/CoreFeatures.md\\")" " (render-md-file \\"/home/who/git/nginx-clojure.github.io/Installation.md\\")" "(render-md-file \\"/home/who/git/nginx-clojure.github.io/More.md\\")" " (render-md-file \\"/home/who/git/nginx-clojure.github.io/QuickStart.md\\")" " (render-md-file \\"/home/who/git/nginx-clojure.github.io/UserfullLinks.md\\")" "(render-md-file \\"/home/who/git/nginx-clojure.github.io/More.md\\")" "(render-md-file \\"/home/who/git/nginx-clojure.github.io/QuickStart.md\\")" "(render-md-file \\"/home/who/git/workflow-server/README.md\\")" " (render-md-file \\"/home/who/git/workflow-server/README.md\\")" "(render-md-file \\"/home/who/git/nginx-clojure.github.io/Configuration.md\\")" "(render-md-file  \\"/home/who/git/nginx-clojure.github.io/CoreFeatures.md\\")" " (render-md-file  \\"/home/who/git/nginx-clojure.github.io/CoreFeatures.md\\")" " (render-md-file  \\"/home/who/git/nginx-clojure.github.io/HISTORY.md\\")" "(render-md-file \\"/home/who/git/nginx-clojure.github.io/Configuration.md\\")" " (render-md-file \\"/home/who/git/nginx-clojure.github.io/Configuration.md\\")" "(render-md-file  \\"/home/who/git/nginx-clojure.github.io/CoreFeatures.md\\")" "(render-md-file \\"/home/who/git/nginx-clojure.github.io/Installation.md\\")" "(render-md-file \\"/home/who/git/nginx-clojure.github.io/QuickStart.md\\")" "(render-md-file \\"/home/who/git/nginx-clojure.github.io/More.md\\")" "(render-md-file \\"Configuration.md\\")" " (render-md-file \\"HISTORY.md\\")" "(render-md-file \\"CoreFeatures.md\\")" "(render-md-file \\"Installation.md\\")" "(render-md-file \\"More.md\\")" "(render-md-file \\"QuickStart.md\\")" "(render-md-file \\"Installation.md\\")" " (render-md-file \\"Installation.md\\")" "(doseq [f (file-seq \\".\\")]\\n  (println f))" " (doseq [f (file-seq  (clojure.java.io/file \\".\\"))]\\n     (println f))" "( render-all-updated \\".\\")" " ( render-all-updated \\".\\")" "( render-all-updated \\".\\")" " ( render-all-updated \\".\\")" "(render-md-file \\".\\")" "(render-all-updated \\".\\")" " (render-md-file \\".\\")" " (render-all-updated \\".\\")" "(render-all-updated \\".\\")" " (render-all-updated \\".\\")" "(render-all-updated \\".\\")" " (render-all-updated \\".\\")" "(render-all-updated \\".\\")" "(render-all-updated \\"/home/who/git/websocket-protocol.wiki\\")" "(def m (load-all-content))" " (def m (load-all-content))" "(count m)" "(m \\"footer\\")" "(def m (load-all-content))" "(m \\"content-template\\")" "(def m (load-all-content))" "(m \\"content-template\\")" "(man for)" "(doc for)" "(for [x (range 3)] (print x) x)" "(for [x (range 3)] (do (print x) x))" "(gen-all-updated-html)"]
+cmdhistory=["(render-md-file \\"/home/who/git/nginx-clojure.github.io/HISTORY.md\\")" "(render-md-file \\"/home/who/git/nginx-clojure.github.io/Configuration.md\\" )" " (render-md-file \\"/home/who/git/nginx-clojure.github.io/Configuration.md\\" )" "(render-md-file \\"/home/who/git/nginx-clojure.github.io/Configuration.md\\" )" "(render-md-file \\"/home/who/git/nginx-clojure.github.io/HISTORY.md\\")" " (render-md-file \\"/home/who/git/nginx-clojure.github.io/HISTORY.md\\")" "(render-md-file \\"/home/who/git/nginx-clojure.github.io/QuickStart.md\\")" "(render-md-file \\"/home/who/git/nginx-clojure.github.io/CoreFeatures.md\\")" " (render-md-file \\"/home/who/git/nginx-clojure.github.io/Installation.md\\")" "(render-md-file \\"/home/who/git/nginx-clojure.github.io/More.md\\")" " (render-md-file \\"/home/who/git/nginx-clojure.github.io/QuickStart.md\\")" " (render-md-file \\"/home/who/git/nginx-clojure.github.io/UserfullLinks.md\\")" "(render-md-file \\"/home/who/git/nginx-clojure.github.io/More.md\\")" "(render-md-file \\"/home/who/git/nginx-clojure.github.io/QuickStart.md\\")" "(render-md-file \\"/home/who/git/workflow-server/README.md\\")" " (render-md-file \\"/home/who/git/workflow-server/README.md\\")" "(render-md-file \\"/home/who/git/nginx-clojure.github.io/Configuration.md\\")" "(render-md-file  \\"/home/who/git/nginx-clojure.github.io/CoreFeatures.md\\")" " (render-md-file  \\"/home/who/git/nginx-clojure.github.io/CoreFeatures.md\\")" " (render-md-file  \\"/home/who/git/nginx-clojure.github.io/HISTORY.md\\")" "(render-md-file \\"/home/who/git/nginx-clojure.github.io/Configuration.md\\")" " (render-md-file \\"/home/who/git/nginx-clojure.github.io/Configuration.md\\")" "(render-md-file  \\"/home/who/git/nginx-clojure.github.io/CoreFeatures.md\\")" "(render-md-file \\"/home/who/git/nginx-clojure.github.io/Installation.md\\")" "(render-md-file \\"/home/who/git/nginx-clojure.github.io/QuickStart.md\\")" "(render-md-file \\"/home/who/git/nginx-clojure.github.io/More.md\\")" "(render-md-file \\"Configuration.md\\")" " (render-md-file \\"HISTORY.md\\")" "(render-md-file \\"CoreFeatures.md\\")" "(render-md-file \\"Installation.md\\")" "(render-md-file \\"More.md\\")" "(render-md-file \\"QuickStart.md\\")" "(render-md-file \\"Installation.md\\")" " (render-md-file \\"Installation.md\\")" "(doseq [f (file-seq \\".\\")]\\n  (println f))" " (doseq [f (file-seq  (clojure.java.io/file \\".\\"))]\\n     (println f))" "( render-all-updated \\".\\")" " ( render-all-updated \\".\\")" "( render-all-updated \\".\\")" " ( render-all-updated \\".\\")" "(render-md-file \\".\\")" "(render-all-updated \\".\\")" " (render-md-file \\".\\")" " (render-all-updated \\".\\")" "(render-all-updated \\".\\")" " (render-all-updated \\".\\")" "(render-all-updated \\".\\")" " (render-all-updated \\".\\")" "(render-all-updated \\".\\")" "(render-all-updated \\"/home/who/git/websocket-protocol.wiki\\")" "(def m (load-all-content))" " (def m (load-all-content))" "(count m)" "(m \\"footer\\")" "(def m (load-all-content))" "(m \\"content-template\\")" "(def m (load-all-content))" "(m \\"content-template\\")" "(man for)" "(doc for)" "(for [x (range 3)] (print x) x)" "(for [x (range 3)] (do (print x) x))" "(gen-all-updated-html)" "(use 'tool)" "(gen-all-updated-html)" "(render-all-updated)" "(gen-all-updated-html)" "(render-all-updated)" "(gen-all-updated-html)" " (gen-all-updated-html)" "(gen-all-updated-html)" " (gen-all-updated-html)" "(gen-all-updated-html)"]
 eclipse.preferences.version=1

CoreFeatures.md

@@ -1,12 +1,13 @@
 Core Features
 =================
 
-The latest release is v0.4.0, more detail changes about it can be found from [Release History](downloads.html).
+The latest release is v0.4.1, more detail changes about it can be found from [Release History](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.
 1. Nginx Access Handler by Clojure / Java / Groovy
 1. Nginx  Header Filter by Clojure / Java / Groovy
+1. **_NEW_**: APIs for Embedding Nginx-Clojure into a Standard Clojure/Java/Groovy App
 1. **_NEW_**: Server Side Websocket
 1. **_NEW_**: A build-in Jersey container to support java standard RESTful web services (JAX-RS 2.0)
 1. **_NEW_**: Tomcat 8 embedding support (so servlet 3.1/jsp/sendfile/JSR-356 websocket work within nginx!)
@@ -39,19 +40,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.4.0 , e.g.
+After adding clojars repository, you can reference nginx-clojure 0.4.1 , e.g.
 
  Leiningen (clojure, no need to add clojars repository which is a default repository for Leiningen) 
 -----------------
 
 ```clojure
-[nginx-clojure "0.4.0"]
+[nginx-clojure "0.4.1"]
 ```
 Gradle (groovy/java)
 -----------------
 
 ```
-compile "nginx-clojure:nginx-clojure:0.4.0"
+compile "nginx-clojure:nginx-clojure:0.4.1"
 ```
 Maven
 -----------------
@@ -60,13 +61,13 @@ Maven
 <dependency>
   <groupId>nginx-clojure</groupId>
   <artifactId>nginx-clojure</artifactId>
-  <version>0.4.0</version>
+  <version>0.4.1</version>
 </dependency>
 ```
 
 License
 =================
-Copyright © 2013-2014 Zhang, Yuexiang (xfeep) and released under the BSD 3-Clause license.
+Copyright © 2013-2015 Zhang, Yuexiang (xfeep) and released under the BSD 3-Clause license.
 
 This program uses:
 * Re-rooted ASM bytecode engineering library which is distributed under the BSD 3-Clause license

CoreFeatures.md.html

@@ -1,14 +1,16 @@
 <h1>
 <a id="user-content-core-features" class="anchor" href="#core-features" aria-hidden="true"><span class="octicon octicon-link"></span></a>Core Features</h1>
 
-<p>The latest release is v0.4.0, more detail changes about it can be found from <a href="downloads.html">Release History</a>.</p>
+<p>The latest release is v0.4.1, more detail changes about it can be found from <a href="downloads.html">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>
 <li>Nginx Access Handler by Clojure / Java / Groovy</li>
 <li>Nginx  Header Filter by Clojure / Java / Groovy</li>
 <li>
+<strong><em>NEW</em></strong>: APIs for Embedding Nginx-Clojure into a Standard Clojure/Java/Groovy App</li>
+<li>
 <strong><em>NEW</em></strong>: Server Side Websocket</li>
 <li>
 <strong><em>NEW</em></strong>: A build-in Jersey container to support java standard RESTful web services (JAX-RS 2.0)</li>
@@ -42,17 +44,17 @@ <h1>
   &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.4.0 , e.g.</p>
+<p>After adding clojars repository, you can reference nginx-clojure 0.4.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 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-clojure"><pre>[nginx-clojure <span class="pl-s"><span class="pl-pds">"</span>0.4.0<span class="pl-pds">"</span></span>]</pre></div>
+<div class="highlight highlight-clojure"><pre>[nginx-clojure <span class="pl-s"><span class="pl-pds">"</span>0.4.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 class="octicon octicon-link"></span></a>Gradle (groovy/java)</h2>
 
-<pre><code>compile "nginx-clojure:nginx-clojure:0.4.0"
+<pre><code>compile "nginx-clojure:nginx-clojure:0.4.1"
 </code></pre>
 
 <h2>
@@ -61,13 +63,13 @@ <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.4.0&lt;/<span class="pl-ent">version</span>&gt;
+  &lt;<span class="pl-ent">version</span>&gt;0.4.1&lt;/<span class="pl-ent">version</span>&gt;
 &lt;/<span class="pl-ent">dependency</span>&gt;</pre></div>
 
 <h1>
 <a id="user-content-license" class="anchor" href="#license" aria-hidden="true"><span class="octicon octicon-link"></span></a>License</h1>
 
-<p>Copyright © 2013-2014 Zhang, Yuexiang (xfeep) and released under the BSD 3-Clause license.</p>
+<p>Copyright © 2013-2015 Zhang, Yuexiang (xfeep) and released under the BSD 3-Clause license.</p>
 
 <p>This program uses:</p>
 

Embed.md

@@ -0,0 +1,103 @@
+# nginx-clojure-embed
+
+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.
+
+Jar Repository
+================
+
+For Clojure
+
+```clojure
+[nginx-clojure/nginx-clojure-embed "0.4.1"]
+```
+
+For Java (Maven)
+
+```xml
+<repository>
+  <id>clojars.org</id>
+  <url>http://clojars.org/repo</url>
+</repository>
+```
+
+```xml
+<dependency>
+  <groupId>nginx-clojure</groupId>
+  <artifactId>nginx-clojure-embed</artifactId>
+  <version>0.4.1</version>
+</dependency>
+```
+
+Start/Stop Embedded Server
+================
+
+For Clojure
+
+```clojure
+    ;;(1) Start it with ring handler and an options map
+    ;;my-app can be a simple ring hanler or a compojure router.
+    (run-server my-app {:port 8080})
+
+
+   ;;(2) Start it with a nginx.conf file
+    (run-server "/my-dir/nginx.conf")
+
+   ;;(3) Start it with a given work dir
+    (binding [*nginx-work-dir* my-work-dir]
+      (run-server ...))
+   
+   ;;(4) Stop the server
+    (stop-server)
+```
+
+For Java
+
+```java
+//Start it with ring handler and an options map
+NginxEmbedServer.getServer().start("my.HelloHandler", ArrayMap.create("port", "8081"));
+
+
+//Start it with with a nginx.conf file
+NginxEmbedServer.getServer().start("/my-dir/nginx.conf");
+
+//Start it with a given work dir
+NginxEmbedServer.getServer().setWorkDir(my-work-dir);
+NginxEmbedServer.getServer().start(...);
+
+
+//Stop the server
+NginxEmbedServer.getServer().stop();
+```
+
+Default Options
+================
+
+```clojure
+          "error-log", "logs/error.log",
+          "max-connections", "1024",
+          "access-log", "off",
+          "keepalive-timeout", "65",
+          "max-threads", "8",
+          "host", "0.0.0.0",
+          "port", "8080",
+```
+
+User defined zones
+
+```clojure
+          ;;;at nginx.conf top level
+          "global-user-defined", "",
+          
+          ;;;at nginx.conf http block
+          "http-user-defined", "",
+          
+          ;;at nginx.conf types mapping block
+          "types-user-defined", "",
+          
+          ;;at nginx.conf server block
+          "server-user-defined", "",
+          
+          ;;at nginx.conf location block
+          "location-user-defined", "" 
+```