update README: add instructions about how to avoid OOM exception

isaiah · Jul 22, 2014 · 9b2b23a · 9b2b23a
1 parent 1cf4235
commit 9b2b23a
Show file tree

Hide file tree

Showing 7 changed files with 27 additions and 11 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -1,6 +1,5 @@
 language: ruby
 rvm:
   - jruby-19mode
-  - jruby-head
 
 script: "bundle exec rake test spec"
diff --git a/CHANGELOG b/CHANGELOG
@@ -1,3 +1,12 @@
+Release 2.1.0
+=============
+
+#4 rack.hijack support
+
+Release 2.0.0
+=============
+support multiple instances of web servers
+
 Release 1.1.1
 =============
 

diff --git a/README.md b/README.md
@@ -55,7 +55,21 @@ Setup
 If you use bundler, you might want to add `jubilee` to your Gemfile,
 this is also required if you want use rails http streaming,
 
-    $ jubilee
+    gem 'jubilee', '~> 2.0.0'
+
+Rails
+-----
+
+Under the default configuration, jubilee runs 4 instances of web
+servers, each with it's own jruby runtime, if you find that jubilee
+crashes or hangs with OutOfMemeoryError, please tune your JVM OPTS
+like this:
+
+    $ export JAVA_OPTS="-Xms1024m -Xmx2048m -XX:PermSize=512m -XX:MaxPermSize=512m"
+
+If your OS memory is quite limited, please run jubilee with
+
+    $ jubilee -n 1
 
 Event Bus
 =========

diff --git a/java/src/org/jruby/jubilee/Const.java b/java/src/org/jruby/jubilee/Const.java
@@ -8,7 +8,7 @@
  */
 public final class Const {
 
-    public static final String JUBILEE_VERSION = "Jubilee(2.0.0)";
+    public static final String JUBILEE_VERSION = "Jubilee(2.1.0)";
     public static final String HTTP_11 = "HTTP/1.1";
     public static final String HTTP_10 = "HTTP/1.0";
 

diff --git a/lib/jubilee/cli.rb b/lib/jubilee/cli.rb
@@ -86,7 +86,7 @@ def setup_options
         o.on "-e", "--environment ENV", "Rack environment" do |arg|
           @options[:environment] = arg
         end
-        o.on "-n", "--instances NUM", "Define how many instances of web servers to run" do |arg|
+        o.on "-n", "--instances NUM", "Define how many instances of web servers to run, default 4" do |arg|
           @options[:instances] = arg.to_i
         end
         o.separator ""

diff --git a/spec/apps/rails4/basic/Gemfile.lock b/spec/apps/rails4/basic/Gemfile.lock
@@ -40,7 +40,6 @@ GEM
     coffee-script-source (1.6.3)
     erubis (2.7.0)
     execjs (2.0.2)
-    ffi (1.9.3-java)
     hike (1.2.3)
     i18n (0.6.9)
     jbuilder (1.5.3)
@@ -52,9 +51,6 @@ GEM
       thor (>= 0.14, < 2.0)
     json (1.8.1)
     json (1.8.1-java)
-    jubilee (2.0.0-java)
-      rack (>= 1.4.1)
-      spoon (~> 0.0.4)
     mail (2.5.4)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
@@ -84,8 +80,6 @@ GEM
       railties (>= 4.0.0, < 5.0)
       sass (>= 3.1.10)
       sprockets-rails (~> 2.0.0)
-    spoon (0.0.4)
-      ffi
     sprockets (2.10.1)
       hike (~> 1.2)
       multi_json (~> 1.0)
@@ -123,7 +117,6 @@ DEPENDENCIES
   jbuilder (~> 1.2)
   jdbc-sqlite3
   jquery-rails (>= 3.0)
-  jubilee
   rails (= 4.0.1)
   sass-rails (~> 4.0.0)
   therubyrhino

diff --git a/test/jubilee/test_upload.rb b/test/jubilee/test_upload.rb
@@ -212,5 +212,6 @@ def start_server
     q = Queue.new
     @server.start{ q << 1 }
     q.pop
+    sleep 0.1
   end
 end