<!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_basics_html_getting_started_a_8594_a_href_basics_installation_html_installation_a"><a href="index.html">Index</a> → <a href="basics.html">Getting started</a> → <a href="basics_installation.html">Installation</a></h2>
<div class="sectionbody">
</div>
<h2 id="_installation_from_github">Installation from GitHub</h2>
<div class="sectionbody">
<div class="paragraph"><p>The latest, bleeding edge Cherokee release can always be retrieved via
Git. Note that this is the development release and could very well be
unstable. In general it is not recommended to run this release in
production environments.</p></div>
<div class="paragraph"><p>Briefly, Git is a system tool used to store and maintain files and a
history of their changes over time, and it is an invaluable development
tool. The Cherokee source code and related files are kept in a Git repository
on <a href="https://github.com/cherokee/webserver">GitHub</a>.</p></div>
<div class="paragraph"><p>You can read more about Git at <a href="http://git-scm.com/">git-scm.com</a>.</p></div>
<div class="paragraph"><p>To download the Git repository you will need a special piece of
software called a Git client. On a Linux-based system, the official
command-line client, simply named <tt>`git</tt>`, can typically be installed
from repositories. For instance, on an Ubuntu or Debian-based system
install using:</p></div>
<div class="listingblock">
<div class="content">
<pre><tt>sudo apt-get install git</tt></pre>
</div></div>
<div class="paragraph"><p>or on a Yum-based system, such as Fedora, RHEL or CentOS install using:</p></div>
<div class="listingblock">
<div class="content">
<pre><tt>sudo yum install git-core</tt></pre>
</div></div>
<h3 id="clone">Cloning the sources</h3><div style="clear:left"></div>
<div class="paragraph"><p>To take a copy of the sources for the first time from the repository, use this
command:</p></div>
<div class="listingblock">
<div class="content">
<pre><tt>git clone --recursive git://github.com/cherokee/webserver cherokee</tt></pre>
</div></div>
<div class="paragraph"><p>If you are on a system with a version of Git earlier than 1.6.5, then you
will also need to manually update the Git submodules for this repository:</p></div>
<div class="listingblock">
<div class="content">
<pre><tt>git clone git://github.com/cherokee/webserver cherokee
cd cherokee
git submodule update --init</tt></pre>
</div></div>
<h3 id="update">Updating the sources</h3><div style="clear:left"></div>
<div class="paragraph"><p>To update the source with latest changes, you use this command within your
local repository:</p></div>
<div class="listingblock">
<div class="content">
<pre><tt>git pull -u</tt></pre>
</div></div>
<h3 id="compile">Compiling and installing</h3><div style="clear:left"></div>
<div class="paragraph"><p>Once you have downloaded the latest source from Git, you will need to
follow the installation instructions for your specific platform.</p></div>
<div class="paragraph"><p>Note that some of the files present in a release tarball are not present in
Git - the most notable of which is the <tt>./configure</tt> file that will be needed
for the compilation and installation process.</p></div>
<div class="paragraph"><p>To generate the missing files simply run this command within your local
repository:</p></div>
<div class="listingblock">
<div class="content">
<pre><tt>./autogen.sh</tt></pre>
</div></div>
<div class="paragraph"><p>As optional parameters, you can specify any option you want passed
to <tt>./configure</tt>. This way you can avoid issuing another command for
the configuration.</p></div>
<div class="paragraph"><p>For instance, this line will configure your local copy with the four
specified parameters:</p></div>
<div class="listingblock">
<div class="content">
<pre><tt>./autogen.sh --prefix=/usr --sysconfdir=/etc \
--localstatedir=/var --enable-trace</tt></pre>
</div></div>
<div class="paragraph"><p>Once you have done this, you are now ready to proceed with the standard
compilation process for your platform:</p></div>
<div class="ulist"><ul>
<li>
<p>
<a href="basics_installation_unix.html">Unix installation</a>
</p>
</li>
<li>
<p>
<a href="basics_installation_windows.html">Windows installation</a>
</p>
</li>
</ul></div>
</div>
<div id="footer">
<div id="footer-text">
</div>
</div>
</body>
</html>
