README.md in jubilee-1.0.2 vs README.md in jubilee-1.1.0.rc1
- old
+ new
@@ -1,15 +1,16 @@
[![Build Status](https://travis-ci.org/isaiah/jubilee.png?branch=master)](https://travis-ci.org/isaiah/jubilee)
-Jubilee
+Jubilee server
=========
> "We need a web framework for Vertx.", you said.
> "But why not use Vertx in your Rails applications, it's the most productive web framework ever created."
-The Answer is Jubilee, a rack server with [vertx 2.0](http://vertx.io) awesomeness builtin.
+The Answer is Jubilee, a rack server with [vertx 2.0](http://vertx.io) awesomeness builtin. Check out the
+[demo](http://192.241.201.68:8080/) [application](https://github.com/isaiah/jubilee/tree/master/examples/chatapp).
Why another rack server?
------------------------
> "Vert.x is a lightweight, high performance application platform for the JVM
@@ -31,22 +32,23 @@
Installation
------------
$ jruby -S gem install jubilee
-Jubilee requires JRuby 1.7.0 or later, and JDK 7+
+Jubilee requires JRuby 1.7.5 or later, and JDK 7+
Get started
-----------
$ cd a-rack-app
$ jruby -S jubilee
Setup
-----
-If you use bundler, you might want to add `jubilee` to your Gemfile
+If you use bundler, you might want to add `jubilee` to your Gemfile,
+this is required if you want use rails http stream
$ jubilee
or if you prefer to use the rack handler(e.g. development) use:
@@ -90,9 +92,46 @@
```
For more advanced examples, checkout the
[chatapp](https://github.com/isaiah/jubilee/tree/master/examples/chatapp).
+Performance Tuning
+=================
+
+Improving connection time
+-------------------------
+
+If you're creating a lot of connections to a Jubilee(Vert.x) server in a short
+period of time, e.g. benchmarking with tools like [wrk](https://github.com/wg/wrk),
+you may need to tweak some settings in order to avoid the TCP accept queue
+getting full. This can result in connections being refused or packets being
+dropped during the handshake which can then cause the client to retry.
+
+A classic symptom of this is if you see long connection times just over
+3000ms at your client.
+
+How to tune this is operating system specific but in Linux you need to
+increase a couple of settings in the TCP / Net config (10000 is an
+arbitrarily large number)
+
+```shell
+sudo sysctl -w net.core.somaxconn=10000
+sudo sysctl -w net.ipv4.tcp_max_syn_backlog=10000
+```
+
+For other operating systems, please consult your operating system
+documentation.
+
License
--------
-The same as JRuby and vertx
+See [LICENSE.txt](https://github.com/isaiah/jubilee/blob/master/LICENSE.txt)
+
+Acknowledgment
+--------------
+
+YourKit is kindly supporting Jubilee Server with its full-featured Java Profiler.
+YourKit, LLC is the creator of innovative and intelligent tools for profiling
+Java and .NET applications. Take a look at YourKit's leading software products:
+[YourKit Java
+Profiler](http://www.yourkit.com/java/profiler/index.jsp) and
+[YourKit .NET Profiler](http://www.yourkit.com/.net/profiler/index.jsp).