| Dir : /proc/self/root/opt/alt/ruby18/lib64/ruby/gems/1.8/doc/rack-1.6.1/rdoc/files/ |
| Server: Linux ngx353.inmotionhosting.com 4.18.0-553.22.1.lve.1.el8.x86_64 #1 SMP Tue Oct 8 15:52:54 UTC 2024 x86_64 IP: 209.182.202.254 |
| Dir : //proc/self/root/opt/alt/ruby18/lib64/ruby/gems/1.8/doc/rack-1.6.1/rdoc/files/README_rdoc.html |
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>File: README.rdoc</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<meta http-equiv="Content-Script-Type" content="text/javascript" />
<link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
<script type="text/javascript">
// <![CDATA[
function popupCode( url ) {
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
}
function toggleCode( id ) {
if ( document.getElementById )
elem = document.getElementById( id );
else if ( document.all )
elem = eval( "document.all." + id );
else
return false;
elemStyle = elem.style;
if ( elemStyle.display != "block" ) {
elemStyle.display = "block"
} else {
elemStyle.display = "none"
}
return true;
}
// Make codeblocks hidden by default
document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
// ]]>
</script>
</head>
<body>
<div id="fileHeader">
<h1>README.rdoc</h1>
<table class="header-table">
<tr class="top-aligned-row">
<td><strong>Path:</strong></td>
<td>README.rdoc
</td>
</tr>
<tr class="top-aligned-row">
<td><strong>Last Update:</strong></td>
<td>Thu Dec 05 17:13:57 -0500 2019</td>
</tr>
</table>
</div>
<!-- banner header -->
<div id="bodyContent">
<div id="contextContent">
<div id="description">
<h1><a href="../classes/Rack.html">Rack</a>, a modular Ruby webserver interface <a href="http://travis-ci.org/rack/rack"><img src="https://secure.travis-ci.org/rack/rack.svg" alt="Build Status" /></a> <a href="https://gemnasium.com/rack/rack"><img src="https://gemnasium.com/rack/rack.svg" alt="Dependency Status" /></a></h1>
<p>
<a href="../classes/Rack.html">Rack</a> provides a minimal, modular and
adaptable interface for developing web applications in Ruby. By wrapping
HTTP requests and responses in the simplest way possible, it unifies and
distills the API for web servers, web frameworks, and software in between
(the so-called middleware) into a single method call.
</p>
<p>
The exact details of this are described in the <a
href="../classes/Rack.html">Rack</a> specification, which all <a
href="../classes/Rack.html">Rack</a> applications should conform to.
</p>
<h2>Supported web servers</h2>
<p>
The included <b>handlers</b> connect all kinds of web servers to <a
href="../classes/Rack.html">Rack</a>:
</p>
<ul>
<li>Mongrel
</li>
<li>EventedMongrel
</li>
<li>SwiftipliedMongrel
</li>
<li><a href="../classes/WEBrick.html">WEBrick</a>
</li>
<li><a href="../classes/FCGI.html">FCGI</a>
</li>
<li>CGI
</li>
<li>SCGI
</li>
<li>LiteSpeed
</li>
<li>Thin
</li>
</ul>
<p>
These web servers include <a href="../classes/Rack.html">Rack</a> handlers
in their distributions:
</p>
<ul>
<li>Ebb
</li>
<li>Fuzed
</li>
<li>Glassfish v3
</li>
<li>Phusion Passenger (which is mod_rack for Apache and for nginx)
</li>
<li>Puma
</li>
<li>Rainbows!
</li>
<li>Reel
</li>
<li>Unicorn
</li>
<li>unixrack
</li>
<li>uWSGI
</li>
<li>yahns
</li>
<li>Zbatery
</li>
</ul>
<p>
Any valid <a href="../classes/Rack.html">Rack</a> app will run the same on
all these handlers, without changing anything.
</p>
<h2>Supported web frameworks</h2>
<p>
These frameworks include <a href="../classes/Rack.html">Rack</a> adapters
in their distributions:
</p>
<ul>
<li>Camping
</li>
<li>Coset
</li>
<li>Espresso
</li>
<li>Halcyon
</li>
<li>Mack
</li>
<li>Maveric
</li>
<li>Merb
</li>
<li>Racktools::SimpleApplication
</li>
<li>Ramaze
</li>
<li>Ruby on Rails
</li>
<li>Rum
</li>
<li>Sinatra
</li>
<li>Sin
</li>
<li>Vintage
</li>
<li>Waves
</li>
<li>Wee
</li>
<li>… and many others.
</li>
</ul>
<h2>Available middleware</h2>
<p>
Between the server and the framework, <a
href="../classes/Rack.html">Rack</a> can be customized to your applications
needs using middleware, for example:
</p>
<ul>
<li><a href="../classes/Rack/URLMap.html">Rack::URLMap</a>, to route to
multiple applications inside the same process.
</li>
<li><a href="../classes/Rack/CommonLogger.html">Rack::CommonLogger</a>, for
creating Apache-style logfiles.
</li>
<li>Rack::ShowException, for catching unhandled exceptions and presenting them
in a nice and helpful way with clickable backtrace.
</li>
<li><a href="../classes/Rack/File.html">Rack::File</a>, for serving static
files.
</li>
<li>…many others!
</li>
</ul>
<p>
All these components use the same interface, which is described in detail
in the <a href="../classes/Rack.html">Rack</a> specification. These
optional components can be used in any way you wish.
</p>
<h2>Convenience</h2>
<p>
If you want to develop outside of existing frameworks, implement your own
ones, or develop middleware, <a href="../classes/Rack.html">Rack</a>
provides many helpers to create <a href="../classes/Rack.html">Rack</a>
applications quickly and without doing the same web stuff all over:
</p>
<ul>
<li><a href="../classes/Rack/Request.html">Rack::Request</a>, which also
provides query string parsing and multipart handling.
</li>
<li><a href="../classes/Rack/Response.html">Rack::Response</a>, for convenient
generation of HTTP replies and cookie handling.
</li>
<li><a href="../classes/Rack/MockRequest.html">Rack::MockRequest</a> and <a
href="../classes/Rack/MockResponse.html">Rack::MockResponse</a> for
efficient and quick testing of <a href="../classes/Rack.html">Rack</a>
application without real HTTP round-trips.
</li>
</ul>
<h2>rack-contrib</h2>
<p>
The plethora of useful middleware created the need for a project that
collects fresh <a href="../classes/Rack.html">Rack</a> middleware.
rack-contrib includes a variety of add-on components for <a
href="../classes/Rack.html">Rack</a> and it is easy to contribute new
modules.
</p>
<ul>
<li><a
href="https://github.com/rack/rack-contrib">github.com/rack/rack-contrib</a>
</li>
</ul>
<h2>rackup</h2>
<p>
rackup is a useful tool for running <a href="../classes/Rack.html">Rack</a>
applications, which uses the <a
href="../classes/Rack/Builder.html">Rack::Builder</a> DSL to configure
middleware and build up applications easily.
</p>
<p>
rackup automatically figures out the environment it is run in, and runs
your application as FastCGI, CGI, or standalone with Mongrel or <a
href="../classes/WEBrick.html">WEBrick</a>—all from the same
configuration.
</p>
<h2>Quick start</h2>
<p>
Try the lobster!
</p>
<p>
Either with the embedded <a href="../classes/WEBrick.html">WEBrick</a>
starter:
</p>
<pre>
ruby -Ilib lib/rack/lobster.rb
</pre>
<p>
Or with rackup:
</p>
<pre>
bin/rackup -Ilib example/lobster.ru
</pre>
<p>
By default, the lobster is found at <a
href="http://localhost:9292">localhost:9292</a>.
</p>
<h2>Installing with RubyGems</h2>
<p>
A Gem of <a href="../classes/Rack.html">Rack</a> is available at
rubygems.org. You can install it with:
</p>
<pre>
gem install rack
</pre>
<p>
I also provide a local mirror of the gems (and development snapshots) at my
site:
</p>
<pre>
gem install rack --source http://chneukirchen.org/releases/gems/
</pre>
<h2>Running the tests</h2>
<p>
Testing <a href="../classes/Rack.html">Rack</a> requires the bacon testing
framework:
</p>
<pre>
bundle install --without extra # to be able to run the fast tests
</pre>
<p>
Or:
</p>
<pre>
bundle install # this assumes that you have installed native extensions!
</pre>
<p>
There are two rake-based test tasks:
</p>
<pre>
rake test tests all the fast tests (no Handlers or Adapters)
rake fulltest runs all the tests
</pre>
<p>
The fast testsuite has no dependencies outside of the core Ruby
installation and bacon.
</p>
<p>
To run the test suite completely, you need:
</p>
<pre>
* fcgi
* memcache-client
* mongrel
* thin
</pre>
<p>
The full set of tests test <a href="../classes/FCGI.html">FCGI</a> access
with lighttpd (on port 9203) so you will need lighttpd installed as well as
the <a href="../classes/FCGI.html">FCGI</a> libraries and the fcgi gem:
</p>
<p>
Download and install lighttpd:
</p>
<pre>
http://www.lighttpd.net/download
</pre>
<p>
Installing the <a href="../classes/FCGI.html">FCGI</a> libraries:
</p>
<pre>
curl -O http://www.fastcgi.com/dist/fcgi-2.4.0.tar.gz
tar xzvf fcgi-2.4.0.tar.gz
cd fcgi-2.4.0
./configure --prefix=/usr/local
make
sudo make install
cd ..
</pre>
<p>
Installing the Ruby fcgi gem:
</p>
<pre>
gem install fcgi
</pre>
<p>
Furthermore, to test Memcache sessions, you need memcached (will be run on
port 11211) and memcache-client installed.
</p>
<h2>Configuration</h2>
<p>
Several parameters can be modified on <a
href="../classes/Rack/Utils.html">Rack::Utils</a> to configure <a
href="../classes/Rack.html">Rack</a> behaviour.
</p>
<p>
e.g:
</p>
<pre>
Rack::Utils.key_space_limit = 128
</pre>
<h3>key_space_limit</h3>
<p>
The default number of bytes to allow a single parameter key to take up.
This helps prevent a rogue client from flooding a Request.
</p>
<p>
Default to 65536 characters (4 kiB in worst case).
</p>
<h3>multipart_part_limit</h3>
<p>
The maximum number of parts a request can contain. Accepting too many part
can lead to the server running out of file handles.
</p>
<p>
The default is 128, which means that a single request can‘t upload
more than 128 files at once.
</p>
<p>
Set to 0 for no limit.
</p>
<p>
Can also be set via the RACK_MULTIPART_PART_LIMIT environment variable.
</p>
<h2>History</h2>
<p>
See <<a
href="https://github.com/rack/HISTORY.md">github.com/rack/HISTORY.md</a>>.
</p>
<h2>Contact</h2>
<p>
Please post bugs, suggestions and patches to the bug tracker at <<a
href="https://github.com/rack/rack/issues">github.com/rack/rack/issues</a>>.
</p>
<p>
Please post security related bugs and suggestions to the core team at
<<a
href="https://groups.google.com/group/rack-core">groups.google.com/group/rack-core</a>>
or rack-core@googlegroups.com. This list is not public. Due to wide usage
of the library, it is strongly preferred that we manage timing in order to
provide viable patches at the time of disclosure. Your assistance in this
matter is greatly appreciated.
</p>
<p>
Mailing list archives are available at <<a
href="https://groups.google.com/group/rack-devel">groups.google.com/group/rack-devel</a>>.
</p>
<p>
Git repository (send Git patches to the mailing list):
</p>
<ul>
<li><a href="https://github.com/rack/rack">github.com/rack/rack</a>
</li>
<li><a
href="http://git.vuxu.org/cgi-bin/gitweb.cgi?p=rack-github.git">git.vuxu.org/cgi-bin/gitweb.cgi?p=rack-github.git</a>
</li>
</ul>
<p>
You are also welcome to join the rack channel on irc.freenode.net.
</p>
<h2>Thanks</h2>
<p>
The <a href="../classes/Rack.html">Rack</a> Core Team, consisting of
</p>
<ul>
<li>Christian Neukirchen (chneukirchen)
</li>
<li>James Tucker (raggi)
</li>
<li>Josh Peek (josh)
</li>
<li>José Valim (josevalim)
</li>
<li>Michael Fellinger (manveru)
</li>
<li>Aaron Patterson (tenderlove)
</li>
<li>Santiago Pastorino (spastorino)
</li>
<li>Konstantin Haase (rkh)
</li>
</ul>
<p>
and the <a href="../classes/Rack.html">Rack</a> Alumnis
</p>
<ul>
<li>Ryan Tomayko (rtomayko)
</li>
<li>Scytrin dai Kinthra (scytrin)
</li>
</ul>
<p>
would like to thank:
</p>
<ul>
<li>Adrian Madrid, for the LiteSpeed handler.
</li>
<li>Christoffer Sawicki, for the first Rails adapter and <a
href="../classes/Rack/Deflater.html">Rack::Deflater</a>.
</li>
<li>Tim Fletcher, for the HTTP authentication code.
</li>
<li>Luc Heinrich for the Cookie sessions, the static file handler and bugfixes.
</li>
<li>Armin Ronacher, for the logo and racktools.
</li>
<li>Alex Beregszaszi, Alexander Kahn, Anil Wadghule, Aredridel, Ben Alpert, Dan
Kubb, Daniel Roethlisberger, Matt Todd, Tom Robinson, Phil Hagelberg, S.
Brent Faulkner, Bosko Milekic, Daniel RodrÃguez Troitiño, Genki Takiuchi,
Geoffrey Grosenbach, Julien Sanchez, Kamal Fariz Mahyuddin, Masayoshi
Takahashi, Patrick Aljordm, Mig, Kazuhiro Nishiyama, Jon Bardin, Konstantin
Haase, Larry Siden, Matias Korhonen, Sam Ruby, Simon Chiang, Tim Connor,
Timur Batyrshin, and Zach Brock for bug fixing and other improvements.
</li>
<li>Eric Wong, Hongli Lai, Jeremy Kemper for their continuous support and API
improvements.
</li>
<li>Yehuda Katz and Carl Lerche for refactoring rackup.
</li>
<li>Brian Candler, for <a
href="../classes/Rack/ContentType.html">Rack::ContentType</a>.
</li>
<li>Graham Batty, for improved handler loading.
</li>
<li>Stephen Bannasch, for bug reports and documentation.
</li>
<li>Gary Wright, for proposing a better <a
href="../classes/Rack/Response.html">Rack::Response</a> interface.
</li>
<li>Jonathan Buch, for improvements regarding <a
href="../classes/Rack/Response.html">Rack::Response</a>.
</li>
<li>Armin Röhrl, for tracking down bugs in the Cookie generator.
</li>
<li>Alexander Kellett for testing the Gem and reviewing the announcement.
</li>
<li>Marcus Rückert, for help with configuring and debugging lighttpd.
</li>
<li>The WSGI team for the well-done and documented work they‘ve done and
<a href="../classes/Rack.html">Rack</a> builds up on.
</li>
<li>All bug reporters and patch contributors not mentioned above.
</li>
</ul>
<h2>Copyright</h2>
<p>
Copyright (C) 2007, 2008, 2009, 2010 Christian Neukirchen <<a
href="http://purl.org/net/chneukirchen">purl.org/net/chneukirchen</a>>
</p>
<p>
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction,
including without limitation the rights to use, copy, modify, merge,
publish, distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to the
following conditions:
</p>
<p>
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
</p>
<p>
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
</p>
<h2>Links</h2>
<table>
<tr><td valign="top"><a href="../classes/Rack.html">Rack</a>:</td><td><<a href="http://rack.github.io">rack.github.io</a>/>
</td></tr>
<tr><td valign="top">Official <a href="../classes/Rack.html">Rack</a> repositories:</td><td><<a href="https://github.com/rack">github.com/rack</a>>
</td></tr>
<tr><td valign="top"><a href="../classes/Rack.html">Rack</a> Bug Tracking:</td><td><<a
href="https://github.com/rack/rack/issues">github.com/rack/rack/issues</a>>
</td></tr>
<tr><td valign="top">rack-devel mailing list:</td><td><<a
href="https://groups.google.com/group/rack-devel">groups.google.com/group/rack-devel</a>>
</td></tr>
<tr><td valign="top"><a href="../classes/Rack.html">Rack</a>‘s Rubyforge project:</td><td><<a
href="http://rubyforge.org/projects/rack">rubyforge.org/projects/rack</a>>
</td></tr>
<tr><td valign="top">Christian Neukirchen:</td><td><<a href="http://chneukirchen.org">chneukirchen.org</a>/>
</td></tr>
</table>
</div>
</div>
</div>
<!-- if includes -->
<div id="section">
<!-- if method_list -->
</div>
<div id="validator-badges">
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>
</body>
</html>