Permalink
Browse files

Transition a big chunk of documentation into new Jekyll format.

  • Loading branch information...
1 parent 1b4d4e0 commit f3c7ac805f610a788957c51419281fd1a86ab2a4 Locke committed Jan 26, 2013
@@ -0,0 +1,10 @@
+ <h2>Other Screencasts</h2>
+ <ul>
+ <li><a href="screencast_intro.html">Introduction</a></li>
+ <li><a href="screencast_django_flup.html">Django with Flup</a></li>
+ <li><a href="screencast_django_uwsgi.html">Djando with uWSGI</a></li>
+ <li><a href="screencast_php.html">PHP</a></li>
+ <li><a href="screencast_ror.html">Ruby on Rails</a></li>
+ <li><a href="screencast_streaming.html">Media Streaming</a></li>
+ <li><a href="screencast_wordpress.html">Wordpress</a></li>
+ </ul>
View
@@ -6,7 +6,7 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
- <title>{% if page.title %} {{ page.title }} | {% endif %} Cherokee Web Server</title>
+ <title>Cherokee Web Server{% if page.title %} | {{ page.title }}{% endif %}</title>
<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, TLS/SSL, virtual hosts, authentication, cache friendly features, PHP, custom error management, several load balancing policies, database balancing, and much more.">
<meta name="viewport" content="width=device-width">
<link rel="stylesheet" href="{{site.baseurl}}/CTK/css/CTK.css">
@@ -18,7 +18,7 @@
<li><a href="config_walkthrough.html">Walkthrough</a><span>Overview and walkthrough.</span></li>
<li><a href="config_index.html">Home</a><span>Main section.</span></li>
<li><a href="config_status.html">Status</a><span>Server status information.</span></li>
- <li><a href="config_general.html">General</a><span>eneral settings.</span></li>
+ <li><a href="config_general.html">General</a><span>General settings.</span></li>
<li><a href="config_virtual_servers.html">Virtual servers</a><span>Server definition.</span></li>
<li><a href="config_info_sources.html">Information Sources</a><span>Defining information sources.</span></li>
<li><a href="config_advanced.html">Advanced</a><span>Advanced tweaking. Not for the faint of heart.</span></li>
View
@@ -1,6 +1,6 @@
---
layout: documentation
-title: Download | The Basics | Cherokee Documentation
+title: Download | Cherokee Documentation
---
<div id="main_area">
@@ -14,7 +14,7 @@ <h2 id="_download">Download</h2>
version, you can access our Git repository. Be advised, this is the
development branch, so use it at your own risk!
</p>
- <p><strong>To clone or fork, simply visit the <a href="https://github.com/cherokee/webserver">Cherokee Project page on Github</a>.</strong></p>
+ <p><strong>To download, clone, or fork, simply visit the <a href="https://github.com/cherokee/webserver">Cherokee Project page on Github</a>.</strong></p>
<p>Cherokee can also be downloaded from the Cherokee Web Server download site
or any of its mirrors. Some users of Cherokee on unix-like systems
will be better off downloading and compiling a source version. The
View
@@ -1,6 +1,6 @@
---
layout: documentation
-title: Installing Cherokee | The Basics | Cherokee Documentation
+title: Installing Cherokee | Cherokee Documentation
---
<div id="main_area">
@@ -18,27 +18,27 @@ <h2 id="_installation">Installing Cherokee</h2>
<ul>
<li>
<p>
- <a href="basics_installation_easy-install.html">Easy installation</a>
+ <a href="basics_install_git.html">Installation from Git</a>
</p>
</li>
<li>
<p>
- <a href="basics_installation_unix.html">Unix installation</a>
+ <a href="basics_install_easy.html">Easy installation</a>
</p>
</li>
<li>
<p>
- <a href="basics_installation_osx.html">OSX installation</a>
+ <a href="basics_install_unix.html">Unix installation</a>
</p>
</li>
<li>
<p>
- <a href="basics_installation_windows.html">Windows installation</a>
+ <a href="basics_install_osx.html">OSX installation</a>
</p>
</li>
<li>
<p>
- <a href="basics_installation_svn.html">Installation From SVN</a>
+ <a href="basics_install_windows.html">Windows installation</a>
</p>
</li>
</ul>
@@ -0,0 +1,78 @@
+---
+layout: documentation
+title: Easy Installation | Installing Cherokee | Cherokee Documentation
+---
+
+<div id="main_area">
+ <h1>Cherokee Basics</h1>
+ <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="_easy_installation">Installing Cherokee: Easy installation</h2>
+ <div class="sectionbody">
+ <div class="paragraph">
+ <p>The easiest way to install Cherokee is by using the script provided
+ for easy installations. It compiles and installs the latest version of
+ the server with a single command:
+ </p>
+ </div>
+ <div class="listingblock">
+ <div class="content">
+ <pre><tt>wget http://cherokee-project.com/install &amp;&amp; python install</tt></pre>
+ </div>
+ </div>
+ <div class="paragraph">
+ <p>or</p>
+ </div>
+ <div class="listingblock">
+ <div class="content">
+ <pre><tt>curl -LO http://cherokee-project.com/install &amp;&amp; python install</tt></pre>
+ </div>
+ </div>
+ <div class="paragraph">
+ <p>The easy installation script is the express way to make a Cherokee
+ installation as seamless and hassle-free as possible. It will build
+ and install everything under <tt>/opt/cherokee</tt>, and by deleting that
+ directory you could totally purge Cherokee from your system.
+ </p>
+ </div>
+ <div class="paragraph">
+ <p>If you require further customization, this script is not for you. The
+ other -more elaborate- <a href="basics_install.html">installation
+ methods</a> will fulfill your needs. Particularly when there is a
+ prepackaged version of Cherokee available for your architecture you
+ should follow that route. That will provide you with automatic bootup
+ scripts, consistency and dependency checks, and an easy upgrade path
+ tailored to your system whenever a new package is available.
+ </p>
+ </div>
+ <h3 id="_development_mode">Development mode</h3>
+ <div style="clear:left"></div>
+ <div class="paragraph">
+ <p>The easy installation script supports several parameters. To see a
+ full list of parameters, just add the <tt>--help</tt> parameter:
+ </p>
+ </div>
+ <div class="listingblock">
+ <div class="content">
+ <pre><tt>wget http://cherokee-project.com/install &amp;&amp; python install --help</tt></pre>
+ </div>
+ </div>
+ <div class="paragraph">
+ <p>The only one really worth mentioning is the one to trigger the
+ <tt>development mode</tt>:
+ </p>
+ </div>
+ <div class="listingblock">
+ <div class="content">
+ <pre><tt>wget http://cherokee-project.com/install &amp;&amp; python install --devel</tt></pre>
+ </div>
+ </div>
+ <div class="paragraph">
+ <p>This will build a bleeding edge release, taking the sources from the
+ latest development snapshot, enabling traces, and making the
+ installation under <tt>/opt/cherokee-dev</tt>, so that it can coexist with a
+ regular installation.
+ </p>
+ </div>
+ </div>
+</div>
@@ -0,0 +1,84 @@
+---
+layout: documentation
+title: Easy Installation | Installing Cherokee | Cherokee Documentation
+---
+
+<div id="main_area">
+ <h1>Cherokee Basics</h1>
+ <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_svn">Installing Cherokee: from Git</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.
+ </p>
+ </div>
+ <div class="paragraph">
+ <p>
+ To fetch the Git repository you will need to have <a href="http://git-scm.com/downloads">Git</a> installed.
+ </p>
+ <p>
+ <strong>To download, clone, or fork, simply visit the <a href="https://github.com/cherokee/webserver">Cherokee Project page on Github</a>.</strong>
+ </p>
+ </div>
+ <h3 id="compile">Compiling and installing</h3>
+ <div style="clear:left"></div>
+ <div class="paragraph">
+ <p>Once you have downloaded the latest SVN revision, 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 the tarball are not present in
+ SVN. Most noticeably, the file <tt>./configure</tt> that will be needed for the
+ installation process.
+ </p>
+ </div>
+ <div class="paragraph">
+ <p>To generate the missing files simply run this command:</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>You would then be ready to proceed with the standard compilation
+ process for your platform:
+ </p>
+ </div>
+ <div class="ulist">
+ <ul>
+ <li>
+ <p>
+ <a href="basics_install_unix.html">Unix installation</a>
+ </p>
+ </li>
+ <li>
+ <p>
+ <a href="basics_install_windows.html">Windows installation</a>
+ </p>
+ </li>
+ </ul>
+ </div>
+ </div>
+</div>
@@ -0,0 +1,98 @@
+---
+layout: documentation
+title: OSX Installation | Installing Cherokee | Cherokee Documentation
+---
+
+<div id="main_area">
+ <h1>Cherokee Basics</h1>
+ <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_on_macos_x">Installing Cherokee: MacOS X</h2>
+ <div class="sectionbody">
+ <div class="paragraph">
+ <p>Installation on MacOS X is pretty much the same as in any other Unix
+ platform. If you do not find a prepackaged version that suits your
+ needs, you can always download and compile your own.
+ </p>
+ </div>
+ <h3 id="quickstart">Quickstart</h3>
+ <div style="clear:left"></div>
+ <div class="olist arabic">
+ <ol class="arabic">
+ <li>
+ <p>
+ <a href="basics_download.html">Download</a> a fresh copy of Cherokee
+ </p>
+ </li>
+ <li>
+ <p>
+ Configure the package for your system:
+ </p>
+ <div class="listingblock">
+ <div class="content">
+ <pre><tt>./configure --prefix=/usr/local \
+ --with-wwwuser=www \
+ --with-wwwgroup=www</tt></pre>
+ </div>
+ </div>
+ </li>
+ <li>
+ <p>
+ Compile the package:
+ </p>
+ <div class="listingblock">
+ <div class="content">
+ <pre><tt>make -j4</tt></pre>
+ </div>
+ </div>
+ </li>
+ <li>
+ <p>
+ Install the programs and any data files:
+ </p>
+ <div class="listingblock">
+ <div class="content">
+ <pre><tt>sudo make install</tt></pre>
+ </div>
+ </div>
+ </li>
+ <li>
+ <p>
+ Start <a href="other_bundle_cherokee-admin.html">cherokee-admin</a>
+ </p>
+ <div class="paragraph">
+ <p>Additionally, you can follow the <a href="#autostart">Autostart</a>
+ instructions to load the web server at boot time.
+ </p>
+ </div>
+ </li>
+ </ol>
+ </div>
+ <h3 id="autostart">Autostart</h3>
+ <div style="clear:left"></div>
+ <div class="paragraph">
+ <p>If you need the cherokee webserver to start at boot time, you will
+ have to use the provided Launchd init script. It will be built with
+ the rest of Cherokee at the root of your build directory. Simply copy
+ it to the apropriate location and make <tt>launchd</tt> aware of it with the
+ following commands.
+ </p>
+ </div>
+ <div class="listingblock">
+ <div class="content">
+ <pre><tt>sudo cp org.cherokee.webserver.plist /System/Library/LaunchDaemons/
+sudo launchctl load -w /System/Library/LaunchDaemons/org.cherokee.webserver.plist</tt></pre>
+ </div>
+ </div>
+ <h3 id="advanced">Advanced parameters</h3>
+ <div style="clear:left"></div>
+ <div class="paragraph">
+ <p>If you want to learn more about <em>configure</em> you can run <tt>./configure
+ --help</tt>. The list of parameter is extensive, so you might want to take
+ a look at it, particularly if you are a developer. Some of the most
+ used parameters are listed on the
+ link_basics_installation_unix.html[Unix instructions].
+ </p>
+ </div>
+ </div>
+</div>
Oops, something went wrong.

0 comments on commit f3c7ac8

Please sign in to comment.