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

Cookbook: Setting up ColdFusion

Supporting ColdFusion with Cherokee is almost trivial.

Configuring Cherokee

Cherokee provides a wizard that will assist you on this task. You can either dedicate a new virtual server to the task, or use a preexisting one. It is your choice, since the Wizard contemplates both scenarios. For the former you’ll have to access the Wizard from the list of available ones within the Virtual Servers panel. The latter is accessed through the same list of Wizards of the Rule Management panel. This panel is accessed by visiting the Behavior tab of the selected virtual server, and triggering the Rule panel by clicking on the Rule Management button. In either case, use the Add button at the top of the panel to see the available wizards.

The wizard will simply ask for the host to be proxied and will set it up for you to see. It will automatically detect if the provided hostname:port are in fact running ColdFusion by probing for the presence of the JRun service. Should you need to add more machines to your cluster, you can add extra information sources to your Cherokee configuration and let it deal with all the load balancing.

No extra steps are necessary. If for any reason the Wizard doesn’t work for you, you can always use the manual method described below.

Manual method

Getting Cherokee to work with ColdFusion (MX 6 versions and newer) is simple and this emulates how tie-in is done with Apache and other out-of-box supported web servers.

ColdFusion (actually the JRUN Java server which Coldfusion runs on top of) processes web requests by default on port 8500.

So create as many Information Sources running ColdFusion as needed in Cherokee:

Type	Nick	Connection
Remote host	ColdFusion1	192.168.1.101:8500
Remote host	ColdFusion2	192.168.1.102:8500
Remote host	ColdFusion3	192.168.1.103:8500

Then, add a rule to your virtual server that is managed by the HTTP reverse proxy, and assign the above mentioned sources to it.

Round robin or IPHash will work for the balancer type. It is recommended to stick with IPHash if you have multiple ColdFusion app servers behind Cherokee so that session data will be preserved by sending the user to the same backend always - thus eliminating complicated and expensive load balancing solution to accomplish the same.

That’s all there is to this.

One note: This is good for a single domain operation. If you have multiple sites that are to be handled by the same ColdFusion backend(s) you will need to modify JRUN configuration files to handle such.