WEBrick

WEBrick

Original author(s)	Masayoshi Takahashi and Yuuzou Gotou and et al.
Developer(s)	Ruby Community
Stable release	1.9.1 / 2 December 2024 (2 December 2024)
Repository	github.com/ruby/webrick
Written in	Ruby
Operating system	Cross-platform
Available in	Ruby
Type	Web Server
License	2-Clause BSD License
Website	www.ruby-lang.org/en/

WEBrick is a Ruby library providing simple HTTP web servers. It uses basic access authentication and digest access authentication for different kinds of servers that it can create - HTTP based server, HTTPS server, proxy server and virtual-host server. Construction of several non-HTTP servers such as the Day Time Server which uses the Daytime Protocol rather than the HTTP is also facilitated by WEBrick. It is used by the Ruby on Rails and Padrino frameworks to test applications in a development environment as well as production mode for small loads. It is now a part of Ruby standard library.

WEBrick follows open-source distribution model.

History

WEBrick has originated from an idea in an article named "Internet Programming with Ruby" in Open Design, a Japanese Engineering magazine. It was initially developed as a toolkit for the development of HTTP servers using Ruby. Due to the nature of open source model and contributions from several Ruby developers across the world, WEBrick was greatly augmented and was eventually bundled as a standard library from Ruby 1.8.0. The WEBrick ERB Handler and WEBrick Proxy Server were first introduced in Ruby 1.9.3, while the WEBrick Virtual Host was included from Ruby 2.0.0.

Usage

A WEBrick server understands only the language of servlets. It uses multiple independent servlets, joined together by the programmer, for handling CGI scripts, ERB pages, Ruby Blocks and directory listings to provide a web application or to service a request URI on a per-host or per-path basis. For example, HTTPServlet::FileHandler, HTTPServlet::ProcHandler, HTTPServlet::CGIHandler, HTTPServlet::ERBHandler are the examples of the standard servlets that WEBrick comes with.

WEBrick is included in Ruby and hence is available to the user at no additional cost. WEBrick has been written completely in Ruby and supports several standards such as HTTP, HTML and even RHTML. During the development stage, there is no necessity for the installation of a discrete web server since WEBrick is already built into the Rails framework. It is the default web server when the Ruby application is deployed without any procfile on Rails. Furthermore, since being implemented entirely in Ruby, direct calls can be made from WEBrick to the Rails application. On the whole, it provides a reliable, low configuration option for testing in development.

Instantiating servers

Instantiating an HTTP server

The following commands are used to start an HTTP Server at the required port.

# Include WEBrick class with require
require 'webrick'

# FileHandler servlet provides the option to choose which files from user to serve
# The following code shows how to serve them from the folder 'myapp'
root = File.expand_path '/var/myapp/'

# Instantiating a new server with HTTPServer.new on port 1234 serving the documents from root folder
server = WEBrick::HTTPServer.new :Port => 1234, :DocumentRoot => root

# The following proc is used to customize the server operations
server.mount_proc '/' do |request, response|
  response.body = 'Hello, world!'
end

# The following command will provide a hook to shut down the server (often done with Ctrl+C)
trap('INT') {server.shutdown}

# Start the server
server.start

Servlets can be mounted to provide advanced custom behavior as compared to a proc, to increase the modularity.

Starting a virtual host

WEBrick creates a listening port. Various other ports as ‘virtual hosts’ can also be created at the same time which do not listen as shown below:

#Creating a virtual host that doesn't listen
vhost = WEBrick::HTTPServer.new :ServerName => 'vhost.example',
                                :DoNotListen => true, # ...

# Mounting the virtual host created above similar to the way HTTP server was mounted
vhost.mount '/', ...

# This host, when mounted to the listening server host, will now act as a virtual host
server.virtual_host vhost

:DocumentRoot should be provided or an instance of a servlet should be set up to service a request URI; otherwise a 404 error will be returned.

Instantiating an HTTPS server

By just enabling SSL and providing an SSL certificate name, an HTTPS server can be initiated with a self-signed certificate that changes with every restart of the server.

# In addition to webrick, we will require webrick/https too for SSL functionalities
require 'webrick'
require 'webrick/https'

# Providing certificate name. This, however, will be a self-generated self-signed certificate
cert_name = [%w[CN localhost],]

# Enabling SSL and providing the certificate name will instantiate HTTPS server
server = WEBrick::HTTPServer.new(:Port => 1234,
                                 :SSLEnable => true,
                                 :SSLCertName => cert_name)

However, a pre-determined key and certificate can also be provided for instantiating HTTPS Server as shown below:

# In addition to the above two, we'll need openssl to read SSL certificates and keys
require 'openssl'

# Read the saved certificate and its signature key from the local directory
cert = OpenSSL::X509::Certificate.new File.read '/var/myapp/cert.pem'
pkey = OpenSSL::PKey::RSA.new File.read '/var/myapp/pkey.pem'

# Pass the certificate and the key as separate parameters while instantiating with HTTPServer.new
server = WEBrick::HTTPServer.new(:Port => 1234,
                                 :SSLEnable => true,
                                 :SSLCertificate => cert,
                                 :SSLPrivateKey => pkey)

Starting a proxy server

WEBrick can also proxy GET, HEAD and POST requests:

# Instantiating a proxy server is similar, except that it is handled by HTTPProxyServer servlet
require 'webrick/httpproxy'
proxy = WEBrick::HTTPProxyServer.new :Port => 1234

# Providing the hook out from the current thread
trap 'INT' do proxy.shutdown end

Limitations

Unlike most of the servers that are used in production, WEBrick is not scalable since it is a single threaded web server by default. Hence, multiple requests at the same time cannot be handled and the subsequent requests would have to wait till all the previous requests have been handled, incurring a large delay. Hence, developers prefer other multi-threaded full-fledged web servers like Lighttpd and Mongrel for deploying their Rails applications.

See also

• Mongrel (web server)
• Apache
• nginx
• Lighttpd

External links

• Gnome's Guide to WEBrick
• Ruby Standard Library doc - WEBrick
• WEBrick High Performance