<!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>
<meta http-equiv="Content-type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Language" content="en-us" />
<meta name="ROBOTS" content="ALL" />
<meta http-equiv="imagetoolbar" content="no" />
<meta name="MSSmartTagsPreventParsing" content="true" />
<meta name="Keywords" content="cherokee web server httpd http" />
<meta name="Description" content="Cherokee is a flexible, very fast, lightweight Web server. It is implemented entirely in C, and has no dependencies beyond a standard C library. It is embeddable and extensible with plug-ins. It supports on-the-fly configuration by reading files or strings, TLS/SSL (via GNUTLS or OpenSSL), virtual hosts, authentication, cache friendly features, PHP, custom error management, and much more." />
<link href="media/css/cherokee_doc.css" rel="stylesheet" type="text/css" media="all" />
</head>
<body>
<h2 id="_a_href_index_html_index_a_8594_a_href_dev_html_development_info_a"><a href="index.html">Index</a> → <a href="dev.html">Development info</a></h2>
<div class="sectionbody">
</div>
<h2 id="_development_quickstart">Development: Quickstart</h2>
<div class="sectionbody">
<div class="paragraph"><p>So, you have found things in Cherokee worth improving and feel the
urge to contribute to the project. But where to start?</p></div>
<div class="paragraph"><p>The first thing, of course, is setting up a development/testing
environming for Cherokee.</p></div>
<div class="paragraph"><p>The relevant documents would be those about
<a href="basics_requirements.html">software requirements</a>,
<a href="basics_download.html">downloading the GIT repository</a>, and the
<a href="basics_installation_unix.html">quickstart installation notes</a>.</p></div>
<div class="paragraph"><p>In principle, provided you have the required tools in your system, it
should be as easy as:</p></div>
<div class="listingblock">
<div class="content">
<pre><tt> git clone --recursive git://github.com/cherokee/webserver.git ~/cherokee
cd ~/cherokee_dev
git submodule update --init #not needed on Git >= 1.6.5
./autogen.sh --enable-beta --enable-trace
make</tt></pre>
</div></div>
<div class="paragraph"><p>You should probably read all the <a href="dev.html">development info</a>
section of the documentation, and go through the
<a href="http://bugs.cherokee-project.com/">Cherokee Project Bugtracker</a> to
make sure you are not wasting your effort working on something already
solved.</p></div>
<div class="paragraph"><p>Joining the
<a href="http://lists.octality.com/listinfo/cherokee-dev">development list</a>
and hanging out at the <a href="irc://irc.freenode.net/cherokee">#cherokee
IRC channel</a> are also good ideas.</p></div>
<h3 id="_quick_tips">Quick Tips</h3><div style="clear:left"></div>
<div class="paragraph"><p>If you are modifiying the core of Cherokee, don’t forget to run the
whole <a href="dev_qa.html">QA</a> bench to ensure no regressions are being
introduced by your changes.</p></div>
<div class="paragraph"><p>Additionally, if you are modifying cherokee-admin, don’t forget to run
the modified instance instead of the one in the system, which can be
specified with the -d (--appdir) parameter:</p></div>
<div class="listingblock">
<div class="content">
<pre><tt> cherokee-admin -d ~/cherokee_dev/admin</tt></pre>
</div></div>
<div class="paragraph"><p>And that’s about it. You should be able to get your hands dirty from
here. Happy hacking!</p></div>
</div>
<div id="footer">
<div id="footer-text">
</div>
</div>
</body>
</html>
