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

Easy installation

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:

wget https://github.com/cherokee/installer/raw/master/install.py && python install.py

curl -LO https://github.com/cherokee/installer/raw/master/install.py && python install.py

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 /opt/cherokee, and by deleting that directory you could totally purge Cherokee from your system.

If you require further customization, this script is not for you. The other -more elaborate- installation methods 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.

Development mode

The easy installation script supports several parameters. To see a full list of parameters, just add the --help parameter:

wget https://github.com/cherokee/installer/blob/master/install.py && python install.py --help

The only one really worth mentioning is the one to trigger the development mode:

wget https://github.com/cherokee/installer/blob/master/install.py && python install.py --devel

This will build a bleeding edge release, taking the sources from the latest development snapshot, enabling traces, and making the installation under /opt/cherokee-dev, so that it can coexist with a regular installation.