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.

Cherokee Basics

Index → Getting started

Upgrading Cherokee

If there is a prepackaged version of Cherokee for you platform of choice, we strongly encourage you to use it. Although upgrading Cherokee is not complicated, the prepackaged versions should make your upgrades much easier.

Refer to the APT section of the Unix installation instructions if you are using Debian or Ubuntu for some additional information.

The current mechanism of choice to configure Cherokee did not exist prior to release 0.6. A lot has happened since then, and Cherokee has been constantly improving in terms of stability, efficiency and features.

If you happen to be running an old version of Cherokee and would like to keep your current configuration settings, you can upgrade your cherokee.conf file.

Cherokee currently supports configuration versioning, so from now on, whenever a change is made to the configuration file format, Cherokee-Admin will be able to automatically convert yours to the new release. You simply have to load Cherokee-Admin and it will be converted once you proceed to saving it.

There is also a command line utility that you can use to do the exact same thing. It is provided under $prefix/share/cherokee/admin/upgrade_config.py.

In case you need to do this manually, the usage is as follows:

/usr/share/cherokee/admin/upgrade_config.py /etc/cherokee/cherokee.conf

Every effort is made to bulletproof the upgrade script. If an upgrade does not work for you, please send a bug report. However, Cherokee is a very active project and has been steadily advancing and incorporating technical improvements. You should really be using cherokee-admin to configure your system if you want to take full advantage of the new features. Even if the upgrade process is successful, you should use the new configuration file as a start point and go through the normal configuration process using cherokee-admin.

Also, as long as you are not using an ancient configuration file, every new cherokee-admin release will be able to upgrade the configuration automatically from previous versions whenever a format change has been required.