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: Remote Administration

This handler is used to create rules that can provide information about the running server useful for System Administration. When any such rule is matched, a cherokee-tweak instance will have full access to this data stream.

Note that providing real-real time information about the status of a web server in production is a double edged blade. It is both a very valuable tool for system administration and a severe security risk if no precautions are taken. You are strongly encouraged to both encrypt the channel and disable public access.

There are no parameters to be configured for this handle.

The information provided covers a wide spectrum: ports (secured and non-secured), TX/RX status, connections, threads, backup mode and selectable system traces such as the ones provided by CHEROKEE_TRACE.

Check the Debugging section for more details on this, and the section about cherokee-tweak for specific usage information.

Also, you should think of this handler as a web-service. In fact, cherokee-tweak is just a client application using consuming it. Writing custom client-apps that make use of this handler is almost trivial, since commands can be issued from the command line using curl.

Command line examples:

echo 'set server.trace time,thread,all' | curl -v http://localhost/admin/ -u myuser:mypassword --data-binary @-
echo 'set server.trace none'            | curl -v http://localhost/admin/ -u myuser:mypassword --data-binary @-
echo 'get server.connections'           | curl -v http://localhost/admin/ -u myuser:mypassword --data-binary @-
echo 'close server.connection 100'      | curl -v http://localhost/admin/ -u myuser:mypassword --data-binary @-
echo 'get server.sources'               | curl -v http://localhost/admin/ -u myuser:mypassword --data-binary @-
echo 'kill server.source 3'             | curl -v http://localhost/admin/ -u myuser:mypassword --data-binary @-