## Cherokee 0.98 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.

   - Unix: Installation on Unix/Linux platforms.

   - Windows: Installation on Windows platform.

   - From SVN: Installation of the development release.

5. Upgrading Cherokee: Upgrading from a previous release?

6. Running Cherokee: Basic steps to run Cherokee.

Cherokee Bundle: Details about each program bundled with Cherokee

1. cherokee: Main web server invoker.

2. cherokee-admin: The configuration UI.

3. cherokee-config: Information retriever.

4. cherokee-tweak: Cherokee Swiss army knife

5. cherokee-worker: Web server stand alone program.

6. cget: Web retriever.

Configuration: Set up process explained

1. Quickstart: Overview and walkthrough.

2. Status: Server status information.

3. General: General settings.

4. Virtual servers: Server definition.

   - Rule Options: Specifying the matching rules.

5. Information Sources: Defining information sources.

6. Icons: Icon managment.

7. Mime Types: Setting up the MIME types.

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

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. Alfresco: How to run Alfresco on Cherokee.

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

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

13. Drupal: How to run Drupal on Cherokee.

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

15. Joomla: How to run Joomla on Cherokee.

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

17. Liferay: How to run Liferay on Cherokee.

18. Mailman: How to run Mailman on Cherokee.

19. Moodle: How to run Moodle on Cherokee.

20. Nagios: How to run Nagios with Cheroke.

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

22. phpBB: How to run phpBB on Cherokee.

23. phpMyAdmin: How to run phpMyAdmin on Cherokee.

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

25. SugarCRM: How to run SugarCRM on Cherokee.

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

27. Trac: How to run Trac on Cherokee.

28. Wordpress: How to run Wordpress on Cherokee.

29. Zend: How to run Zend apps 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.

   - HTTP reverse proxy: Surrogate/reverse proxy handler.

   - Server Side Includes - SSI Server Support.

   - Audio/Video Streaming - Media streamer.

   - Server Info: Provide info about Cherokee.

   - MySQL bridge: MySQL over HTTP bridge.

   - Generic balancer: Load balancing module.

   - Remote Administration: Cherokee administration handler.

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.

   - Common (NCSA): Common Log Format.

   - w3c: W3C Log Format.

5. Balancers: Load balancing strategies.

   - Round robin: Round Robin strategy.

   - IP Hash: Client IP hash strategy.

Other information: Miscellaneus

1. FAQ: List of Frequently Asked Questions.

2. Cherokee Goodies: Interesting Cherokee features.

3. Signals: Signals supported by Cherokee.

4. Community: More information sources.

Development info: Things of interest to developers

1. Debugging: Resources available to debug Cherokee.

2. cherokee.conf: Internal configuration specs.

3. Open issues: Current development issues (proxy, wizards, extra ruletypes…)