## Cherokee 1.2 documentation

Getting started: Cherokee basics

1. Why Cherokee?: Feature overview.

2. Requirements: Hardware and software requirements.

3. Download: Where and how to download Cherokee.

4. 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 GIT: Installation of the development release.

5. Upgrading Cherokee: Upgrading from a previous release?

6. Running Cherokee: Basic steps to run Cherokee.

Configuration: Set up process explained

1. Walkthrough: Overview and walkthrough.

2. Home: Main section.

3. Market: Entry point to the Cherokee Market

4. Status: Server status information.

5. General: General settings.

6. 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.

7. Information Sources: Defining information sources.

8. Advanced: Advanced tweaking. Not for the faint of heart.

9. Wizards: Configuration assistants for many known scenarios.

Cookbook: Recipes for specific tasks

1. Authentication: How to set up authenticated resources.

2. Cross compilation: How to cross compile Cherokee.

3. DBSlayer: How to set up DBSlayer MySQL balancing.

4. Embedding Cherokee: Cherokee on embedded devices.

5. Maintenance: Seamlessly switching to maintenance mode.

6. Managing logs: Seamless log rotation.

7. Optimizing Cherokee: Recommendations and tweaks.

8. Redirections: Common redirection examples.

9. SSL/TLS, certs: Secure connection tips.

10. HTTPS accelerator: SSL Offloading with Cherokee.

11. Streaming: How to stream Audio and Video with Cherokee.

12. PHP: How to run PHP apps with Cherokee.

13. Ruby on Rails: How to run Ruby on Rails apps with Cherokee.

14. Django: How to run Django apps with Cherokee.

15. ColdFusion: How to run ColdFusion apps with Cherokee.

16. Drupal: How to run Drupal on Cherokee.

17. Wordpress: How to run Wordpress on Cherokee.

18. Alfresco: How to run Alfresco on Cherokee.

19. ASP.NET: How to run ASP.NET apps with Mono and Cherokee.

20. GlassFish: How to run Java apps with Cherokee.

21. Joomla: How to run Joomla on Cherokee.

22. Kumbia: How to run Kumbia apps with Cherokee.

23. Liferay: How to run Liferay on Cherokee.

24. Mailman: How to run Mailman on Cherokee.

25. Moodle: How to run Moodle on Cherokee.

26. Nagios: How to run Nagios with Cheroke.

27. phpBB: How to run phpBB on Cherokee.

28. phpMyAdmin: How to run phpMyAdmin on Cherokee.

29. SugarCRM: How to run SugarCRM on Cherokee.

30. Concrete5: How to run Concrete5 on Cherokee.

31. Symfony: How to run Symfony apps with Cherokee.

32. Trac: How to run Trac on Cherokee.

33. Zend: How to run Zend apps with Cherokee.

34. uWSGI: Setting up Cherokee for uWSGI.

35. HTTP to HTTPS: How to redirect all traffic from HTTP to HTTPS.

36. Restricting traffic by IP: How to restrict traffic based on incoming IP.

37. Domain matching: Matching domains and subdomains with Cherokee.

Modules: Information about the standard modules

1. 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.

2. 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.

3. Encoders: Compression and filtering.

   - gzip: compress using gzip algorithm.

   - deflate: compress using deflate algorithm.

4. Loggers: Logging mechanisms.

   - Combined: Combined log format.

   - Custom: Customizable log format.

   - Common (NCSA): Common log format.

5. Balancers: Load balancing strategies.

   - Round robin: Round Robin strategy.

   - IP Hash: Client IP hash strategy.

   - Failover: Failover server strategy.

Other information: Miscellaneous

1. FAQ: List of Frequently Asked Questions.

2. Front-line Cache: Specifics of the Caching subsystem.

3. System Tuning: Tweaking the OS for maximum performance.

4. Cherokee Goodies: Interesting Cherokee features.

5. Usage graphs: Information on the several graphs available.

6. Signals: Signals supported by Cherokee.

7. Community: More information sources.

8. Common errors: Some typical production errors and their cause.

9. 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

1. Quickstart: Where to start?.

2. Debugging: Resources available to debug Cherokee.

3. cherokee.conf: Internal configuration specs.

4. Quality Assurance: Some info about QA in Cherokee.

5. CTK: Dive into the Cherokee Toolkit

Cherokee’s Distribution: Web Apps distribution on Cherokee

1. Introduction to Development: How to build a package.