RubyGems - webroar - Versions diffs - 0.2.2 - Mend

webroar 0.2.2

Files changed (1988) hide show

data/doc/user-guide.html ADDED Viewed

@@ -0,0 +1,912 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
+    "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+<meta name="generator" content="AsciiDoc 8.2.6" />
+<style type="text/css">
+/* Debug borders */
+p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
+/*
+  border: 1px solid red;
+*/
+}
+body {
+  margin: 1em 5% 1em 5%;
+}
+a {
+  color: blue;
+  text-decoration: underline;
+}
+a:visited {
+  color: fuchsia;
+}
+em {
+  font-style: italic;
+  color: navy;
+}
+strong {
+  font-weight: bold;
+  color: #083194;
+}
+tt {
+  color: navy;
+}
+h1, h2, h3, h4, h5, h6 {
+  color: #527bbd;
+  font-family: sans-serif;
+  margin-top: 1.2em;
+  margin-bottom: 0.5em;
+  line-height: 1.3;
+}
+h1, h2, h3 {
+  border-bottom: 2px solid silver;
+}
+h2 {
+  padding-top: 0.5em;
+}
+h3 {
+  float: left;
+}
+h3 + * {
+  clear: left;
+}
+div.sectionbody {
+  font-family: serif;
+  margin-left: 0;
+}
+hr {
+  border: 1px solid silver;
+}
+p {
+  margin-top: 0.5em;
+  margin-bottom: 0.5em;
+}
+ul, ol, li > p {
+  margin-top: 0;
+}
+pre {
+  padding: 0;
+  margin: 0;
+}
+span#author {
+  color: #527bbd;
+  font-family: sans-serif;
+  font-weight: bold;
+  font-size: 1.1em;
+}
+span#email {
+}
+span#revision {
+  font-family: sans-serif;
+}
+div#footer {
+  font-family: sans-serif;
+  font-size: small;
+  border-top: 2px solid silver;
+  padding-top: 0.5em;
+  margin-top: 4.0em;
+}
+div#footer-text {
+  float: left;
+  padding-bottom: 0.5em;
+}
+div#footer-badges {
+  float: right;
+  padding-bottom: 0.5em;
+}
+div#preamble,
+div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
+div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
+div.admonitionblock {
+  margin-right: 10%;
+  margin-top: 1.5em;
+  margin-bottom: 1.5em;
+}
+div.admonitionblock {
+  margin-top: 2.5em;
+  margin-bottom: 2.5em;
+}
+div.content { /* Block element content. */
+  padding: 0;
+}
+/* Block element titles. */
+div.title, caption.title {
+  color: #527bbd;
+  font-family: sans-serif;
+  font-weight: bold;
+  text-align: left;
+  margin-top: 1.0em;
+  margin-bottom: 0.5em;
+}
+div.title + * {
+  margin-top: 0;
+}
+td div.title:first-child {
+  margin-top: 0.0em;
+}
+div.content div.title:first-child {
+  margin-top: 0.0em;
+}
+div.content + div.title {
+  margin-top: 0.0em;
+}
+div.sidebarblock > div.content {
+  background: #ffffee;
+  border: 1px solid silver;
+  padding: 0.5em;
+}
+div.listingblock {
+  margin-right: 0%;
+}
+div.listingblock > div.content {
+  border: 1px solid silver;
+  background: #f4f4f4;
+  padding: 0.5em;
+}
+div.quoteblock > div.content {
+  padding-left: 2.0em;
+}
+div.attribution {
+  text-align: right;
+}
+div.verseblock + div.attribution {
+  text-align: left;
+}
+div.admonitionblock .icon {
+  vertical-align: top;
+  font-size: 1.1em;
+  font-weight: bold;
+  text-decoration: underline;
+  color: #527bbd;
+  padding-right: 0.5em;
+}
+div.admonitionblock td.content {
+  padding-left: 0.5em;
+  border-left: 2px solid silver;
+}
+div.exampleblock > div.content {
+  border-left: 2px solid silver;
+  padding: 0.5em;
+}
+div.verseblock div.content {
+  white-space: pre;
+}
+div.imageblock div.content { padding-left: 0; }
+div.imageblock img { border: 1px solid silver; }
+span.image img { border-style: none; }
+dl {
+  margin-top: 0.8em;
+  margin-bottom: 0.8em;
+}
+dt {
+  margin-top: 0.5em;
+  margin-bottom: 0;
+  font-style: normal;
+}
+dd > *:first-child {
+  margin-top: 0.1em;
+}
+ul, ol {
+    list-style-position: outside;
+}
+div.olist > ol {
+  list-style-type: decimal;
+}
+div.olist2 > ol {
+  list-style-type: lower-alpha;
+}
+div.tableblock > table {
+  border: 3px solid #527bbd;
+}
+thead {
+  font-family: sans-serif;
+  font-weight: bold;
+}
+tfoot {
+  font-weight: bold;
+}
+div.hlist {
+  margin-top: 0.8em;
+  margin-bottom: 0.8em;
+}
+div.hlist td {
+  padding-bottom: 15px;
+}
+td.hlist1 {
+  vertical-align: top;
+  font-style: normal;
+  padding-right: 0.8em;
+}
+td.hlist2 {
+  vertical-align: top;
+}
+@media print {
+  div#footer-badges { display: none; }
+}
+div#toctitle {
+  color: #527bbd;
+  font-family: sans-serif;
+  font-size: 1.1em;
+  font-weight: bold;
+  margin-top: 1.0em;
+  margin-bottom: 0.1em;
+}
+div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
+  margin-top: 0;
+  margin-bottom: 0;
+}
+div.toclevel2 {
+  margin-left: 2em;
+  font-size: 0.9em;
+}
+div.toclevel3 {
+  margin-left: 4em;
+  font-size: 0.9em;
+}
+div.toclevel4 {
+  margin-left: 6em;
+  font-size: 0.9em;
+}
+/* Workarounds for IE6's broken and incomplete CSS2. */
+div.sidebar-content {
+  background: #ffffee;
+  border: 1px solid silver;
+  padding: 0.5em;
+}
+div.sidebar-title, div.image-title {
+  color: #527bbd;
+  font-family: sans-serif;
+  font-weight: bold;
+  margin-top: 0.0em;
+  margin-bottom: 0.5em;
+}
+div.listingblock div.content {
+  border: 1px solid silver;
+  background: #f4f4f4;
+  padding: 0.5em;
+}
+div.quoteblock-content {
+  padding-left: 2.0em;
+}
+div.exampleblock-content {
+  border-left: 2px solid silver;
+  padding-left: 0.5em;
+}
+/* IE6 sets dynamically generated links as visited. */
+div#toc a:visited { color: blue; }
+/* Because IE6 child selector is broken. */
+div.olist2 ol {
+  list-style-type: lower-alpha;
+}
+div.olist2 div.olist ol {
+  list-style-type: decimal;
+}
+</style>
+<script type="text/javascript">
+/*<![CDATA[*/
+window.onload = function(){generateToc(2)}
+/* Author: Mihai Bazon, September 2002
+ * http://students.infoiasi.ro/~mishoo
+ *
+ * Table Of Content generator
+ * Version: 0.4
+ *
+ * Feel free to use this script under the terms of the GNU General Public
+ * License, as long as you do not remove or alter this notice.
+ */
+ /* modified by Troy D. Hanson, September 2006. License: GPL */
+ /* modified by Stuart Rackham, October 2006. License: GPL */
+function getText(el) {
+  var text = "";
+  for (var i = el.firstChild; i != null; i = i.nextSibling) {
+    if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
+      text += i.data;
+    else if (i.firstChild != null)
+      text += getText(i);
+  }
+  return text;
+}
+function TocEntry(el, text, toclevel) {
+  this.element = el;
+  this.text = text;
+  this.toclevel = toclevel;
+}
+function tocEntries(el, toclevels) {
+  var result = new Array;
+  var re = new RegExp('[hH]([2-'+(toclevels+1)+'])');
+  // Function that scans the DOM tree for header elements (the DOM2
+  // nodeIterator API would be a better technique but not supported by all
+  // browsers).
+  var iterate = function (el) {
+    for (var i = el.firstChild; i != null; i = i.nextSibling) {
+      if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
+        var mo = re.exec(i.tagName)
+        if (mo)
+          result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
+        iterate(i);
+      }
+    }
+  }
+  iterate(el);
+  return result;
+}
+// This function does the work. toclevels = 1..4.
+function generateToc(toclevels) {
+  var toc = document.getElementById("toc");
+  var entries = tocEntries(document.getElementsByTagName("body")[0], toclevels);
+  for (var i = 0; i < entries.length; ++i) {
+    var entry = entries[i];
+    if (entry.element.id == "")
+      entry.element.id = "toc" + i;
+    var a = document.createElement("a");
+    a.href = "#" + entry.element.id;
+    a.appendChild(document.createTextNode(entry.text));
+    var div = document.createElement("div");
+    div.appendChild(a);
+    div.className = "toclevel" + entry.toclevel;
+    toc.appendChild(div);
+  }
+  if (entries.length == 0)
+    document.getElementById("header").removeChild(toc);
+}
+/*]]>*/
+</script>
+<title>WebROaR User Guide</title>
+</head>
+<body>
+<div id="header">
+<h1>WebROaR User Guide</h1>
+<div id="toc">
+  <div id="toctitle">Table of Contents</div>
+  <noscript><p><b>JavaScript must be enabled in your browser to display the table of contents.</b></p></noscript>
+</div>
+</div>
+<h2 id="_introduction">1. Introduction</h2>
+<div class="sectionbody">
+<div class="para"><p><a href="http://webroar.in">WebROaR</a> is an application server that makes deployments of ruby web
+applications extremely simple. It provides an integrated solution to view
+the run time performance numbers and email notifications in case any
+exceptions occur in any of the deployed applications.</p></div>
+<h3 id="_key_features">1.1. Key Features</h3><div style="clear:left"></div>
+<div class="ilist"><ul>
+<li>
+<p>
+Maximum Performance.
+</p>
+</li>
+<li>
+<p>
+Simplified Deployment.
+</p>
+</li>
+<li>
+<p>
+Runs Ruby on Rails&#8482; as well as Rack compliant applications.
+</p>
+</li>
+<li>
+<p>
+Run Multiple Applications Simultaneously.
+</p>
+</li>
+<li>
+<p>
+Implements HTTP/1.1 grammar as per RFC 2616 including support for persistent,
+ and chunked requests.
+</p>
+</li>
+<li>
+<p>
+Intelligent load balancing and dynamic reaping of stuck ruby processing
+ instances.
+</p>
+</li>
+<li>
+<p>
+Provides run time performance data for the deployed applications.
+</p>
+</li>
+<li>
+<p>
+Generates notifications in case any exceptions occur in any of the deployed
+ applications.
+</p>
+</li>
+<li>
+<p>
+SSL support.
+</p>
+</li>
+</ul></div>
+</div>
+<h2 id="_supported_operating_systems">2. Supported Operating Systems</h2>
+<div class="sectionbody">
+<div class="para"><p>WebROaR has been tested on Ubuntu 8.1/9.04, Debian 5 (64 Bit), Mac OS X (10.5)
+and Cent OS 5.2. Basically, it should be able to run on any *IX OS.</p></div>
+<div class="para"><p>Currently it does not support Microsoft&#174; Windows.</p></div>
+</div>
+<h2 id="_install">3. Install</h2>
+<div class="sectionbody">
+<h3 id="_prerequisites">3.1. Prerequisites</h3><div style="clear:left"></div>
+<div class="ilist"><ul>
+<li>
+<p>
+ruby 1.8.x or 1.9.x
+</p>
+</li>
+<li>
+<p>
+ruby 1.8-dev or 1.9-dev
+</p>
+</li>
+<li>
+<p>
+openssl ruby extension (On Ubuntu/Debian it is available as libopenssl-ruby1.X)
+</p>
+</li>
+<li>
+<p>
+zlib ruby extension
+</p>
+</li>
+<li>
+<p>
+rubygems
+</p>
+</li>
+<li>
+<p>
+C build tools (gcc etc) (e.g. build-essential on Ubuntu, Xcode on MacOS)
+</p>
+</li>
+<li>
+<p>
+libsqlite3
+</p>
+</li>
+<li>
+<p>
+libsqlite3-dev
+</p>
+</li>
+<li>
+<p>
+gnutls 2.4.1 or later (Only necessary in case SSL support is required)
+</p>
+</li>
+<li>
+<p>
+gnutls-dev 2.4.1 or later (Only necessary in case SSL support is required)
+</p>
+</li>
+</ul></div>
+<div class="admonitionblock">
+<table><tr>
+<td class="icon">
+<img src="./images/icons/note.png" alt="Note" />
+</td>
+<td class="content">
+<div class="title">Ruby Shared Library</div>
+<div class="para"><p>The server needs the shared library - libruby.so to run the ruby web
+applications.</p></div>
+<div class="para"><p>If you are building ruby from source, please ensure you pass the flag
+<strong>&#8212;enable-shared</strong> while executing its ./configure script.</p></div>
+</td>
+</tr></table>
+</div>
+<h3 id="_procedure">3.2. Procedure</h3><div style="clear:left"></div>
+<div class="para"><p>WebROaR can installed using the following commands:</p></div>
+<div class="listingblock">
+<div class="content">
+<pre><tt>gem sources -a http://gems.github.com
+sudo gem install webroar
+sudo webroar install</tt></pre>
+</div></div>
+<div class="admonitionblock">
+<table><tr>
+<td class="icon">
+<img src="./images/icons/note.png" alt="Note" />
+</td>
+<td class="content">
+<div class="title">SSL Support</div>
+<div class="para"><p>In case you would like to setup SSL support for the server, use the following
+command line switch with <strong>sudo webroar install</strong> command mentioned above.</p></div>
+<div class="listingblock">
+<div class="content">
+<pre><tt>sudo webroar install --ssl-support</tt></pre>
+</div></div>
+<div class="para"><p>Configure further SSL options in the server's admin panel
+        <strong>http://&lt;yourservername&gt;:&lt;port&gt;/admin-panel/configuration</strong></p></div>
+<div class="para"><p>After restarting the server, admin panel would now also be accessible over SSL.
+<strong>https://&lt;yourservername&gt;:&lt;port&gt;/admin-panel</strong></p></div>
+</td>
+</tr></table>
+</div>
+<div class="para"><p>Or if you like living in the fast lane, you can install the edge version giving
+the following commands:</p></div>
+<div class="listingblock">
+<div class="content">
+<pre><tt>git clone git://github.com/webroar/webroar.git
+cd webroar
+sudo rake install</tt></pre>
+</div></div>
+<div class="admonitionblock">
+<table><tr>
+<td class="icon">
+<img src="./images/icons/note.png" alt="Note" />
+</td>
+<td class="content">
+<div class="title">SSL Support</div>
+<div class="para"><p>To build with SSL support, use the following additional switch with the
+<strong>sudo rake install</strong> command:</p></div>
+<div class="listingblock">
+<div class="content">
+<pre><tt>sudo rake install ssl=yes</tt></pre>
+</div></div>
+<div class="para"><p>Configure further SSL options in the server's admin panel
+        <strong>http://&lt;yourservername&gt;:&lt;port&gt;/admin-panel/configuration</strong></p></div>
+<div class="para"><p>After restarting the server, admin panel would now also be accessible over SSL.
+<strong>https://&lt;yourservername&gt;:&lt;port&gt;/admin-panel</strong></p></div>
+</td>
+</tr></table>
+</div>
+<h3 id="_troubleshooting">3.3. Troubleshooting</h3><div style="clear:left"></div>
+<div class="admonitionblock">
+<table><tr>
+<td class="icon">
+<img src="./images/icons/important.png" alt="Important" />
+</td>
+<td class="content">It is suggested that rubygems software should be setup correctly
+beforehand, and you should be successfully able to access and use the already
+installed gems. (If you use Ubuntu, you might be able to relate to this point
+better.)</td>
+</tr></table>
+</div>
+<div class="ilist"><ul>
+<li>
+<p>
+In case auto-installation of dependent gems fails (due to some prehistoric
+rubygems version or any other reason), you can install the following dependent
+ gems individually first:
+</p>
+<div class="literalblock">
+<div class="content">
+<pre><tt>calendar_date_select, rack, rake, rspec, sqlite3-ruby, starling-starling</tt></pre>
+</div></div>
+</li>
+<li>
+<p>
+After successful installation of the webroar gem, any errors that occur
+during the setup are saved to the install.log created in the installed gem's
+directory. This can be used to troubleshoot the issues, if any.
+</p>
+</li>
+<li>
+<p>
+All run time logs for the server and the deployed applications can be found
+in <strong>/var/log/webroar</strong>.
+</p>
+</li>
+</ul></div>
+<h3 id="_setting_up_database_for_server_admin_panel">3.4. Setting up database for server admin panel</h3><div style="clear:left"></div>
+<div class="para"><p>The server's admin panel itself is a Ruby on Rails&#8482; web application, and by
+default uses sqlite as it's database. You can edit
+<strong>admin_panel/config/database.yml</strong> to setup a database of your liking and
+follow it up by running these commands from the <strong>admin_panel</strong> directory.</p></div>
+<div class="listingblock">
+<div class="content">
+<pre><tt>rake db:create
+rake db:migrate</tt></pre>
+</div></div>
+<div class="para"><p><strong>admin_panel</strong> directory would be present under the server's rubygem
+directory.</p></div>
+</div>
+<h2 id="_usage">4. Usage</h2>
+<div class="sectionbody">
+<div class="para"><p>Start/Stop/Restart WebROaR:</p></div>
+<div class="listingblock">
+<div class="content">
+<pre><tt>sudo webroar start
+sudo webroar stop
+sudo webroar restart</tt></pre>
+</div></div>
+<div class="para"><p>Start/Stop/Restart a deployed application:</p></div>
+<div class="listingblock">
+<div class="content">
+<pre><tt>sudo webroar start &lt;Application Name&gt;
+sudo webroar stop &lt;Application Name&gt;
+sudo webroar restart &lt;Application Name&gt;</tt></pre>
+</div></div>
+<div class="admonitionblock">
+<table><tr>
+<td class="icon">
+<img src="./images/icons/note.png" alt="Note" />
+</td>
+<td class="content">
+<div class="para"><p>You can stop the admin panel application of the server any time, to conserve
+resources and ensure better security.</p></div>
+<div class="listingblock">
+<div class="content">
+<pre><tt>sudo webroar stop "Admin Panel"</tt></pre>
+</div></div>
+<div class="para"><p>To start it whenever you want, use the following command:</p></div>
+<div class="listingblock">
+<div class="content">
+<pre><tt>sudo webroar start "Admin Panel"</tt></pre>
+</div></div>
+<div class="para"><p>Please note that analytics data and exceptions are still captured by the
+server even when the admin panel is stopped.</p></div>
+</td>
+</tr></table>
+</div>
+</div>
+<h2 id="_deploying_applications">5. Deploying applications</h2>
+<div class="sectionbody">
+<div class="para"><p>If the server got installed successfully, you should be able access it's admin
+panel using the link:<br />
+<strong>http://&lt;yourservername&gt;:&lt;port&gt;/admin-panel</strong></p></div>
+<div class="para"><p>You can log in with the username: <strong>admin</strong> and password that you had entered
+during server installation. Deploy the ruby web application of your choice
+accessing the <strong>Configuration</strong> link of the admin panel.</p></div>
+<div class="admonitionblock">
+<table><tr>
+<td class="icon">
+<img src="./images/icons/tip.png" alt="Tip" />
+</td>
+<td class="content">You do <strong>"not"</strong> need to restart the server when you deploy a new application.
+The application starts up automatically after deployment.</td>
+</tr></table>
+</div>
+<h3 id="_rack_applications_other_than_rails">5.1. Rack applications (other than Rails)</h3><div style="clear:left"></div>
+<div class="para"><p>To deploy any Rack based application (other than Rails) the following are
+required in it's root directory:</p></div>
+<div class="ilist"><ul>
+<li>
+<p>
+<strong>public</strong> folder containing static files like images and stylesheets
+</p>
+</li>
+<li>
+<p>
+<strong>config.ru</strong> - the Rackup file for starting the application. This file must
+contain the complete logic for initializing the application.
+</p>
+</li>
+</ul></div>
+<div class="para"><p>Here are some examples of the Rackup files:</p></div>
+<div class="para"><p><strong>Merb</strong></p></div>
+<div class="listingblock">
+<div class="content">
+<pre><tt>  require 'rubygems'
+  require 'merb-core'
+  Merb::Config.setup(:merb_root   =&gt; ENV['APP_ROOT'],
+                     :environment =&gt; ENV['APP_ENV'],
+                     :path_prefix =&gt; ENV['APP_BASE_URI'])
+  Merb.environment = Merb::Config[:environment]
+  Merb.root = Merb::Config[:merb_root]
+  Merb::BootLoader.run
+  run Merb::Rack::Application.new</tt></pre>
+</div></div>
+<div class="para"><p><strong>Sinatra</strong></p></div>
+<div class="listingblock">
+<div class="content">
+<pre><tt>  require 'rubygems'
+  require 'rack'
+  require 'sinatra'
+  set :env, ENV['APP_ENV'] || :production
+  set :raise_errors, true
+  run Sinatra::Application</tt></pre>
+</div></div>
+<div class="para"><p>You can use following environment variables in <strong>config.ru</strong> to access the few
+application configuration parameters given at a time of application deployment
+in WebROaR.</p></div>
+<div class="ilist"><ul>
+<li>
+<p>
+ENV['APP_ROOT'] - To get the application root
+</p>
+</li>
+<li>
+<p>
+ENV['APP_ENV'] - To get the application environment
+</p>
+</li>
+<li>
+<p>
+ENV['APP_BASE_URI'] - To get the baseuri
+</p>
+</li>
+</ul></div>
+</div>
+<h2 id="_accessing_run_time_statistics">6. Accessing run time statistics</h2>
+<div class="sectionbody">
+<div class="para"><p>For those applications whose Analytics are <strong>Enabled</strong> in their configuration,
+the following graphs are available under the <strong>Analytics</strong> link of the admin panel.</p></div>
+<div class="olist"><ol>
+<li>
+<p>
+URL Breakdown
+</p>
+</li>
+<li>
+<p>
+Most Time Consuming URLs
+</p>
+</li>
+<li>
+<p>
+URL Hits
+</p>
+</li>
+<li>
+<p>
+Slowest URLs
+</p>
+</li>
+<li>
+<p>
+Top Database Consuming URLs
+</p>
+</li>
+<li>
+<p>
+Percentage Time Spent in Database Layer
+</p>
+</li>
+<li>
+<p>
+Average Response Time
+</p>
+</li>
+<li>
+<p>
+Peak Requests in Second
+</p>
+</li>
+<li>
+<p>
+Percentage CPU Utilization
+</p>
+</li>
+<li>
+<p>
+Physical Memory Utilization
+</p>
+</li>
+</ol></div>
+<div class="para"><p>Additionally, CPU and Physical Memory usage graphs for the entire server are
+also available.</p></div>
+<div class="admonitionblock">
+<table><tr>
+<td class="icon">
+<img src="./images/icons/note.png" alt="Note" />
+</td>
+<td class="content">Currently, Analytics are only supported for Ruby on Rails&#8482; applications.
+Also, after a specific request has been processed by the server, it takes
+about a minute for it’s data to show up in the graphs.</td>
+</tr></table>
+</div>
+</div>
+<h2 id="_exception_tracking_and_notifications">7. Exception Tracking and Notifications</h2>
+<div class="sectionbody">
+<div class="para"><p>Any exceptions that occur in any of the deployed application are captured by
+the server. An email notification is also sent out immediately with details of
+the exception, if the mail settings have been configured in the admin panel.</p></div>
+<div class="para"><p>All the exceptions can be seen under the <strong>Exceptions</strong> link of the server admin
+panel.</p></div>
+<div class="admonitionblock">
+<table><tr>
+<td class="icon">
+<img src="./images/icons/note.png" alt="Note" />
+</td>
+<td class="content">Currently, this feature is only supported for Ruby on Rails&#8482; applications.
+Also, it takes about a minute for an exception to show up in the Admin Panel
+after it has occurred.</td>
+</tr></table>
+</div>
+</div>
+<h2 id="_uninstall">8. Uninstall</h2>
+<div class="sectionbody">
+<div class="para"><p>If you didn't like the server, use the following commands in sequence to uninstall it.</p></div>
+<div class="listingblock">
+<div class="content">
+<pre><tt>sudo webroar uninstall
+sudo gem uninstall webroar</tt></pre>
+</div></div>
+</div>
+<h2 id="_test_suite">9. Test Suite</h2>
+<div class="sectionbody">
+<div class="para"><p>If you are a programmer and wish to play around with the server's code, you
+might like to use it's test suite to test the robustness of your changes.</p></div>
+<div class="para"><p>It can be run using the following command:</p></div>
+<div class="listingblock">
+<div class="content">
+<pre><tt>sudo webroar test</tt></pre>
+</div></div>
+<div class="para"><p>We execute this suite on our nightly builds and it currently has the following
+tests:</p></div>
+<div class="ilist"><ul>
+<li>
+<p>
+Unit Tests
+</p>
+</li>
+<li>
+<p>
+Functional Tests
+</p>
+</li>
+<li>
+<p>
+Admin-Panel Tests
+</p>
+</li>
+<li>
+<p>
+Load Test I - Continuous run
+</p>
+</li>
+<li>
+<p>
+Load Test II - Random sleep interval run
+</p>
+</li>
+<li>
+<p>
+Build Tests
+</p>
+</li>
+</ul></div>
+</div>
+<div id="footer">
+<div id="footer-text">
+Last updated 2009-09-15 18:52:21 IST
+</div>
+</div>
+</body>
+</html>