Index: Cherokee 0.10 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.

  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. Optimizing Cherokee: Recommendations and tweaks.

  2. Cross compilation: How to cross compile Cherokee.

  3. Setting up Django: How to run Django apps with Cherokee.

  4. Setting up PHP: How to run PHP apps with Cherokee.

  5. Setting up RoR: How to run Ruby on Rails apps with Cherokee.

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

  7. Authentication: How to set up authenticated resources.

  8. Maintenance: Seamlessly switching to maintenance mode.

  9. Redirections: Common redirection examples.

  10. Embedding Cherokee: Cherokee on embedded devices.

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

Modules: Information about the standard modules.

  1. Handlers: Connection handling modules.

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

    • gzip: gzip compression.

    • deflate: deflate compression.

  4. Loggers: Logging mechanisms.

  5. Balancers: Load balancing strategies.

Other information: Miscellaneus.

Development info

  1. Debugging: Resources available to debug Cherokee.

  2. cherokee.conf: Internal configuration specs.

  3. Open issues: Current development issues.