Cherokee Basics
Getting started

Why Cherokee?Feature overview.
RequirementsHardware and software requirements.
DownloadWhere and how to download Cherokee.
InstallationInstallation instructions.
Upgrading CherokeeUpgrading from a previous release?
Running CherokeeBasic steps to run Cherokee.

Configuration
Set up process explained

WalkthroughOverview and walkthrough.
HomeMain section.
StatusServer status information.
GeneralGeneral settings.
Virtual serversServer definition.
Information SourcesDefining information sources.
AdvancedAdvanced tweaking. Not for the faint of heart.
WizardsConfiguration assistants for many known scenarios.

Cookbook
Recipes for specific tasks

AuthenticationHow to set up authenticated resources.
Cross compilationHow to cross compile Cherokee.
DBSlayerHow to set up DBSlayer MySQL balancing.
Embedding CherokeeCherokee on embedded devices.
MaintenanceSeamlessly switching to maintenance mode.
Managing logsSeamless log rotation.
Optimizing CherokeeRecommendations and tweaks.
RedirectionsCommon redirection examples.
SSL/TLS, certsSecure connection tips.
HTTPS acceleratorSSL Offloading with Cherokee.
StreamingHow to stream Audio and Video with Cherokee.
PHPHow to run PHP apps with Cherokee.
Ruby on RailsHow to run Ruby on Rails apps with Cherokee.
DjangoHow to run Django apps with Cherokee.
ColdFusionHow to run ColdFusion apps with Cherokee.
DrupalHow to run Drupal on Cherokee.
WordpressHow to run Wordpress on Cherokee.
AlfrescoHow to run Alfresco on Cherokee.
ASP.NETHow to run ASP.NET apps with Mono and Cherokee.
GlassFishHow to run Java apps with Cherokee.
JoomlaHow to run Joomla on Cherokee.
KumbiaHow to run Kumbia apps with Cherokee.
LiferayHow to run Liferay on Cherokee.
MailmanHow to run Mailman on Cherokee.
MoodleHow to run Moodle on Cherokee.
NagiosHow to run Nagios with Cheroke.
phpBBHow to run phpBB on Cherokee.
phpMyAdminHow to run phpMyAdmin on Cherokee.
SugarCRMHow to run SugarCRM on Cherokee.
Concrete5How to run Concrete5 on Cherokee.
SymfonyHow to run Symfony apps with Cherokee.
TracHow to run Trac on Cherokee.
ZendHow to run Zend apps with Cherokee.
uWSGISetting up Cherokee for uWSGI.
HTTP to HTTPSHow to redirect all traffic from HTTP to HTTPS.
Restricting traffic by IPHow to restrict traffic based on incoming IP.
Domain matchingMatching domains and subdomains with Cherokee.

Modules
Information about the standard modules

HandlersConnection handling modules.
ValidatorsAuthentication mechanisms.
EncodersCompression and filtering.
LoggersLogging mechanisms.
BalancersLoad balancing strategies.

Other information
Miscellaneous

FAQList of Frequently Asked Questions.
Front-line CacheSpecifics of the Caching subsystem.
System TuningTweaking the OS for maximum performance.
Cherokee GoodiesInteresting Cherokee features.
Usage graphsInformation on the several graphs available.
SignalsSignals supported by Cherokee.
CommunityMore information sources.
Common errorsSome typical production errors and their cause.
Man pagesDetails about each program bundled with Cherokee.

Development info
Things of interest to developers

QuickstartWhere to start?
DebuggingResources available to debug Cherokee.
cherokee.confInternal configuration specs.
Quality AssuranceSome info about QA in Cherokee.
CTKDive into the Cherokee Toolkit.

Cherokee’s Distribution
Web Apps distribution on Cherokee

Introduction to DevelopmentHow to build a package.

Documentation

Handler: Server Side Includes

Server Side Includes, also known as SSI, are directives placed in HTML pages meant to be evaluated on the web server while the requests are being delivered. The intended use is adding some dynamic content to existing HTML pages without having to serve the whole content dynamically (be it through CGI, SCGI, FastCGI, etc.).

SSI are very useful to add small pieces of information, but are not the way to go if the majority of the content has to be generated at the time it is served. Traditionally the web server was notified that it should apply SSI when it processed files ending with the .shtml extension.

Although this will be the majority of cases where this can be of usefulness, Cherokee is not limited to just one file extension. The SSI handler applies to whatever is matched by the rule where it has been configured.

Currently Cherokee supports the following SSI directives:

include: this tag inserts the contents of a file. Both virtual and file includes can be performed. The former uses paths beginning at the Document Root, and the latter uses paths relative to the current directory.
fsize: inserts the size of a given file.
flastmod: inserts the last modification date of a given file.

In any of the above cases, the specified data is inserted into the HTML page at the location of the token.

Examples

A typical use would be using and include file for header and footer, allowing for an easy and fast way of updating the whole theme of a website. Only one header and footer file would have to be created, and that could be inserted through SSI in the rest of the pages with SSI directives like the following ones:

   <!--#include virtual="/header.html" -->

   <!--#include virtual="/footer.html" -->

Note that the include element can determine what file to include based on the virtual or file attributes, which have the behavior specified above. In any case, despite specifying absolute or relative paths containing .., the SSI handler will not include any files outside the webserver document root.