thin 0.3.0 → 0.4.0

data/README

@@ -1,22 +1,64 @@
 == Thin
-
 Tiny, fast & funny HTTP server
 
+Thin is a web server written entirely in Ruby in the simplest way possible.
+It does as little as possible to serve your Rails application,
+which makes it one of the fastest Rails server out there.
+
 === Installation
+For the latest stable version:
+
+ sudo gem install thin
+
+For the risky but so much cooler alpha version:
 
  sudo gem install thin --source http://code.macournoyer.com
 
-Or get the source:
+Or from source:
 
  svn co http://code.macournoyer.com/svn/thin/trunk thin
+ cd thin
+ rake install
 
 === Usage
 In your Rails app directory:
   
  thin start
 
-Get more help with the thin script at http://code.macournoyer.com/thin/doc/files/bin/thin.html 
-and with the thin_cluster script at http://code.macournoyer.com/thin/doc/files/bin/thin_cluster.html
+See http://code.macournoyer.com/thin/doc/files/bin/thin.html
+
+=== Deployment
+To deploy your Rails application using a cluster of thin servers. You can start it with:
+
+ thin_cluster start
+
+To use the Capistrano recipes, add this to your Capfile:
+
+ require 'thin'
+ require 'thin/recipes'
+
+and create a config file using:
+
+ thin_cluster config
+
+See http://code.macournoyer.com/thin/doc/files/bin/thin_cluster.html
+
+=== Security
+Thin should never be used facing the internet directly, it should always be hidden behind a
+proxy server!
+
+Thin is faster because it doesn't do a lot of things that other Ruby web servers do
+(use threads, validate the body length, be very strict about the request format, etc.)
+but that a good proxy server do very well (and a lot faster then any Ruby code could possibly do).
+So it is very important that you setup you proxy server correctly in order to secure Thin
+from potential attacks.
+
+Nginx comes with everything you need and can be used securely out of the box with thin.
+
+Apache mod_proxy is not secure because it doesn't cache the request before sending it
+to the backend, which open your server to easy DoS attacks.
+You need to install mod_accel (http://sysoev.ru/en/) to make mod_proxy behave like Nginx
+on that side.
 
 === License
 Ruby License, http://www.ruby-lang.org/en/LICENSE.txt.
@@ -32,4 +74,4 @@ Copyright (c) 2006 Francois Beausoleil <francois@teksol.info>
 
 Thin is copyright Marc-Andre Cournoyer <macournoyer@gmail.com>
 
-Please report any bug using http://code.macournoyer.com/thin/trac.fcgi/newticket
+Please report any bug at http://code.macournoyer.com/thin/trac.fcgi/newticket

data/Rakefile

@@ -64,6 +64,13 @@ namespace :gem do
     upload "pkg/#{spec.full_name}.gem", 'gems'
     sh 'ssh macournoyer@macournoyer.com "cd code.macournoyer.com && index_gem_repository.rb"'
   end
+  
+  desc 'Upload gem to rubyforge.org'
+  task :upload_rubyforge => :gem do
+    sh 'rubyforge login'
+    sh "rubyforge add_release thin thin #{Thin::VERSION::STRING} pkg/thin-#{Thin::VERSION::STRING}.gem"
+    sh "rubyforge add_file thin thin #{Thin::VERSION::STRING} pkg/thin-#{Thin::VERSION::STRING}.gem"
+  end
 end
 
 desc 'Show some stats about the code'
@@ -92,8 +99,32 @@ namespace :site do
   end
 end
 
-desc 'Upload all the stuff to code.macournoyer.com'
-task :upload => %w(gem:upload site:upload rdoc:upload)
+namespace :deploy do
+  task :site => %w(site:upload rdoc:upload)
+  
+  desc 'Deploy on code.macournoyer.com'
+  task :alpha => %w(gem:upload deploy:site)
+  
+  desc 'Deploy on rubyforge'
+  task :public => %w(gem:upload_rubyforge deploy:site)  
+end
+desc 'Deploy on all servers'
+task :deploy => %w(deploy:alpha deploy:public)
+
+task :install do
+  sh %{rake package}
+  sh %{sudo gem install pkg/#{Thin::NAME}-#{Thin::VERSION::STRING}}
+end
+
+task :uninstall => [:clean] do
+  sh %{sudo gem uninstall #{Thin::NAME}}
+end
+
+task :tag do
+  sh %Q{svn cp . http://code.macournoyer.com/svn/thin/tags/#{Thin::VERSION::STRING} -m "Tagging version #{Thin::VERSION::STRING}"}
+end
+
+# == Utilities
 
 def upload(file, to, options={})
   sh %{ssh macournoyer@macournoyer.com "rm -rf code.macournoyer.com/#{to}"} if options[:replace]

data/doc/rdoc/classes/Kernel.html

@@ -0,0 +1,182 @@
+
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+  <title>
+  thin &raquo; Module: Kernel
+  </title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
+  <script language="JavaScript" type="text/javascript">
+    // <![CDATA[
+
+    function toggleSource( id )
+    {
+    var elem
+    var link
+
+    if( document.getElementById )
+    {
+    elem = document.getElementById( id )
+    link = document.getElementById( "l_" + id )
+    }
+    else if ( document.all )
+    {
+    elem = eval( "document.all." + id )
+    link = eval( "document.all.l_" + id )
+    }
+    else
+    return false;
+
+    if( elem.style.display == "block" )
+    {
+    elem.style.display = "none"
+    link.innerHTML = "show source"
+    }
+    else
+    {
+    elem.style.display = "block"
+    link.innerHTML = "hide source"
+    }
+    }
+
+    function openCode( url )
+    {
+    window.open( url, "SOURCE_CODE", "width=400,height=400,scrollbars=yes" )
+    }
+    // ]]>
+  </script>
+</head>
+  <body>
+    <ul id="menu">
+      <li><a href="/thin/">home</a></li>
+      <li><a href="/thin/doc/">doc</a></li>
+      <li><a href="/thin/trac.fcgi/timeline">timeline</a></li>
+      <li><a href="/thin/trac.fcgi/browser">code</a></li>
+      <li><a href="/thin/trac.fcgi/report">tickets</a></li>
+      <li><a href="/thin/trac.fcgi/newticket">new ticket</a></li>
+    </ul>
+    <div id="sidebar">
+      <h2>Files</h2>
+      <ul class="list">
+        <li><a href="../files/README.html" value="File: README">README</a></li>
+        <li><a href="../files/lib/thin/cgi_rb.html" value="File: cgi.rb">lib/thin/cgi.rb</a></li>
+        <li><a href="../files/lib/thin/cluster_rb.html" value="File: cluster.rb">lib/thin/cluster.rb</a></li>
+        <li><a href="../files/lib/thin/command_rb.html" value="File: command.rb">lib/thin/command.rb</a></li>
+        <li><a href="../files/lib/thin/consts_rb.html" value="File: consts.rb">lib/thin/consts.rb</a></li>
+        <li><a href="../files/lib/thin/daemonizing_rb.html" value="File: daemonizing.rb">lib/thin/daemonizing.rb</a></li>
+        <li><a href="../files/lib/thin/handler_rb.html" value="File: handler.rb">lib/thin/handler.rb</a></li>
+        <li><a href="../files/lib/thin/headers_rb.html" value="File: headers.rb">lib/thin/headers.rb</a></li>
+        <li><a href="../files/lib/thin/logging_rb.html" value="File: logging.rb">lib/thin/logging.rb</a></li>
+        <li><a href="../files/lib/thin/mime_types_rb.html" value="File: mime_types.rb">lib/thin/mime_types.rb</a></li>
+        <li><a href="../files/lib/thin/rails_rb.html" value="File: rails.rb">lib/thin/rails.rb</a></li>
+        <li><a href="../files/lib/thin/recipes_rb.html" value="File: recipes.rb">lib/thin/recipes.rb</a></li>
+        <li><a href="../files/lib/thin/request_rb.html" value="File: request.rb">lib/thin/request.rb</a></li>
+        <li><a href="../files/lib/thin/response_rb.html" value="File: response.rb">lib/thin/response.rb</a></li>
+        <li><a href="../files/lib/thin/server_rb.html" value="File: server.rb">lib/thin/server.rb</a></li>
+        <li><a href="../files/lib/thin/statuses_rb.html" value="File: statuses.rb">lib/thin/statuses.rb</a></li>
+        <li><a href="../files/lib/thin/version_rb.html" value="File: version.rb">lib/thin/version.rb</a></li>
+        <li><a href="../files/bin/thin.html" value="File: thin">bin/thin</a></li>
+        <li><a href="../files/bin/thin_cluster.html" value="File: thin_cluster">bin/thin_cluster</a></li>
+      </ul>
+      
+      <h2>Classes</h2>
+      <ul class="list">
+        <li><a href="../classes/Thin.html" title="Module: Thin">Thin</a></li>
+        <li><a href="../classes/Thin/Commands.html" title="Module: Thin::Commands">Thin::Commands</a></li>
+        <li><a href="../classes/Thin/Daemonizable.html" title="Module: Thin::Daemonizable">Thin::Daemonizable</a></li>
+        <li><a href="../classes/Thin/Daemonizable/ClassMethods.html" title="Module: Thin::Daemonizable::ClassMethods">Thin::Daemonizable::ClassMethods</a></li>
+        <li><a href="../classes/Thin/VERSION.html" title="Module: Thin::VERSION">Thin::VERSION</a></li>
+        <li><a href="../classes/Thin/Logging.html" title="Module: Thin::Logging">Thin::Logging</a></li>
+        <li><a href="../classes/Thin/DirHandler.html" title="Class: Thin::DirHandler">Thin::DirHandler</a></li>
+        <li><a href="../classes/Thin/InvalidRequest.html" title="Class: Thin::InvalidRequest">Thin::InvalidRequest</a></li>
+        <li><a href="../classes/Thin/CGIWrapper.html" title="Class: Thin::CGIWrapper">Thin::CGIWrapper</a></li>
+        <li><a href="../classes/Thin/Command.html" title="Class: Thin::Command">Thin::Command</a></li>
+        <li><a href="../classes/Thin/Response.html" title="Class: Thin::Response">Thin::Response</a></li>
+        <li><a href="../classes/Thin/Headers.html" title="Class: Thin::Headers">Thin::Headers</a></li>
+        <li><a href="../classes/Thin/Server.html" title="Class: Thin::Server">Thin::Server</a></li>
+        <li><a href="../classes/Thin/CommandError.html" title="Class: Thin::CommandError">Thin::CommandError</a></li>
+        <li><a href="../classes/Thin/Request.html" title="Class: Thin::Request">Thin::Request</a></li>
+        <li><a href="../classes/Thin/RailsServer.html" title="Class: Thin::RailsServer">Thin::RailsServer</a></li>
+        <li><a href="../classes/Thin/Cluster.html" title="Class: Thin::Cluster">Thin::Cluster</a></li>
+        <li><a href="../classes/Thin/RailsHandler.html" title="Class: Thin::RailsHandler">Thin::RailsHandler</a></li>
+        <li><a href="../classes/Thin/Handler.html" title="Class: Thin::Handler">Thin::Handler</a></li>
+        <li><a href="../classes/Process.html" title="Module: Process">Process</a></li>
+        <li><a href="../classes/Kernel.html" title="Module: Kernel">Kernel</a></li>
+      </ul>
+    </div>
+    <div id="container">
+      <div id="header">
+        <a href="/thin/" title="Home">
+          <img id="logo" src="../logo.gif" />
+        </a>
+        <h2 id="tag_line">A fast and very simple Ruby web server</h2>
+      </div>
+    
+      <div id="content">
+        <h2>Module: Kernel</h2>
+
+  
+<div id="Kernel" class="page_shade">
+<div class="page">
+<h3>Module Kernel &lt; <a href="Handler.html">Object</a></h3>
+
+<span class="path">(in files
+<a href="../files/lib/thin/daemonizing_rb.html">lib/thin/daemonizing.rb</a>
+)</span>
+
+<p>
+Handle a request and populate a response.
+</p>
+
+
+
+
+<h4>Includes</h4>
+<ul>
+<li><a href="Logging.html">Logging</a></li>
+</ul>
+
+<h2 class="ruled">Methods</h2>
+<h4 class="ruled">
+<span class="method-type" title="Public Instance method">Public Instance</span>
+<strong><a name="M000073" href="#M000073" title="Permalink to Public Instance method: daemonize">daemonize()</a></strong>
+</h4>
+
+<p>
+Turns the current script into a daemon process that detaches from the
+console. It can be shut down with a TERM signal. Taken from ActiveSupport.
+</p>
+
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000073_source')" id="l_M000073_source">show source</a> ]</p>
+  <div id="M000073_source" class="dyn-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/thin/daemonizing.rb, line 7</span>
+ 7:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">daemonize</span>
+ 8:       <span class="ruby-identifier">exit</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">fork</span>                   <span class="ruby-comment cmt"># Parent exits, child continues.</span>
+ 9:       <span class="ruby-constant">Process</span>.<span class="ruby-identifier">setsid</span>                 <span class="ruby-comment cmt"># Become session leader.</span>
+10:       <span class="ruby-identifier">exit</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">fork</span>                   <span class="ruby-comment cmt"># Zap session leader. See [1].</span>
+11:       <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">chdir</span> <span class="ruby-value str">&quot;/&quot;</span>                  <span class="ruby-comment cmt"># Release old working directory.</span>
+12:       <span class="ruby-constant">File</span>.<span class="ruby-identifier">umask</span> <span class="ruby-value">0000</span>                <span class="ruby-comment cmt"># Ensure sensible umask. Adjust as needed.</span>
+13:       <span class="ruby-constant">STDIN</span>.<span class="ruby-identifier">reopen</span> <span class="ruby-value str">&quot;/dev/null&quot;</span>       <span class="ruby-comment cmt"># Free file descriptors and</span>
+14:       <span class="ruby-constant">STDOUT</span>.<span class="ruby-identifier">reopen</span> <span class="ruby-value str">&quot;/dev/null&quot;</span>, <span class="ruby-value str">&quot;a&quot;</span> <span class="ruby-comment cmt"># point them somewhere sensible.</span>
+15:       <span class="ruby-constant">STDERR</span>.<span class="ruby-identifier">reopen</span> <span class="ruby-constant">STDOUT</span>           <span class="ruby-comment cmt"># STDOUT/ERR should better go to a logfile.</span>
+16:       <span class="ruby-identifier">trap</span>(<span class="ruby-value str">&quot;TERM&quot;</span>) { <span class="ruby-identifier">exit</span> }
+17:     <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+
+</div>
+</div>
+
+
+      </div>
+    </div>
+    <div id="footer">
+      <hr />
+      &copy; <a href="http://macournoyer.com">Marc-Andr&eacute; Cournoyer</a>
+    </div>
+  </body>
+</html>

data/doc/rdoc/classes/Process.html

@@ -0,0 +1,175 @@
+
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+  <title>
+  thin &raquo; Module: Process
+  </title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
+  <script language="JavaScript" type="text/javascript">
+    // <![CDATA[
+
+    function toggleSource( id )
+    {
+    var elem
+    var link
+
+    if( document.getElementById )
+    {
+    elem = document.getElementById( id )
+    link = document.getElementById( "l_" + id )
+    }
+    else if ( document.all )
+    {
+    elem = eval( "document.all." + id )
+    link = eval( "document.all.l_" + id )
+    }
+    else
+    return false;
+
+    if( elem.style.display == "block" )
+    {
+    elem.style.display = "none"
+    link.innerHTML = "show source"
+    }
+    else
+    {
+    elem.style.display = "block"
+    link.innerHTML = "hide source"
+    }
+    }
+
+    function openCode( url )
+    {
+    window.open( url, "SOURCE_CODE", "width=400,height=400,scrollbars=yes" )
+    }
+    // ]]>
+  </script>
+</head>
+  <body>
+    <ul id="menu">
+      <li><a href="/thin/">home</a></li>
+      <li><a href="/thin/doc/">doc</a></li>
+      <li><a href="/thin/trac.fcgi/timeline">timeline</a></li>
+      <li><a href="/thin/trac.fcgi/browser">code</a></li>
+      <li><a href="/thin/trac.fcgi/report">tickets</a></li>
+      <li><a href="/thin/trac.fcgi/newticket">new ticket</a></li>
+    </ul>
+    <div id="sidebar">
+      <h2>Files</h2>
+      <ul class="list">
+        <li><a href="../files/README.html" value="File: README">README</a></li>
+        <li><a href="../files/lib/thin/cgi_rb.html" value="File: cgi.rb">lib/thin/cgi.rb</a></li>
+        <li><a href="../files/lib/thin/cluster_rb.html" value="File: cluster.rb">lib/thin/cluster.rb</a></li>
+        <li><a href="../files/lib/thin/command_rb.html" value="File: command.rb">lib/thin/command.rb</a></li>
+        <li><a href="../files/lib/thin/consts_rb.html" value="File: consts.rb">lib/thin/consts.rb</a></li>
+        <li><a href="../files/lib/thin/daemonizing_rb.html" value="File: daemonizing.rb">lib/thin/daemonizing.rb</a></li>
+        <li><a href="../files/lib/thin/handler_rb.html" value="File: handler.rb">lib/thin/handler.rb</a></li>
+        <li><a href="../files/lib/thin/headers_rb.html" value="File: headers.rb">lib/thin/headers.rb</a></li>
+        <li><a href="../files/lib/thin/logging_rb.html" value="File: logging.rb">lib/thin/logging.rb</a></li>
+        <li><a href="../files/lib/thin/mime_types_rb.html" value="File: mime_types.rb">lib/thin/mime_types.rb</a></li>
+        <li><a href="../files/lib/thin/rails_rb.html" value="File: rails.rb">lib/thin/rails.rb</a></li>
+        <li><a href="../files/lib/thin/recipes_rb.html" value="File: recipes.rb">lib/thin/recipes.rb</a></li>
+        <li><a href="../files/lib/thin/request_rb.html" value="File: request.rb">lib/thin/request.rb</a></li>
+        <li><a href="../files/lib/thin/response_rb.html" value="File: response.rb">lib/thin/response.rb</a></li>
+        <li><a href="../files/lib/thin/server_rb.html" value="File: server.rb">lib/thin/server.rb</a></li>
+        <li><a href="../files/lib/thin/statuses_rb.html" value="File: statuses.rb">lib/thin/statuses.rb</a></li>
+        <li><a href="../files/lib/thin/version_rb.html" value="File: version.rb">lib/thin/version.rb</a></li>
+        <li><a href="../files/bin/thin.html" value="File: thin">bin/thin</a></li>
+        <li><a href="../files/bin/thin_cluster.html" value="File: thin_cluster">bin/thin_cluster</a></li>
+      </ul>
+      
+      <h2>Classes</h2>
+      <ul class="list">
+        <li><a href="../classes/Thin.html" title="Module: Thin">Thin</a></li>
+        <li><a href="../classes/Thin/Commands.html" title="Module: Thin::Commands">Thin::Commands</a></li>
+        <li><a href="../classes/Thin/Daemonizable.html" title="Module: Thin::Daemonizable">Thin::Daemonizable</a></li>
+        <li><a href="../classes/Thin/Daemonizable/ClassMethods.html" title="Module: Thin::Daemonizable::ClassMethods">Thin::Daemonizable::ClassMethods</a></li>
+        <li><a href="../classes/Thin/VERSION.html" title="Module: Thin::VERSION">Thin::VERSION</a></li>
+        <li><a href="../classes/Thin/Logging.html" title="Module: Thin::Logging">Thin::Logging</a></li>
+        <li><a href="../classes/Thin/DirHandler.html" title="Class: Thin::DirHandler">Thin::DirHandler</a></li>
+        <li><a href="../classes/Thin/InvalidRequest.html" title="Class: Thin::InvalidRequest">Thin::InvalidRequest</a></li>
+        <li><a href="../classes/Thin/CGIWrapper.html" title="Class: Thin::CGIWrapper">Thin::CGIWrapper</a></li>
+        <li><a href="../classes/Thin/Command.html" title="Class: Thin::Command">Thin::Command</a></li>
+        <li><a href="../classes/Thin/Response.html" title="Class: Thin::Response">Thin::Response</a></li>
+        <li><a href="../classes/Thin/Headers.html" title="Class: Thin::Headers">Thin::Headers</a></li>
+        <li><a href="../classes/Thin/Server.html" title="Class: Thin::Server">Thin::Server</a></li>
+        <li><a href="../classes/Thin/CommandError.html" title="Class: Thin::CommandError">Thin::CommandError</a></li>
+        <li><a href="../classes/Thin/Request.html" title="Class: Thin::Request">Thin::Request</a></li>
+        <li><a href="../classes/Thin/RailsServer.html" title="Class: Thin::RailsServer">Thin::RailsServer</a></li>
+        <li><a href="../classes/Thin/Cluster.html" title="Class: Thin::Cluster">Thin::Cluster</a></li>
+        <li><a href="../classes/Thin/RailsHandler.html" title="Class: Thin::RailsHandler">Thin::RailsHandler</a></li>
+        <li><a href="../classes/Thin/Handler.html" title="Class: Thin::Handler">Thin::Handler</a></li>
+        <li><a href="../classes/Process.html" title="Module: Process">Process</a></li>
+        <li><a href="../classes/Kernel.html" title="Module: Kernel">Kernel</a></li>
+      </ul>
+    </div>
+    <div id="container">
+      <div id="header">
+        <a href="/thin/" title="Home">
+          <img id="logo" src="../logo.gif" />
+        </a>
+        <h2 id="tag_line">A fast and very simple Ruby web server</h2>
+      </div>
+    
+      <div id="content">
+        <h2>Module: Process</h2>
+
+  
+<div id="Process" class="page_shade">
+<div class="page">
+<h3>Module Process &lt; <a href="Handler.html">Object</a></h3>
+
+<span class="path">(in files
+<a href="../files/lib/thin/daemonizing_rb.html">lib/thin/daemonizing.rb</a>
+)</span>
+
+<p>
+Handle a request and populate a response.
+</p>
+
+
+
+
+<h4>Includes</h4>
+<ul>
+<li><a href="Logging.html">Logging</a></li>
+</ul>
+
+<h2 class="ruled">Methods</h2>
+<h4 class="ruled">
+<span class="method-type" title="Public Instance method">Public Instance</span>
+<strong><a name="M000072" href="#M000072" title="Permalink to Public Instance method: running?">running?(pid)</a></strong>
+</h4>
+
+<p>
+Returns <tt>true</tt> the process identied by <tt>pid</tt> is running.
+</p>
+
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('M000072_source')" id="l_M000072_source">show source</a> ]</p>
+  <div id="M000072_source" class="dyn-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/thin/daemonizing.rb, line 23</span>
+23:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">running?</span>(<span class="ruby-identifier">pid</span>)
+24:     <span class="ruby-constant">Process</span>.<span class="ruby-identifier">getpgid</span>(<span class="ruby-identifier">pid</span>) <span class="ruby-operator">!=</span> <span class="ruby-value">-1</span>
+25:   <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">ESRCH</span>
+26:     <span class="ruby-keyword kw">false</span>
+27:   <span class="ruby-keyword kw">end</span>
+</pre>
+  </div>
+</div>
+
+</div>
+</div>
+
+
+      </div>
+    </div>
+    <div id="footer">
+      <hr />
+      &copy; <a href="http://macournoyer.com">Marc-Andr&eacute; Cournoyer</a>
+    </div>
+  </body>
+</html>