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: Directory Listing

The Only Listing handler builds a list of directories and files within the requested directory, but does not allow you to download its contents. Refer to List & Send for the opposite behavior.

Parameters: Listing

Parameters	Type	Description
`size`	boolean	Optional. Display the size of files in the listings. Default: `Enabled`.
`date`	boolean	Optional. Display the last modification date of the files and directories in the listings. Default: `Enabled`.
`user`	boolean	Optional. Display the owner of the files and directories in the listings. Default: `Disabled`.
`group`	boolean	Optional. Display the group ownership of the files and directories in the listings. Default `Disabled`.
`symlinks`	boolean	Optional. Display symbolic links. Default `Enabled`.

Parameters: Theming

Parameters	Type	Description
`theme`	string	Optional. The theme to use when displaying the directory listings. Default: `default`.
`icon_dir`	string	Optional: Alternative path to a new icon set.
`notice_files`	string	Optional: List of notice files to be inserted.

It is possible to change the default theme used when displaying the directory listings.

It is also possible to create a new one

   $ ls /usr/share/cherokee/themes/firefox3/
   entry.html  footer.html  header.html  theme.css

Simply create a new directory in the above mentioned path containing the listed files and you’ll be able to select it in cherokee-admin.

Examples

This is just one of many possible configurations.

Sample configuration
Field	Value
Handler	`Only listing`
Document Root	None
Show Size	Enabled
Show Date	Enabled
Show User	Disabled
Show Group	Disabled
Show Backup files	Disabled
Show Hidden files	Disabled
Allow symbolic links	Enabled
Redirect symbolic links	Disabled
Theme	`default`

media/images/admin_handler_onlylisting.png

Sample configuration screenshot

The output given by such configuration is a simple directory listing that can be sorted by any of its columns.

media/images/admin_handler_onlylisting_ex.png