diff options
Diffstat (limited to 'README.rdoc')
| -rw-r--r-- | README.rdoc | 125 |
1 files changed, 57 insertions, 68 deletions
diff --git a/README.rdoc b/README.rdoc index bedcda99..883380c1 100644 --- a/README.rdoc +++ b/README.rdoc @@ -1,17 +1,24 @@ -= Rack, a modular Ruby webserver interface {<img src="https://secure.travis-ci.org/rack/rack.svg" alt="Build Status" />}[http://travis-ci.org/rack/rack] {<img src="https://gemnasium.com/rack/rack.svg" alt="Dependency Status" />}[https://gemnasium.com/rack/rack] += \Rack, a modular Ruby webserver interface -Rack provides a minimal, modular, and adaptable interface for developing -web applications in Ruby. By wrapping HTTP requests and responses in +{<img src="https://rack.github.io/rack-logo.png" width="400" alt="rack powers web applications" />}[https://rack.github.io/] + +{<img src="https://circleci.com/gh/rack/rack.svg?style=svg" alt="CircleCI" />}[https://circleci.com/gh/rack/rack] +{<img src="https://badge.fury.io/rb/rack.svg" alt="Gem Version" />}[http://badge.fury.io/rb/rack] +{<img src="https://api.dependabot.com/badges/compatibility_score?dependency-name=rack&package-manager=bundler&version-scheme=semver" alt="SemVer Stability" />}[https://dependabot.com/compatibility-score.html?dependency-name=rack&package-manager=bundler&version-scheme=semver] + +\Rack 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. -The exact details of this are described in the Rack specification, -which all Rack applications should conform to. +The exact details of this are described in the \Rack specification, +which all \Rack applications should conform to. == Supported web servers -The included *handlers* connect all kinds of web servers to Rack: +The included *handlers* connect all kinds of web servers to \Rack: + * WEBrick * FCGI * CGI @@ -19,31 +26,34 @@ The included *handlers* connect all kinds of web servers to Rack: * LiteSpeed * Thin -These web servers include Rack handlers in their distributions: +These web servers include \Rack handlers in their distributions: + +* Agoo * Ebb * Fuzed * Glassfish v3 * Phusion Passenger (which is mod_rack for Apache and for nginx) * Puma * Reel -* Unicorn * unixrack * uWSGI -* yahns -Any valid Rack app will run the same on all these handlers, without +Any valid \Rack app will run the same on all these handlers, without changing anything. == Supported web frameworks -These frameworks include Rack adapters in their distributions: +These frameworks include \Rack adapters in their distributions: + * Camping * Coset * Espresso * Halcyon +* Hanami * Mack * Maveric * Merb +* Padrino * Racktools::SimpleApplication * Ramaze * Ruby on Rails @@ -51,14 +61,16 @@ These frameworks include Rack adapters in their distributions: * Sinatra * Sin * Vintage +* WABuR * Waves * Wee * ... and many others. == Available middleware -Between the server and the framework, Rack can be customized to your +Between the server and the framework, \Rack can be customized to your applications needs using middleware, for example: + * Rack::URLMap, to route to multiple applications inside the same process. * Rack::CommonLogger, for creating Apache-style logfiles. * Rack::ShowException, for catching unhandled exceptions and @@ -67,33 +79,34 @@ applications needs using middleware, for example: * ...many others! All these components use the same interface, which is described in -detail in the Rack specification. These optional components can be +detail in the \Rack specification. These optional components can be used in any way you wish. == Convenience If you want to develop outside of existing frameworks, implement your -own ones, or develop middleware, Rack provides many helpers to create -Rack applications quickly and without doing the same web stuff all +own ones, or develop middleware, \Rack provides many helpers to create +\Rack applications quickly and without doing the same web stuff all over: + * Rack::Request, which also provides query string parsing and multipart handling. * Rack::Response, for convenient generation of HTTP replies and cookie handling. * Rack::MockRequest and Rack::MockResponse for efficient and quick - testing of Rack application without real HTTP round-trips. + testing of \Rack application without real HTTP round-trips. == rack-contrib The plethora of useful middleware created the need for a project that -collects fresh Rack middleware. rack-contrib includes a variety of -add-on components for Rack and it is easy to contribute new modules. +collects fresh \Rack middleware. rack-contrib includes a variety of +add-on components for \Rack and it is easy to contribute new modules. * https://github.com/rack/rack-contrib == rackup -rackup is a useful tool for running Rack applications, which uses the +rackup is a useful tool for running \Rack applications, which uses the Rack::Builder DSL to configure middleware and build up applications easily. @@ -117,18 +130,13 @@ By default, the lobster is found at http://localhost:9292. == Installing with RubyGems -A Gem of Rack is available at rubygems.org. You can install it with: +A Gem of \Rack is available at {rubygems.org}[https://rubygems.org/gems/rack]. You can install it with: gem install rack -I also provide a local mirror of the gems (and development snapshots) -at my site: - - gem install rack --source http://chneukirchen.org/releases/gems/ - == Running the tests -Testing Rack requires the bacon testing framework: +Testing \Rack requires the bacon testing framework: bundle install --without extra # to be able to run the fast tests @@ -138,7 +146,7 @@ Or: There is a rake-based test task: - rake test tests all the tests + rake test # tests all the tests The testsuite has no dependencies outside of the core Ruby installation and bacon. @@ -159,9 +167,9 @@ Download and install lighttpd: Installing the FCGI libraries: - 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 + curl -O -k -L https://github.com/FastCGI-Archives/FastCGI.com/raw/master/original_snapshot/fcgi-2.4.1-SNAP-0910052249.tar.gz + tar xvfz fcgi-2.4.1-SNAP-0910052249.tar.gz + cd fcgi-2.4.1-SNAP-0910052249 ./configure --prefix=/usr/local make sudo make install @@ -176,7 +184,7 @@ run on port 11211) and memcache-client installed. == Configuration -Several parameters can be modified on Rack::Utils to configure Rack behaviour. +Several parameters can be modified on Rack::Utils to configure \Rack behaviour. e.g: @@ -198,27 +206,28 @@ The default is 128, which means that a single request can't upload more than 128 Set to 0 for no limit. -Can also be set via the RACK_MULTIPART_PART_LIMIT environment variable. +Can also be set via the +RACK_MULTIPART_PART_LIMIT+ environment variable. -== History +== Changelog -See <https://github.com/rack/rack/blob/master/HISTORY.md>. +See {CHANGELOG.md}[https://github.com/rack/rack/blob/master/CHANGELOG.md]. == Contact Please post bugs, suggestions and patches to -the bug tracker at <https://github.com/rack/rack/issues>. +the bug tracker at {issues}[https://github.com/rack/rack/issues]. Please post security related bugs and suggestions to the core team at -<https://groups.google.com/group/rack-core> or rack-core@googlegroups.com. This +<https://groups.google.com/forum/#!forum/rack-core> 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. Mailing list archives are available at -<https://groups.google.com/group/rack-devel>. +<https://groups.google.com/forum/#!forum/rack-devel>. Git repository (send Git patches to the mailing list): + * https://github.com/rack/rack * http://git.vuxu.org/cgi-bin/gitweb.cgi?p=rack-github.git @@ -226,9 +235,9 @@ You are also welcome to join the #rack channel on irc.freenode.net. == Thanks -The Rack Core Team, consisting of +The \Rack Core Team, consisting of -* Christian Neukirchen (chneukirchen[https://github.com/chneukirchen]) +* Leah Neukirchen (leahneukirchen[https://github.com/leahneukirchen]) * James Tucker (raggi[https://github.com/raggi]) * Josh Peek (josh[https://github.com/josh]) * José Valim (josevalim[https://github.com/josevalim]) @@ -237,7 +246,7 @@ The Rack Core Team, consisting of * Santiago Pastorino (spastorino[https://github.com/spastorino]) * Konstantin Haase (rkh[https://github.com/rkh]) -and the Rack Alumnis +and the \Rack Alumnis * Ryan Tomayko (rtomayko[https://github.com/rtomayko]) * Scytrin dai Kinthra (scytrin[https://github.com/scytrin]) @@ -269,36 +278,16 @@ would like to thank: * Alexander Kellett for testing the Gem and reviewing the announcement. * Marcus Rückert, for help with configuring and debugging lighttpd. * The WSGI team for the well-done and documented work they've done and - Rack builds up on. + \Rack builds up on. * All bug reporters and patch contributors not mentioned above. -== Copyright - -Copyright (C) 2007, 2008, 2009, 2010 Christian Neukirchen <http://purl.org/net/chneukirchen> - -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: - -The above copyright notice and this permission notice shall be included in -all copies or substantial portions of the Software. - -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. - == Links -Rack:: <http://rack.github.io/> -Official Rack repositories:: <https://github.com/rack> -Rack Bug Tracking:: <https://github.com/rack/rack/issues> -rack-devel mailing list:: <https://groups.google.com/group/rack-devel> -Rack's Rubyforge project:: <http://rubyforge.org/projects/rack> +\Rack:: <https://rack.github.io/> +Official \Rack repositories:: <https://github.com/rack> +\Rack Bug Tracking:: <https://github.com/rack/rack/issues> +rack-devel mailing list:: <https://groups.google.com/forum/#!forum/rack-devel> + +== License -Christian Neukirchen:: <http://chneukirchen.org/> +\Rack is released under the {MIT License}[https://opensource.org/licenses/MIT]. |