<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta http-equiv="Content-type" content="text/html; charset=utf-8" /> <meta http-equiv="Content-Language" content="en-us" /> <meta name="ROBOTS" content="ALL" /> <meta http-equiv="imagetoolbar" content="no" /> <meta name="MSSmartTagsPreventParsing" content="true" /> <meta name="Keywords" content="cherokee web server httpd http" /> <meta name="Description" content="Cherokee is a flexible, very fast, lightweight Web server. It is implemented entirely in C, and has no dependencies beyond a standard C library. It is embeddable and extensible with plug-ins. It supports on-the-fly configuration by reading files or strings, TLS/SSL (via GNUTLS or OpenSSL), virtual hosts, authentication, cache friendly features, PHP, custom error management, and much more." /> <link href="media/css/cherokee_doc.css" rel="stylesheet" type="text/css" media="all" /> </head> <body> <h2 id="_cherokee_1_2_documentation">Cherokee 1.2 documentation</h2> <div class="sectionbody"> <div class="sidebarblock"> <div class="sidebar-content"> <div class="paragraph"><p><a href="basics.html">Getting started</a>: Cherokee basics</p></div> </div></div> <div class="olist arabic"><ol class="arabic"> <li> <p> <a href="basics_why_cherokee.html">Why Cherokee?</a>: Feature overview. </p> </li> <li> <p> <a href="basics_requirements.html">Requirements</a>: Hardware and software requirements. </p> </li> <li> <p> <a href="basics_download.html">Download</a>: Where and how to download Cherokee. </p> </li> <li> <p> <a href="basics_installation.html">Installation</a>: Installation instructions. </p> <div class="ulist"><ul> <li> <p> <a href="basics_installation_easy-install.html">Easy installation</a>: One-step installation. </p> </li> <li> <p> <a href="basics_installation_unix.html">Unix</a>: Installation on Unix/Linux platforms. </p> </li> <li> <p> <a href="basics_installation_osx.html">OSX</a>: Installation on Mac OSX platform. </p> </li> <li> <p> <a href="basics_installation_windows.html">Windows</a>: Installation on Windows platform. </p> </li> <li> <p> <a href="basics_installation_svn.html">From SVN</a>: Installation of the development release. </p> </li> </ul></div> </li> <li> <p> <a href="basics_upgrade.html">Upgrading Cherokee</a>: Upgrading from a previous release? </p> </li> <li> <p> <a href="basics_running_cherokee.html">Running Cherokee</a>: Basic steps to run Cherokee. </p> </li> </ol></div> <div class="sidebarblock"> <div class="sidebar-content"> <div class="paragraph"><p><a href="config.html">Configuration</a>: Set up process explained</p></div> </div></div> <div class="olist arabic"><ol class="arabic"> <li> <p> <a href="config_walkthrough.html">Walkthrough</a>: Overview and walkthrough. </p> </li> <li> <p> <a href="config_index.html">Home</a>: Main section. </p> </li> <li> <p> <a href="config_market.html">Market</a>: Entry point to the Cherokee Market </p> </li> <li> <p> <a href="config_status.html">Status</a>: Server status information. </p> </li> <li> <p> <a href="config_general.html">General</a>: General settings. </p> </li> <li> <p> <a href="config_virtual_servers.html">Virtual servers</a>: Server definition. </p> <div class="ulist"><ul> <li> <p> <a href="config_virtual_servers_rule.html">Rule Behavior</a>: Specifying the matching rules. </p> </li> <li> <p> <a href="config_virtual_servers_rule_types.html">Rule Types</a>: Choosing the right rule type for the task. </p> </li> <li> <p> <a href="config_virtual_servers_evhost.html">Advanced Virtual Hosting</a>: Multi-domain settings. </p> </li> </ul></div> </li> <li> <p> <a href="config_info_sources.html">Information Sources</a>: Defining information sources. </p> </li> <li> <p> <a href="config_advanced.html">Advanced</a>: Advanced tweaking. Not for the faint of heart. </p> </li> <li> <p> <a href="config_wizards.html">Wizards</a>: Configuration assistants for many known scenarios. </p> </li> </ol></div> <div class="sidebarblock"> <div class="sidebar-content"> <div class="paragraph"><p><a href="cookbook.html">Cookbook</a>: Recipes for specific tasks</p></div> </div></div> <div class="olist arabic"><ol class="arabic"> <li> <p> <a href="cookbook_authentication.html">Authentication</a>: How to set up authenticated resources. </p> </li> <li> <p> <a href="cookbook_cross_compilation.html">Cross compilation</a>: How to cross compile Cherokee. </p> </li> <li> <p> <a href="cookbook_dbslayer.html">DBSlayer</a>: How to set up DBSlayer MySQL balancing. </p> </li> <li> <p> <a href="cookbook_embedding_cherokee.html">Embedding Cherokee</a>: Cherokee on embedded devices. </p> </li> <li> <p> <a href="cookbook_maintenance.html">Maintenance</a>: Seamlessly switching to maintenance mode. </p> </li> <li> <p> <a href="cookbook_managing_logs.html">Managing logs</a>: Seamless log rotation. </p> </li> <li> <p> <a href="cookbook_optimizations.html">Optimizing Cherokee</a>: Recommendations and tweaks. </p> </li> <li> <p> <a href="cookbook_redirs.html">Redirections</a>: Common redirection examples. </p> </li> <li> <p> <a href="cookbook_ssl.html">SSL/TLS, certs</a>: Secure connection tips. </p> </li> <li> <p> <a href="cookbook_https_accelerator.html">HTTPS accelerator</a>: SSL Offloading with Cherokee. </p> </li> <li> <p> <a href="cookbook_streaming.html">Streaming</a>: How to stream Audio and Video with Cherokee. </p> </li> <li> <p> <a href="cookbook_php.html">PHP</a>: How to run PHP apps with Cherokee. </p> </li> <li> <p> <a href="cookbook_ror.html">Ruby on Rails</a>: How to run Ruby on Rails apps with Cherokee. </p> </li> <li> <p> <a href="cookbook_django.html">Django</a>: How to run Django apps with Cherokee. </p> </li> <li> <p> <a href="cookbook_coldfusion.html">ColdFusion</a>: How to run ColdFusion apps with Cherokee. </p> </li> <li> <p> <a href="cookbook_drupal.html">Drupal</a>: How to run Drupal on Cherokee. </p> </li> <li> <p> <a href="cookbook_wordpress.html">Wordpress</a>: How to run Wordpress on Cherokee. </p> </li> <li> <p> <a href="cookbook_alfresco.html">Alfresco</a>: How to run Alfresco on Cherokee. </p> </li> <li> <p> <a href="cookbook_mono.html">ASP.NET</a>: How to run ASP.NET apps with Mono and Cherokee. </p> </li> <li> <p> <a href="cookbook_glassfish.html">GlassFish</a>: How to run Java apps with Cherokee. </p> </li> <li> <p> <a href="cookbook_joomla.html">Joomla</a>: How to run Joomla on Cherokee. </p> </li> <li> <p> <a href="cookbook_kumbia.html">Kumbia</a>: How to run Kumbia apps with Cherokee. </p> </li> <li> <p> <a href="cookbook_liferay.html">Liferay</a>: How to run Liferay on Cherokee. </p> </li> <li> <p> <a href="cookbook_mailman.html">Mailman</a>: How to run Mailman on Cherokee. </p> </li> <li> <p> <a href="cookbook_moodle.html">Moodle</a>: How to run Moodle on Cherokee. </p> </li> <li> <p> <a href="cookbook_nagios.html">Nagios</a>: How to run Nagios with Cheroke. </p> </li> <li> <p> <a href="cookbook_phpbb.html">phpBB</a>: How to run phpBB on Cherokee. </p> </li> <li> <p> <a href="cookbook_phpmyadmin.html">phpMyAdmin</a>: How to run phpMyAdmin on Cherokee. </p> </li> <li> <p> <a href="cookbook_sugarcrm.html">SugarCRM</a>: How to run SugarCRM on Cherokee. </p> </li> <li> <p> <a href="cookbook_concrete5.html">Concrete5</a>: How to run Concrete5 on Cherokee. </p> </li> <li> <p> <a href="cookbook_symfony.html">Symfony</a>: How to run Symfony apps with Cherokee. </p> </li> <li> <p> <a href="cookbook_trac.html">Trac</a>: How to run Trac on Cherokee. </p> </li> <li> <p> <a href="cookbook_zend.html">Zend</a>: How to run Zend apps with Cherokee. </p> </li> <li> <p> <a href="cookbook_uwsgi.html">uWSGI</a>: Setting up Cherokee for uWSGI. </p> </li> <li> <p> <a href="cookbook_http_to_https.html">HTTP to HTTPS</a>: How to redirect all traffic from HTTP to HTTPS. </p> </li> <li> <p> <a href="cookbook_traffic_restriction.html">Restricting traffic by IP</a>: How to restrict traffic based on incoming IP. </p> </li> <li> <p> <a href="cookbook_domain_matching.html">Domain matching</a>: Matching domains and subdomains with Cherokee. </p> </li> </ol></div> <div class="sidebarblock"> <div class="sidebar-content"> <div class="paragraph"><p><a href="modules.html">Modules</a>: Information about the standard modules</p></div> </div></div> <div class="olist arabic"><ol class="arabic"> <li> <p> <a href="modules_handlers.html">Handlers</a>: Connection handling modules. </p> <div class="ulist"><ul> <li> <p> <a href="modules_handlers_file.html">Static Content</a>: Send files. </p> </li> <li> <p> <a href="modules_handlers_dirlist.html">Only listing</a>: List directories. </p> </li> <li> <p> <a href="modules_handlers_common.html">List & Send</a>: List directories and send files. </p> </li> <li> <p> <a href="modules_handlers_custom_error.html">HTTP error</a>: Generate custom HTTP errors. </p> </li> <li> <p> <a href="modules_handlers_redir.html">Redirection</a>: URL forwards and rewrites. </p> </li> <li> <p> <a href="modules_handlers_cgi.html">CGI</a>: Common Gateway Interface. </p> </li> <li> <p> <a href="modules_handlers_fcgi.html">FastCGI</a>: Fast Common Gateway Interface. </p> </li> <li> <p> <a href="modules_handlers_scgi.html">SCGI</a>: Simple Common Gateway Interface. </p> </li> <li> <p> <a href="modules_handlers_uwsgi.html">uWSGI</a>: uWSGI protocol. </p> </li> <li> <p> <a href="modules_handlers_proxy.html">HTTP reverse proxy</a>: Surrogate/reverse proxy handler. </p> </li> <li> <p> <a href="modules_handlers_ssi.html">Server Side Includes</a>: SSI Server Support. </p> </li> <li> <p> <a href="modules_handlers_postreport.html">Upload Reporting</a>: Show an upload progress bar. </p> </li> <li> <p> <a href="modules_handlers_streaming.html">Audio/Video Streaming</a>: Media streamer. </p> </li> <li> <p> <a href="modules_handlers_secdownload.html">Hidden Downloads</a>: Secure, Time expiring downloads. </p> </li> <li> <p> <a href="modules_handlers_server_info.html">Server Info</a>: Provide info about Cherokee. </p> </li> <li> <p> <a href="modules_handlers_dbslayer.html">MySQL bridge</a>: MySQL over HTTP bridge. </p> </li> <li> <p> <a href="modules_handlers_admin.html">Remote Administration</a>: Cherokee administration handler. </p> </li> <li> <p> <a href="modules_handlers_empty_gif.html">1x1 Transparent GIF</a>: Returns a 1x1 pixel transparent GIF. </p> </li> <li> <p> <a href="modules_handlers_drop.html">Drop Connection</a>: Immediately drop TCP connection. </p> </li> </ul></div> </li> <li> <p> <a href="modules_validators.html">Validators</a>: Authentication mechanisms. </p> <div class="ulist"><ul> <li> <p> <a href="modules_validators_plain.html">Plain</a>: Plain file mechanism. </p> </li> <li> <p> <a href="modules_validators_htpasswd.html">htpasswd</a>: htpasswd mechanism. </p> </li> <li> <p> <a href="modules_validators_htdigest.html">htdigest</a>: htdigest mechanism. </p> </li> <li> <p> <a href="modules_validators_ldap.html">LDAP</a>: Lightweight Directory Acces Protocol mechanism. </p> </li> <li> <p> <a href="modules_validators_mysql.html">MySQL</a>: Database mechanism. </p> </li> <li> <p> <a href="modules_validators_pam.html">PAM</a>: Pluggable Authentication Module mechanism. </p> </li> <li> <p> <a href="modules_validators_authlist.html">Fixed list</a>: Fixed authentication list. </p> </li> </ul></div> </li> <li> <p> <a href="modules_encoders.html">Encoders</a>: Compression and filtering. </p> <div class="ulist"><ul> <li> <p> <a href="modules_encoders_gzip.html">gzip</a>: compress using gzip algorithm. </p> </li> <li> <p> <a href="modules_encoders_deflate.html">deflate</a>: compress using deflate algorithm. </p> </li> </ul></div> </li> <li> <p> <a href="modules_loggers.html">Loggers</a>: Logging mechanisms. </p> <div class="ulist"><ul> <li> <p> <a href="modules_loggers_combined.html">Combined</a>: Combined log format. </p> </li> <li> <p> <a href="modules_loggers_custom.html">Custom</a>: Customizable log format. </p> </li> <li> <p> <a href="modules_loggers_ncsa.html">Common (NCSA)</a>: Common log format. </p> </li> </ul></div> </li> <li> <p> <a href="modules_balancers.html">Balancers</a>: Load balancing strategies. </p> <div class="ulist"><ul> <li> <p> <a href="modules_balancers_round_robin.html">Round robin</a>: Round Robin strategy. </p> </li> <li> <p> <a href="modules_balancers_ip_hash.html">IP Hash</a>: Client IP hash strategy. </p> </li> <li> <p> <a href="modules_balancers_failover.html">Failover</a>: Failover server strategy. </p> </li> </ul></div> </li> </ol></div> <div class="sidebarblock"> <div class="sidebar-content"> <div class="paragraph"><p><a href="other.html">Other information</a>: Miscellaneous</p></div> </div></div> <div class="olist arabic"><ol class="arabic"> <li> <p> <a href="other_faq.html">FAQ</a>: List of Frequently Asked Questions. </p> </li> <li> <p> <a href="other_front_line_cache.html">Front-line Cache</a>: Specifics of the Caching subsystem. </p> </li> <li> <p> <a href="other_os_tuning.html">System Tuning</a>: Tweaking the OS for maximum performance. </p> </li> <li> <p> <a href="other_goodies.html">Cherokee Goodies</a>: Interesting Cherokee features. </p> </li> <li> <p> <a href="other_graphs.html">Usage graphs</a>: Information on the several graphs available. </p> </li> <li> <p> <a href="other_signals.html">Signals</a>: Signals supported by Cherokee. </p> </li> <li> <p> <a href="other_community.html">Community</a>: More information sources. </p> </li> <li> <p> <a href="other_errors.html">Common errors</a>: Some typical production errors and their cause. </p> </li> <li> <p> <a href="other_bundle.html">Man pages</a>: Details about each program bundled with Cherokee </p> <div class="ulist"><ul> <li> <p> <a href="other_bundle_cherokee.html">cherokee</a>: Main web server invoker. </p> </li> <li> <p> <a href="other_bundle_cherokee-admin-launcher.html">cherokee-admin-launcher</a>: Launcher for the configuration UI. </p> </li> <li> <p> <a href="other_bundle_cherokee-admin.html">cherokee-admin</a>: The configuration UI. </p> </li> <li> <p> <a href="other_bundle_cherokee-config.html">cherokee-config</a>: Information retriever. </p> </li> <li> <p> <a href="other_bundle_cherokee-tweak.html">cherokee-tweak</a>: Cherokee Swiss army knife </p> </li> <li> <p> <a href="other_bundle_cherokee-worker.html">cherokee-worker</a>: Web server stand alone program. </p> </li> <li> <p> <a href="other_bundle_cget.html">cget</a>: Web retriever. </p> </li> </ul></div> </li> </ol></div> <div class="sidebarblock"> <div class="sidebar-content"> <div class="paragraph"><p><a href="dev.html">Development info</a>: Things of interest to developers</p></div> </div></div> <div class="olist arabic"><ol class="arabic"> <li> <p> <a href="dev_quickstart.html">Quickstart</a>: Where to start?. </p> </li> <li> <p> <a href="dev_debug.html">Debugging</a>: Resources available to debug Cherokee. </p> </li> <li> <p> <a href="dev_cherokee.conf.html">cherokee.conf</a>: Internal configuration specs. </p> </li> <li> <p> <a href="dev_qa.html">Quality Assurance</a>: Some info about QA in Cherokee. </p> </li> <li> <p> <a href="dev_ctk.html">CTK</a>: Dive into the Cherokee Toolkit </p> </li> </ol></div> <div class="sidebarblock"> <div class="sidebar-content"> <div class="paragraph"><p><a href="distro.html">Cherokee’s Distribution</a>: Web Apps distribution on Cherokee</p></div> </div></div> <div class="olist arabic"><ol class="arabic"> <li> <p> <a href="distro_dev_intro.html">Introduction to Development</a>: How to build a package. </p> </li> </ol></div> </div> <div id="footer"> <div id="footer-text"> </div> </div> </body> </html>