0
@@ -1,72 +1,114 @@
0
 # A Web Server Called *Ebb*
0
 
0
-## Design
0
+## Intended Use
0
 
0
-The design is similar to the [Evented Mongrel][1] web server; except instead
0
-of using EventMachine (a ruby binding to libevent), the Ebb web server is written in C and uses the [libev][2] event loop library.
0
+Ebb aims to be a very small and fast web server specifically for hosting 
0
+web frameworks like Rails, Merb, and in the future Django.
0
 
0
-Connections are processed as follows:
0
+It is *not* meant to be a full featured web server like Lighttpd, Apache, or
0
+Nginx. Rather it should be used in multiplicity behind a load balancer and
0
+a front-end server. It is not meant to serve static files in production.
0
 
0
-1. libev loops and waits for incoming connections.
0
-
0
-2. When Ebb can read from a client socket, it passes the buffer into the
0
-   mongrel state machine which parses the headers into name value pairs. 
0
+## Design
0
 
0
-3. Ebb handles any file uploads
0
+The design is similar to the 
0
+[Evented Mongrel](http://swiftiply.swiftcore.org/mongrel.html) web server; 
0
+except instead of using EventMachine (a ruby binding to libevent), the Ebb 
0
+web server is written in C and uses the 
0
+[libev](http://software.schmorp.de/pkg/libev.html) event loop library.
0
 
0
-4. Ebb passes the request information and peer socket to a user
0
-   supplied callback. 
0
+Connections are processed as follows:
0
 
0
-5. The Ruby binding, ebb_ruby.c, supplying this callback transforms the
0
-   request into a Rack compatible "env" hash and passes it on a Rack
0
-   adapter.
0
+1. libev loops and waits for incoming connections.
0
+2. When Ebb receives a connection, it passes the request into the
0
+   [mongrel state machine](http://mongrel.rubyforge.org/browser/tags/rel_1-0-1/ext/http11/http11_parser.rl) 
0
+   which securely parses the headers.
0
+3. When the request is complete, Ebb passes the information to a user
0
+   supplied callback.
0
+4. The Ruby binding supplying this callback transforms the
0
+   request into a [Rack](http://rack.rubyforge.org/) compatible `env` hash 
0
+   and passes it on a Rack adapter.
0
 
0
 Because Ebb is written mostly in C, other language bindings can be added to
0
 make it useful to Non-Ruby frameworks. For example, a Python WSGI interface is
0
 forthcoming.
0
 
0
-Ebb aims to be the smallest and fastest web server possible specifically for
0
-doing the processing for web frameworks like Rails, Merb, and Django.
0
+## Download
0
+
0
+The Ruby binding is available as a Ruby Gem. It can be install simply by 
0
+executing
0
+
0
+  `gem install ebb`
0
+
0
+Ebb depends on having glib2 headers and libraries installed. (Easily available
0
+on any UNIX system.)
0
 
0
 ## Why?
0
 
0
-Why? Because by building the server in C one is able to side-step the limitations on speed of many scripting languages. Inefficiencies are okay for quick and beautiful code, but for production web servers that might handle thousands of requests a second, an attempt should be made to be as efficient as possible.
0
+Because by building the server in C one is able to side-step the 
0
+limitations on speed of many scripting languages. Inefficiencies are okay
0
+for quick and beautiful code, but for production web servers that might handle
0
+thousands of requests a second, an attempt should be made to be as efficient
0
+as possible in processing connections.
0
 
0
 ![Response Size](http://s3.amazonaws.com/four.livejournal/20080227/response_size.png)
0
 
0
+This shows how the web servers perform with respect to throughput (using a 
0
+simple Rack application). Concurrency is at 50 clients.
0
+
0
 ![Concurrency](http://s3.amazonaws.com/four.livejournal/20080227/concurrency.png)
0
 
0
+A simple concurrent clients benchmark serving a *hello world* page.
0
+
0
 ![Uploads](http://s3.amazonaws.com/four.livejournal/20080227/post_size.png)
0
 
0
-## Download
0
+Ebb processes upload before handing it over to the web application. This 
0
+allows Ebb to continue to process other clients while the upload is in 
0
+progress. The large difference here is merely because Ebb's internal request 
0
+buffer is set at 40 kilobytes before it writes to file. (Improvement can 
0
+be made here.)
0
+
0
+
0
+## Contributions
0
+
0
+
0
+Contributions (patches, criticism, advice) are very welcome! The source code
0
+it hosted at [repo.or.cz](http://repo.or.cz/w/ebb.git) can be gotten by 
0
+executing
0
+
0
+`git clone http://repo.or.cz/r/ebb.git`
0
 
0
+I intend to keep the C code base very small. Do email me before writing any
0
+large additions. Here are some features that I want to add:
0
 
0
-## TODO
0
+### Todo 
0
+* Multipart parser
0
+* Streaming responses
0
+* Optimize and clean up upload handling
0
 * Option to listen on unix sockets instead of TCP
0
 * Python binding
0
 
0
-## License
0
-
0
-Copyright (c) 2007 Ryan Dahl
0
-
0
-> Permission is hereby granted, free of charge, to any person obtaining
0
-> a copy of this software and associated documentation files (the
0
-> "Software"), to deal in the Software without restriction, including
0
-> without limitation the rights to use, copy, modify, merge, publish,
0
-> distribute, sublicense, and/or sell copies of the Software, and to
0
-> permit persons to whom the Software is furnished to do so, subject to
0
-> the following conditions:
0
-> 
0
-> The above copyright notice and this permission notice shall be
0
-> included in all copies or substantial portions of the Software.
0
-> 
0
-> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
0
-> EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
0
-> MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
0
-> NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
0
-> LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
0
-> OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
0
-> WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 
0
-
0
-  [1]: http://swiftiply.swiftcore.org/mongrel.html
0
-  [2]: http://software.schmorp.de/pkg/libev.html
0
+## (The MIT) License
0
+
0
+Copyright © 2008 [Ry Dahl](http://tinyclouds.org) (ry at tiny clouds dot org)
0
+
0
+<div id="license">
0
+Permission is hereby granted, free of charge, to any person obtaining
0
+a copy of this software and associated documentation files (the
0
+"Software"), to deal in the Software without restriction, including
0
+without limitation the rights to use, copy, modify, merge, publish,
0
+distribute, sublicense, and/or sell copies of the Software, and to
0
+permit persons to whom the Software is furnished to do so, subject to
0
+the following conditions:
0
+
0
+The above copyright notice and this permission notice shall be
0
+included in all copies or substantial portions of the Software.
0
+
0
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
0
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
0
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
0
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
0
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
0
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
0
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 
0
+</div>
0
\ No newline at end of file

0
@@ -25,7 +25,10 @@ task(:test => :compile) do
0
 end
0
 
0
 
0
-task(:generate_site => 'site/index.html')
0
+task(:site_upload => :site) do
0
+  sh 'scp -r site/* rydahl@rubyforge.org:/var/www/gforge-projects/ebb/'
0
+end
0
+task(:site => 'site/index.html')
0
 file('site/index.html' => %w{README site/style.css}) do
0
   require 'BlueCloth'
0
   
0
@@ -34,6 +37,7 @@ file('site/index.html' => %w{README site/style.css}) do
0
   <html>
0
     <head>
0
       <title>Ebb</title>
0
+      <link rel="alternate" href="http://max.kanat.us/tag-syndicate/?user=four&tag=ebb" title="RSS Feed" type="application/rss+xml" />
0
       <link type="text/css" rel="stylesheet" href="style.css" media="screen"/>
0
     </head>
0
     <body>  

0
@@ -27,7 +27,7 @@ trials = {
0
     File.open(fn, 'w+') { |f| f.write("C"*size) } unless FileTest.exists?(fn)
0
     [l, "ab -t 6 -q -c 50 -p #{fn} http://0.0.0.0:PORT/test_post_length}"]
0
   },
0
-  'concurrency' => [1,10,20,30,50,75,100].map { |c|
0
+  'concurrency' => [1,2,5,10,20,30,50,75,100].map { |c|
0
     [c, "ab -t 3 -c #{c} http://0.0.0.0:PORT/bytes/1"]
0
   }
0
 }

0
@@ -8,21 +8,30 @@ body {
0
   background: #FFF;
0
   color: #444130;
0
   font-family: Arial;
0
-  line-height: 15pt;
0
-  font-size: 11pt;
0
+  line-height: 14pt;
0
+  font-size: 12pt;
0
   margin: 0;
0
 }
0
 
0
-h1, h2, h3, h4 { color: #CBCFB6; }
0
+h1, h2, h3, h4 { 
0
+  color: #CBCFB6;
0
+  padding: 0;
0
+  margin: 1em 0;
0
+}
0
 
0
 a { color: #E4AC3D; }
0
-blockquote { font-size: 80%; }
0
+#license { 
0
+  font-size: 8pt; 
0
+  line-height: 10pt;
0
+}
0
 
0
 #content { 
0
   margin: 1em auto ;
0
   max-width: 30em;
0
 }
0
 
0
+ol, ul { padding-left: 0; }
0
+
0
 #content p {
0
 }
0
 #about {