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: Audio/Video Streaming

This handler is used to stream media files. Both audio and video files are supported.

The two main features of this module are:

Automatic Traffic Shaping: All the media files handled by this module will be analyzed, so it figures the media bitrate. Once the module knows it, it will limit the speed to that bitrate, so server bandwidth is not wasted in the case the client stops watching or listening to the file before it has finished. This feature also helps the server to handle a higher user concurrency before the bandwidth limit is reached.
Seeking support: There are some web media players that support media seeking by using a ?start= parameter. So far, this method is supported for FLV files, and it will be eventually supported for H264 videos as well.

If the Automatic Traffic Shaping is enabled, all the media formats will be streamed, independently on whether or not seeking is supported for that format. For instance, even though seeking wouldn’t work, any MP3, OGG, AVI or Matroska file would be streamed according to their bitrate.

Parameters: Listing

Parameters	Type	Description
`Auto Rate`	boolean	Whether to enable the bitrate based bandwidth limit.
`Speedup Factor`	float	Optional. It is the factor by which the bandwidth limit would be multiplied. Default: 0.1.
`Initial Boost`	number	Optional. Seconds of media that should be sent before setting the bandwidth limit. This allows the client to buffer some media. Default: 5 (seconds).

Notes on FLV streaming

It is important to remember that FLV videos must be indexed. It is only possible to seek along the media file if it has some meta data tags. Without these tags, seeking just would not work.

There are tools like FLVTool2, FLVMDI or Yamdi that can be used to insert these tags.

Notes on H264 (mp4) streaming

H264 files must be written in a special way so the server can stream them. If a H264 file is ready for progressive streaming, Flash 9 (and higher) will be able to play it while it’s being downloaded.

From a technical point of view, the server needs the H264 file to have its moov atoms (or boxes) in front of the data. The qt-faststart.c program - shipped with FFMpeg - rewrites H264 files so their atoms are placed in the required order.