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

Other: Front-line Cache

Cherokee has very sophisticated content caching mechanisms, allowing it to cache anything (static files, dynamic content, etc.). Cherokee’s NEW version 1.2.3 Front-line Cache replaces well known independent front-line caches (i.e., Varnish, Squid, etc.). Independent front-line caches add additional latency to requests due to TCPIP network based round-trips to check whether or not the content has already been cached. With Cherokee, the front-line cache built in so there are is no unnecessary network overhead due to caching.

Front-line cache accelerates HTTP delivery even on content-heavy dynamic websites (see example and notes on caching where cookies exist and how to selectively ignore cookies).

Caching policies can be specified on a per-rule basis. Caching of content is decided by two things:

Headers returned by the back-end (i.e., Expires Header).
Whatever is specified in the matching rule.

Caching can be customized for each and every rule of your virtual server’s configuration, by specifying any of the three settings available on a per-rule basis in the <tt>Content Caching</tt> section: Leave unset, Allow and Forbid.

Leave unset option means that whenever a rule is applied it will not change the status of the caching setting that has been inherited from previously matched rules.
Forbid will disable caching of the rule
Allow will cache whatever can be cached.

Any HTTP content can be cached by Cherokee, except the following:

Content in a SSL/TLS stream.
Content that is server after having matched an authentication rule.
Rules that have set any of the properties No store, No Transform, Must Revalidate, or Proxies Revalidate.
Responses to user petitions requesting specific ranges.
Responses where the back-end sets a cookie (although you can tell Cherokee to ignore such cookies).

By default, content that includes cookies are not cached, but the setting to allow caching on a rule gives you the ability to disregard cookies using regular expressions (so even that content can be cached).

Cherokee’s rules provide for great flexibility and control over caching. For instance, take the following example where we never cache content from a restricted "members" section of a website, while allowing Cherokee to always cache the contents of another section of the website regardless of presence of cookies, by prepending two rules to the behavior rule list:

Fullpath: /site/index.php - Non-final - Cache: Disregarded Cookies '.*', Expiration.
Fullpath: /site/members/index.php - Non-final - Cache: Expiration: 1970