Documentation

Cherokee 1.2 documentation

Getting started : Cherokee basics

Why Cherokee? : Feature overview.
Requirements : Hardware and software requirements.
Download : Where and how to download Cherokee.
Installation : Installation instructions.
- Easy installation : One-step installation.
- Unix : Installation on Unix/Linux platforms.
- OSX : Installation on Mac OSX platform.
- Windows : Installation on Windows platform.
- From SVN : Installation of the development release.
Upgrading Cherokee : Upgrading from a previous release?
Running Cherokee : Basic steps to run Cherokee.

Configuration : Set up process explained

Walkthrough : Overview and walkthrough.
Home : Main section.
Market : Entry point to the Cherokee Market
Status : Server status information.
General : General settings.
Virtual servers : Server definition.
- Rule Behavior : Specifying the matching rules.
- Rule Types : Choosing the right rule type for the task.
- Advanced Virtual Hosting : Multi-domain settings.
Information Sources : Defining information sources.
Advanced : Advanced tweaking. Not for the faint of heart.
Wizards : Configuration assistants for many known scenarios.

Cookbook : Recipes for specific tasks

Authentication : How to set up authenticated resources.
Cross compilation : How to cross compile Cherokee.
DBSlayer : How to set up DBSlayer MySQL balancing.
Embedding Cherokee : Cherokee on embedded devices.
Maintenance : Seamlessly switching to maintenance mode.
Managing logs : Seamless log rotation.
Optimizing Cherokee : Recommendations and tweaks.
Redirections : Common redirection examples.
SSL/TLS, certs : Secure connection tips.
HTTPS accelerator : SSL Offloading with Cherokee.
Streaming : How to stream Audio and Video with Cherokee.
PHP : How to run PHP apps with Cherokee.
Ruby on Rails : How to run Ruby on Rails apps with Cherokee.
Django : How to run Django apps with Cherokee.
ColdFusion : How to run ColdFusion apps with Cherokee.
Drupal : How to run Drupal on Cherokee.
Wordpress : How to run Wordpress on Cherokee.
Alfresco : How to run Alfresco on Cherokee.
ASP.NET : How to run ASP.NET apps with Mono and Cherokee.
GlassFish : How to run Java apps with Cherokee.
Joomla : How to run Joomla on Cherokee.
Kumbia : How to run Kumbia apps with Cherokee.
Liferay : How to run Liferay on Cherokee.
Mailman : How to run Mailman on Cherokee.
Moodle : How to run Moodle on Cherokee.
Nagios : How to run Nagios with Cheroke.
phpBB : How to run phpBB on Cherokee.
phpMyAdmin : How to run phpMyAdmin on Cherokee.
SugarCRM : How to run SugarCRM on Cherokee.
Concrete5 : How to run Concrete5 on Cherokee.
Symfony : How to run Symfony apps with Cherokee.
Trac : How to run Trac on Cherokee.
Zend : How to run Zend apps with Cherokee.
uWSGI : Setting up Cherokee for uWSGI.
HTTP to HTTPS : How to redirect all traffic from HTTP to HTTPS.
Restricting traffic by IP : How to restrict traffic based on incoming IP.
Domain matching : Matching domains and subdomains with Cherokee.

Modules : Information about the standard modules

Handlers : Connection handling modules.
- Static Content : Send files.
- Only listing : List directories.
- List & Send : List directories and send files.
- HTTP error : Generate custom HTTP errors.
- Redirection : URL forwards and rewrites.
- CGI : Common Gateway Interface.
- FastCGI : Fast Common Gateway Interface.
- SCGI : Simple Common Gateway Interface.
- uWSGI : uWSGI protocol.
- HTTP reverse proxy : Surrogate/reverse proxy handler.
- Server Side Includes : SSI Server Support.
- Upload Reporting : Show an upload progress bar.
- Audio/Video Streaming : Media streamer.
- Hidden Downloads : Secure, Time expiring downloads.
- Server Info : Provide info about Cherokee.
- MySQL bridge : MySQL over HTTP bridge.
- Remote Administration : Cherokee administration handler.
- 1x1 Transparent GIF : Returns a 1x1 pixel transparent GIF.
- Drop Connection : Immediately drop TCP connection.
Validators : Authentication mechanisms.
- Plain : Plain file mechanism.
- htpasswd : htpasswd mechanism.
- htdigest : htdigest mechanism.
- LDAP : Lightweight Directory Acces Protocol mechanism.
- MySQL : Database mechanism.
- PAM : Pluggable Authentication Module mechanism.
- Fixed list : Fixed authentication list.
Encoders : Compression and filtering.
- gzip : compress using gzip algorithm.
- deflate : compress using deflate algorithm.
Loggers : Logging mechanisms.
- Combined : Combined log format.
- Custom : Customizable log format.
- Common (NCSA) : Common log format.
Balancers : Load balancing strategies.
- Round robin : Round Robin strategy.
- IP Hash : Client IP hash strategy.
- Failover : Failover server strategy.

Other information : Miscellaneous

FAQ : List of Frequently Asked Questions.
Front-line Cache : Specifics of the Caching subsystem.
System Tuning : Tweaking the OS for maximum performance.
Cherokee Goodies : Interesting Cherokee features.
Usage graphs : Information on the several graphs available.
Signals : Signals supported by Cherokee.
Community : More information sources.
Common errors : Some typical production errors and their cause.
Man pages : Details about each program bundled with Cherokee
- cherokee : Main web server invoker.
- cherokee-admin-launcher : Launcher for the configuration UI.
- cherokee-admin : The configuration UI.
- cherokee-config : Information retriever.
- cherokee-tweak : Cherokee Swiss army knife
- cherokee-worker : Web server stand alone program.
- cget : Web retriever.

Development info : Things of interest to developers

Quickstart : Where to start?.
Debugging : Resources available to debug Cherokee.
cherokee.conf : Internal configuration specs.
Quality Assurance : Some info about QA in Cherokee.
CTK : Dive into the Cherokee Toolkit

Cherokee’s Distribution : Web Apps distribution on Cherokee

Introduction to Development : How to build a package.