Browse files

git-svn-id: svn://cherokee-project.com/cherokee/trunk@1816 5dc97367-9…

…7f1-0310-9951-d761b3857238
  • Loading branch information...
1 parent 3acfd92 commit 3c76ca4141a2b3a375d3d5c417df6f226bea53f4 taher committed Aug 14, 2008
Showing with 368 additions and 137 deletions.
  1. +39 −0 ChangeLog
  2. +29 −27 doc/Makefile.am
  3. +10 −8 doc/basics.txt
  4. +2 −0 doc/basics_download.txt
  5. +2 −0 doc/basics_installation.txt
  6. +3 −1 doc/basics_installation_unix.txt
  7. +2 −0 doc/basics_installation_windows.txt
  8. +3 −1 doc/basics_requirements.txt
  9. +2 −0 doc/basics_running_cherokee.txt
  10. +2 −0 doc/basics_upgrade.txt
  11. +2 −0 doc/basics_why_cherokee.txt
  12. +0 −1 doc/build/build_web.sh
  13. +0 −7 doc/build/doc.conf
  14. +1 −1 doc/build/web.conf
  15. +8 −6 doc/bundle.txt
  16. +4 −2 doc/bundle_cget.txt
  17. +4 −2 doc/bundle_cherokee-config.txt
  18. +4 −2 doc/bundle_cherokee-guardian.txt
  19. +4 −2 doc/bundle_cherokee-tweak.txt
  20. +4 −2 doc/bundle_cherokee.txt
  21. +4 −2 doc/bundle_spawn-fcgi.txt
  22. +10 −8 doc/config.txt
  23. +2 −0 doc/config_advanced.txt
  24. +2 −0 doc/config_encoding.txt
  25. +2 −0 doc/config_general.txt
  26. +2 −0 doc/config_icons.txt
  27. +2 −0 doc/config_mime_types.txt
  28. +2 −0 doc/config_quickstart.txt
  29. +2 −0 doc/config_virtual_servers.txt
  30. +2 −0 doc/config_virtual_servers_rule.txt
  31. +9 −7 doc/cookbook.txt
  32. +2 −0 doc/cookbook_authentication.txt
  33. +2 −0 doc/cookbook_cross_compilation.txt
  34. +2 −0 doc/cookbook_django.txt
  35. +2 −0 doc/cookbook_managing_logs.txt
  36. +2 −0 doc/cookbook_optimizations.txt
  37. +2 −0 doc/cookbook_php.txt
  38. +2 −0 doc/cookbook_ror.txt
  39. +2 −0 doc/cookbook_ssl.txt
  40. +4 −2 doc/dev.txt
  41. +2 −0 doc/dev_api.txt
  42. +4 −2 doc/dev_cherokee.conf.txt
  43. +4 −2 doc/dev_debug.txt
  44. +2 −0 doc/dev_examples.txt
  45. +68 −13 doc/index.txt
  46. +7 −2 doc/media/css/cherokee_doc.css
  47. +28 −28 doc/modules.txt
  48. +2 −0 doc/modules_balancers.txt
  49. +2 −0 doc/modules_balancers_round_robin.txt
  50. +2 −0 doc/modules_encoders.txt
  51. +2 −0 doc/modules_encoders_deflate.txt
  52. +2 −0 doc/modules_encoders_gzip.txt
  53. +2 −0 doc/modules_handlers.txt
  54. +2 −0 doc/modules_handlers_admin.txt
  55. +2 −0 doc/modules_handlers_cgi.txt
  56. +2 −0 doc/modules_handlers_common.txt
  57. +2 −0 doc/modules_handlers_dirlist.txt
  58. +2 −0 doc/modules_handlers_fcgi.txt
  59. +2 −0 doc/modules_handlers_file.txt
  60. +2 −0 doc/modules_handlers_mirror.txt
  61. +2 −0 doc/modules_handlers_redir.txt
  62. +2 −0 doc/modules_handlers_scgi.txt
  63. +2 −0 doc/modules_handlers_server_info.txt
  64. +2 −0 doc/modules_loggers.txt
  65. +2 −0 doc/modules_loggers_combined.txt
  66. +5 −2 doc/modules_loggers_ncsa.txt
  67. +2 −0 doc/modules_loggers_w3c.txt
  68. +2 −0 doc/modules_validators.txt
  69. +2 −0 doc/modules_validators_htdigest.txt
  70. +4 −2 doc/modules_validators_htpasswd.txt
  71. +3 −0 doc/modules_validators_ldap.txt
  72. +4 −2 doc/modules_validators_mysql.txt
  73. +2 −0 doc/modules_validators_pam.txt
  74. +2 −0 doc/modules_validators_plain.txt
  75. +3 −1 doc/other.txt
  76. +4 −2 doc/other_goodies.txt
View
39 ChangeLog
@@ -1,3 +1,42 @@
+2008-08-14 Taher Shihadeh <taher@unixwars.com>
+
+ * doc/basics_download.txt, doc/basics_installation.txt,
+ doc/basics_installation_unix.txt,
+ doc/basics_installation_windows.txt, doc/basics_requirements.txt,
+ doc/basics_running_cherokee.txt, doc/basics.txt,
+ doc/basics_upgrade.txt, doc/basics_why_cherokee.txt ,
+ doc/build/build_web.sh, doc/build/doc.conf, doc/build/web.conf,
+ doc/bundle_cget.txt, doc/bundle_cherokee-config.txt,
+ doc/bundle_cherokee-guardian.txt, doc/bundle_cherokee-tweak.txt,
+ doc/bundle_cherokee.txt, doc/bundle_spawn-fcgi.txt,
+ doc/bundle.txt, doc/config_advanced.txt, doc/config_encoding.txt,
+ doc/config_general.txt, doc/config_icons.txt,
+ doc/config_mime_types.txt, doc/config_quickstart.txt,
+ doc/config.txt, doc/config_virtual_servers_rule.txt,
+ doc/config_virtual_servers.txt, doc/cookbook_authentication.txt,
+ doc/cookbook_cross_compilation.txt, doc/cookbook_django.txt,
+ doc/cookbook_managing_logs.txt, doc/cookbook_optimizations.txt,
+ doc/cookbook_php.txt, doc/cookbook_ror.txt, doc/cookbook_ssl.txt,
+ doc/cookbook.txt, doc/dev_api.txt, doc/dev_cherokee.conf.txt,
+ doc/dev_debug.txt, doc/dev_examples.txt, doc/dev.txt,
+ doc/index.txt, doc/media/css/cherokee_doc.css,
+ doc/modules_balancers_round_robin.txt, doc/modules_balancers.txt,
+ doc/modules_encoders_deflate.txt, doc/modules_encoders_gzip.txt,
+ doc/modules_encoders.txt, doc/modules_handlers_admin.txt,
+ doc/modules_handlers_cgi.txt, doc/modules_handlers_common.txt,
+ doc/modules_handlers_dirlist.txt, doc/modules_handlers_fcgi.txt,
+ doc/modules_handlers_file.txt, doc/modules_handlers_mirror.txt,
+ doc/modules_handlers_redir.txt, doc/modules_handlers_scgi.txt,
+ doc/modules_handlers_server_info.txt, doc/modules_handlers.txt,
+ doc/modules_loggers_combined.txt, doc/modules_loggers_ncsa.txt,
+ doc/modules_loggers.txt, doc/modules_loggers_w3c.txt,
+ doc/modules.txt, doc/modules_validators_htdigest.txt,
+ doc/modules_validators_htpasswd.txt,
+ doc/modules_validators_ldap.txt, doc/modules_validators_mysql.txt,
+ doc/modules_validators_pam.txt, doc/modules_validators_plain.txt,
+ doc/modules_validators.txt, doc/other_goodies.txt, doc/other.txt:
+ hopefully that is enough documentation. For now anyway. :)
+
2008-08-14 Alvaro Lopez Ortega <alvaro@alobbs.com>
* qa/conf.py, qa/run-tests.py: Fixes the TLS/SSL execution.
View
56 doc/Makefile.am
@@ -1,17 +1,12 @@
ASCIIDOC=python $(top_srcdir)/doc/build/asciidoc.py --unsafe --conf-file=$(top_srcdir)/doc/build/doc.conf
-ASCIIDOC_TOC=python $(top_srcdir)/doc/build/asciidoc.py -s
-SUFFIXES = .txt .html .inc
-
-.txt.inc:
- $(ASCIIDOC_TOC) -o $@ $(top_srcdir)/doc/$<
+SUFFIXES = .txt .html
.txt.html:
$(ASCIIDOC) -o $@ $(top_srcdir)/doc/$<
docdir = $(datadir)/doc/cherokee
doc_DATA = \
-index.inc \
index.html \
basics.html \
basics_why_cherokee.html \
@@ -88,34 +83,41 @@ media/css/cherokee_doc.css
docmediaimagesdir = $(docdir)/media/images/
docmediaimages_DATA = \
-media/images/admin_handler_fastcgi2.png \
-media/images/admin_index.png \
-media/images/admin_handler_fastcgi1.png \
-media/images/admin_vserver.png \
-media/images/admin_vserver_errors.png \
-media/images/admin_icons3.png \
-media/images/admin_handler_file.png \
+media/images/admin_advanced.png \
media/images/admin_behaviour.png \
-media/images/admin_launch.png \
-media/images/admin_vserver_loggers.png \
-media/images/admin_handler_cgi.png \
-media/images/admin_icons2.png \
-media/images/admin_general.png \
-media/images/admin_icons1.png \
+media/images/admin_dirlist_cherokee.png \
+media/images/admin_encoding_gzip.png \
media/images/admin_encoding.png \
-media/images/admin_validators_plain.png \
-media/images/admin_validators_pam.png \
-media/images/admin_advanced.png \
-media/images/admin_handler_dirlist.png \
+media/images/admin_general.png \
+media/images/admin_handler_cgi.png \
media/images/admin_handler_dirlist_ex.png \
-media/images/admin_handler_onlylisting.png \
+media/images/admin_handler_dirlist.png \
+media/images/admin_handler_fastcgi1.png \
+media/images/admin_handler_fastcgi2.png \
+media/images/admin_handler_file.png \
media/images/admin_handler_onlylisting_ex.png \
+media/images/admin_handler_onlylisting.png \
+media/images/admin_icons1.png \
+media/images/admin_icons2.png \
+media/images/admin_icons3.png \
+media/images/admin_index.png \
media/images/admin_launch.png \
-media/images/tracelor.png \
-media/images/cherokee-tweak.png \
+media/images/admin_mime.png \
media/images/admin_noconfig.png \
media/images/admin_notrunning.png \
-media/images/admin_rule_regex.png
+media/images/admin_rule_regex.png \
+media/images/admin_validators_pam.png \
+media/images/admin_validators_plain.png \
+media/images/admin_vserver_errors.png \
+media/images/admin_vserver_loggers.png \
+media/images/admin_vserver.png \
+media/images/admin_vserver_vserver.png \
+media/images/cherokee-tweak.png \
+media/images/cookbook_django_common.png \
+media/images/cookbook_django_scgi.png \
+media/images/cookbook_ror_common.png \
+media/images/cookbook_ror_fcgi.png \
+media/images/tracelor.png
GENERATED_FILES = \
$(docdir_DATA)
View
18 doc/basics.txt
@@ -1,8 +1,10 @@
- . link:basics_why_cherokee.html[Why Cherokee?]
- . link:basics_requirements.html[Requirements]
- . link:basics_download.html[Download]
- . link:basics_installation.html[Installation]
- - link:basics_installation_unix.html[Unix]
- - link:basics_installation_windows.html[Windows]
- . link:basics_upgrade.html[Upgrading Cherokee]
- . link:basics_running_cherokee.html[Running Cherokee]
+== link:index.html[Index] -> Getting started
+
+ . link:basics_why_cherokee.html[Why Cherokee?]: Feature overview.
+ . link:basics_requirements.html[Requirements]: Hardware and software requirements.
+ . link:basics_download.html[Download]: Where and how to download Cherokee.
+ . link:basics_installation.html[Installation]: Installation instructions.
+ - link:basics_installation_unix.html[Unix]: Installation on Unix/Linux platforms.
+ - link:basics_installation_windows.html[Windows]: Installation on Windows platform.
+ . link:basics_upgrade.html[Upgrading Cherokee]: Upgrading from a previous release?
+ . link:basics_running_cherokee.html[Running Cherokee]: Basic steps to run Cherokee.
View
2 doc/basics_download.txt
@@ -1,3 +1,5 @@
+== link:index.html[Index] -> link:basics.html[Getting started]
+
Download
--------
View
2 doc/basics_installation.txt
@@ -1,3 +1,5 @@
+== link:index.html[Index] -> link:basics.html[Getting started]
+
Installation
------------
View
4 doc/basics_installation_unix.txt
@@ -1,3 +1,5 @@
+== link:index.html[Index] -> link:basics.html[Getting started] -> link:basics_installation.html[Installation]
+
Installation on Unix
--------------------
@@ -8,7 +10,7 @@ scripts, consistency and dependency checks, and an easy upgrade path
tailored to your system whenever a new package is available.
If you do not find a prepackaged version that suits your needs, you
-can always download and compile your own.
+can always download and compile your own.
Quickstart
~~~~~~~~~~
View
2 doc/basics_installation_windows.txt
@@ -1,3 +1,5 @@
+== link:index.html[Index] -> link:basics.html[Getting started] -> link:basics_installation.html[Installation]
+
Installation on Windows
-----------------------
View
4 doc/basics_requirements.txt
@@ -1,8 +1,10 @@
+== link:index.html[Index] -> link:basics.html[Getting started]
+
Requirements
------------
Hardware
-~~~~~~~~
+~~~~~~~~
Cherokee is very light, completely modular and it can be tailored to
your specific needs. As such, disk requirements will vary depending on
the options selected for the building process. A static build for
View
2 doc/basics_running_cherokee.txt
@@ -1,3 +1,5 @@
+== link:index.html[Index] -> link:basics.html[Getting started]
+
Running Cherokee
----------------
View
2 doc/basics_upgrade.txt
@@ -1,3 +1,5 @@
+== link:index.html[Index] -> link:basics.html[Getting started]
+
Upgrading Cherokee
------------------
View
2 doc/basics_why_cherokee.txt
@@ -1,3 +1,5 @@
+== link:index.html[Index] -> link:basics.html[Getting started]
+
Why Cherokee?
-------------
View
1 doc/build/build_web.sh
@@ -1,5 +1,4 @@
#!/bin/sh
-PACKAGE_VERSION=`grep "PACKAGE_VERSION = " ../Makefile| sed 's/\(.*\)PACKAGE_VERSION = //'`
# Layout for cherokee-project.com
ASCIIDOC_HTML="python asciidoc.py --conf-file=web.conf"
View
7 doc/build/doc.conf
@@ -17,15 +17,8 @@
<title>{doctitle=}</title>
</head>
<body>
-<div id="wrapper">
- <div id="page_content">
[footer]
- </div>
-</div>
-<div id="page_nav">
-include::../index.inc[]
-</div>
<div id="footer">
<div id="footer-text">
Last updated {localdate} {localtime}
View
2 doc/build/web.conf
@@ -1,5 +1,5 @@
[specialwords]
-emphasizedwords=(?u)\\?\bCherokee\b
+#emphasizedwords=(?u)\\?\bCherokee\b
[header]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
View
14 doc/bundle.txt
@@ -1,6 +1,8 @@
- . link:bundle_cherokee.html[cherokee]
- . link:bundle_cherokee-admin.html[cherokee-admin]
- . link:bundle_cherokee-config.html[cherokee-config]
- . link:bundle_cherokee-guardian.html[cherokee-guardian]
- . link:bundle_cherokee-tweak.html[cherokee-tweak]
- . link:bundle_cget.html[cget]
+== link:index.html[Index] -> Cherokee Bundle
+
+ . link:bundle_cherokee.html[cherokee]: The main program.
+ . link:bundle_cherokee-admin.html[cherokee-admin]: The configuration UI.
+ . link:bundle_cherokee-config.html[cherokee-config]: Information retriever.
+ . link:bundle_cherokee-guardian.html[cherokee-guardian]: Web server safe invoker.
+ . link:bundle_cherokee-tweak.html[cherokee-tweak]: Cherokee Swiss army knife
+ . link:bundle_cget.html[cget]: Web retriever.
View
6 doc/bundle_cget.txt
@@ -1,5 +1,7 @@
-cget
-----
+== link:index.html[Index] -> link:bundle.html[Cherokee Bundle]
+
+Cherokee Bundle: cget
+---------------------
This is an accessory tool developed for testing purposes of the
capabilities of Cherokee in the early releases. Over the time new
View
6 doc/bundle_cherokee-config.txt
@@ -1,5 +1,7 @@
-cherokee-config
----------------
+== link:index.html[Index] -> link:bundle.html[Cherokee Bundle]
+
+Cherokee Bundle: cherokee-config
+--------------------------------
This command-line tool is less known than the rest because it is to be
used by system administrators and developers. There is not much to be
View
6 doc/bundle_cherokee-guardian.txt
@@ -1,5 +1,7 @@
-cherokee-guardian
------------------
+== link:index.html[Index] -> link:bundle.html[Cherokee Bundle]
+
+Cherokee Bundle: cherokee-guardian
+----------------------------------
This command-line tool is less known than the rest because it is to be
used by system administrators and developers. There is not much to be
View
6 doc/bundle_cherokee-tweak.txt
@@ -1,5 +1,7 @@
-cherokee-tweak
---------------
+== link:index.html[Index] -> link:bundle.html[Cherokee Bundle]
+
+Cherokee Bundle: cherokee-tweak
+-------------------------------
This command-line tool is also not as well known as it whould. Again
this is not by a lack merits, which in fact are considerable. It's
View
6 doc/bundle_cherokee.txt
@@ -1,5 +1,7 @@
-cherokee
---------
+== link:index.html[Index] -> link:bundle.html[Cherokee Bundle]
+
+Cherokee Bundle: cherokee
+-------------------------
This is the main Cherokee program. It can be launched in several ways
as shown in the section link:basics_running_cherokee.txt[Running
View
6 doc/bundle_spawn-fcgi.txt
@@ -1,5 +1,7 @@
-spawn-fcgi
-----------
+== link:index.html[Index] -> link:bundle.html[Cherokee Bundle]
+
+Cherokee Bundle: spawn-fcgi
+---------------------------
This is a tool used to spawn FastCGI processes so that any FastCGI
application can be interfaced with Cherokee. This is, for example, how PHP is
View
18 doc/config.txt
@@ -1,8 +1,10 @@
- . link:config_quickstart.html[Quickstart]
- . link:config_general.html[General]
- . link:config_virtual_servers.html[Virtual servers]
- - link:config_virtual_servers_rule.html[Rule Options]
- . link:config_encoding.html[Encoding]
- . link:config_icons.html[Icons]
- . link:config_mime_types.html[Mime Types]
- . link:config_advanced.html[Advanced]
+== link:index.html[Index] -> Configuration
+
+ . link:config_quickstart.html[Quickstart]: Overview and walkthrough.
+ . link:config_general.html[General]: General settings.
+ . link:config_virtual_servers.html[Virtual servers]: Server definition.
+ - link:config_virtual_servers_rule.html[Rule Options]: Specifying the matching rules.
+ . link:config_encoding.html[Encoding]: Compression settings.
+ . link:config_icons.html[Icons]: Icon managment.
+ . link:config_mime_types.html[Mime Types]: Setting up the MIME types.
+ . link:config_advanced.html[Advanced]: Advanced tweaking. Not for the faint of heart.
View
2 doc/config_advanced.txt
@@ -1,3 +1,5 @@
+== link:index.html[Index] -> link:config.html[Configuration]
+
Advanced Configuration
----------------------
View
2 doc/config_encoding.txt
@@ -1,3 +1,5 @@
+== link:index.html[Index] -> link:config.html[Configuration]
+
Encoding
--------
View
2 doc/config_general.txt
@@ -1,3 +1,5 @@
+== link:index.html[Index] -> link:config.html[Configuration]
+
General Configuration
---------------------
View
2 doc/config_icons.txt
@@ -1,3 +1,5 @@
+== link:index.html[Index] -> link:config.html[Configuration]
+
Icons
-----
View
2 doc/config_mime_types.txt
@@ -1,3 +1,5 @@
+== link:index.html[Index] -> link:config.html[Configuration]
+
MIME Types
----------
View
2 doc/config_quickstart.txt
@@ -1,3 +1,5 @@
+== link:index.html[Index] -> link:config.html[Configuration]
+
Configuration Quickstart
------------------------
View
2 doc/config_virtual_servers.txt
@@ -1,3 +1,5 @@
+== link:index.html[Index] -> link:config.html[Configuration]
+
Virtual Server
--------------
View
2 doc/config_virtual_servers_rule.txt
@@ -1,3 +1,5 @@
+== link:index.html[Index] -> link:config.html[Configuration] -> link:config_virtual_servers.html[Virtual servers]
+
Virtual Server: Rules
---------------------
View
16 doc/cookbook.txt
@@ -1,7 +1,9 @@
- . link:cookbook_optimizations.html[Optimizing Cherokee]
- . link:cookbook_cross_compilation.html[Cross compilation]
- . link:cookbook_django.html[Setting up Django]
- . link:cookbook_php.html[Setting up PHP]
- . link:cookbook_ror.html[Setting up RoR]
- . link:cookbook_ssl.html[SSL/TLS, certs]
- . link:cookbook_authentication.html[Authentication]
+== link:index.html[Index] -> Cookbook
+
+ . link:cookbook_optimizations.html[Optimizing Cherokee]: Recommendations and tweaks.
+ . link:cookbook_cross_compilation.html[Cross compilation]: How to cross compile Cherokee.
+ . link:cookbook_django.html[Setting up Django]: How to run Django apps with Cherokee.
+ . link:cookbook_php.html[Setting up PHP]: How to run PHP apps with Cherokee.
+ . link:cookbook_ror.html[Setting up RoR]: How to run Ruby on Rails apps with Cherokee.
+ . link:cookbook_ssl.html[SSL/TLS, certs]: Secure connection tips.
+ . link:cookbook_authentication.html[Authentication]: How to set up authenticated resources.
View
2 doc/cookbook_authentication.txt
@@ -1,3 +1,5 @@
+== link:index.html[Index] -> link:cookbook.html[Cookbook]
+
Cookbook: Authentication
------------------------
View
2 doc/cookbook_cross_compilation.txt
@@ -1,3 +1,5 @@
+== link:index.html[Index] -> link:cookbook.html[Cookbook]
+
Cookbook: How to cross compile Cherokee
---------------------------------------
View
2 doc/cookbook_django.txt
@@ -1,3 +1,5 @@
+== link:index.html[Index] -> link:cookbook.html[Cookbook]
+
Cookbook: Setting up Django
---------------------------
View
2 doc/cookbook_managing_logs.txt
@@ -1,3 +1,5 @@
+== link:index.html[Index] -> link:cookbook.html[Cookbook]
+
Cookbook: Managing logs
-----------------------
View
2 doc/cookbook_optimizations.txt
@@ -1,3 +1,5 @@
+== link:index.html[Index] -> link:cookbook.html[Cookbook]
+
Cookbook: Optimizing Cherokee
-----------------------------
View
2 doc/cookbook_php.txt
@@ -1,3 +1,5 @@
+== link:index.html[Index] -> link:cookbook.html[Cookbook]
+
Cookbook: Setting up PHP
------------------------
View
2 doc/cookbook_ror.txt
@@ -1,3 +1,5 @@
+== link:index.html[Index] -> link:cookbook.html[Cookbook]
+
Cookbook: Setting up Ruby on Rails
----------------------------------
View
2 doc/cookbook_ssl.txt
@@ -1,3 +1,5 @@
+== link:index.html[Index] -> link:cookbook.html[Cookbook]
+
Cookbook: SSL, TLS and certificates
-----------------------------------
View
6 doc/dev.txt
@@ -1,2 +1,4 @@
- . link:dev_debug.html[Debugging]
- . link:dev_cherokee.conf.html[cherokee.conf]
+== link:index.html[Index] -> Development info
+
+ . link:dev_debug.html[Debugging]: Resources available to debug Cherokee.
+ . link:dev_cherokee.conf.html[cherokee.conf]: Internal configuration specs.
View
2 doc/dev_api.txt
@@ -1,3 +1,5 @@
+== link:index.html[Index] -> link:dev.html[Development info]
+
Development: API introduction
-----------------------------
View
6 doc/dev_cherokee.conf.txt
@@ -1,5 +1,7 @@
-Internal Configuration
-----------------------
+== link:index.html[Index] -> link:dev.html[Development info]
+
+Development: cherokee.conf
+--------------------------
Introduction
~~~~~~~~~~~~
View
6 doc/dev_debug.txt
@@ -1,5 +1,7 @@
-Debugging Cherokee
-------------------
+== link:index.html[Index] -> link:dev.html[Development info]
+
+Development: Debugging Cherokee
+-------------------------------
If you need to debug the behavior of the web server (or an
application), there are some helpful tools available for you.
View
2 doc/dev_examples.txt
@@ -1,3 +1,5 @@
+== link:index.html[Index] -> link:dev.html[Development info]
+
Development: Examples
---------------------
View
81 doc/index.txt
@@ -1,42 +1,96 @@
+== link:index.html[Index]: Cherokee 0.8 documentation
+
*********************************
-link:basics.html[Getting started]
+link:basics.html[Getting started]: Cherokee basics
*********************************
-include::basics.txt[]
+ . link:basics_why_cherokee.html[Why Cherokee?]: Feature overview.
+ . link:basics_requirements.html[Requirements]: Hardware and software requirements.
+ . link:basics_download.html[Download]: Where and how to download Cherokee.
+ . link:basics_installation.html[Installation]: Installation instructions.
+ - link:basics_installation_unix.html[Unix]: Installation on Unix/Linux platforms.
+ - link:basics_installation_windows.html[Windows]: Installation on Windows platform.
+ . link:basics_upgrade.html[Upgrading Cherokee]: Upgrading from a previous release?
+ . link:basics_running_cherokee.html[Running Cherokee]: Basic steps to run Cherokee.
*********************************
-link:bundle.html[Cherokee Bundle]
+link:bundle.html[Cherokee Bundle]: Details about each program bundled with Cherokee.
*********************************
-include::bundle.txt[]
+ . link:bundle_cherokee.html[cherokee]: The main program.
+ . link:bundle_cherokee-admin.html[cherokee-admin]: The configuration UI.
+ . link:bundle_cherokee-config.html[cherokee-config]: Information retriever.
+ . link:bundle_cherokee-guardian.html[cherokee-guardian]: Web server safe invoker.
+ . link:bundle_cherokee-tweak.html[cherokee-tweak]: Cherokee Swiss army knife
+ . link:bundle_cget.html[cget]: Web retriever.
*********************************
-link:config.html[Configuration]
+link:config.html[Configuration]: Set up process explained.
*********************************
-include::config.txt[]
+ . link:config_quickstart.html[Quickstart]: Overview and walkthrough.
+ . link:config_general.html[General]: General settings.
+ . link:config_virtual_servers.html[Virtual servers]: Server definition.
+ - link:config_virtual_servers_rule.html[Rule Options]: Specifying the matching rules.
+ . link:config_encoding.html[Encoding]: Compression settings.
+ . link:config_icons.html[Icons]: Icon managment.
+ . link:config_mime_types.html[Mime Types]: Setting up the MIME types.
+ . link:config_advanced.html[Advanced]: Advanced tweaking. Not for the faint of heart.
*********************************
-link:cookbook.html[Cookbook]
+link:cookbook.html[Cookbook]: Recipes for specific tasks.
*********************************
-include::cookbook.txt[]
+ . link:cookbook_optimizations.html[Optimizing Cherokee]: Recommendations and tweaks.
+ . link:cookbook_cross_compilation.html[Cross compilation]: How to cross compile Cherokee.
+ . link:cookbook_django.html[Setting up Django]: How to run Django apps with Cherokee.
+ . link:cookbook_php.html[Setting up PHP]: How to run PHP apps with Cherokee.
+ . link:cookbook_ror.html[Setting up RoR]: How to run Ruby on Rails apps with Cherokee.
+ . link:cookbook_ssl.html[SSL/TLS, certs]: Secure connection tips.
+ . link:cookbook_authentication.html[Authentication]: How to set up authenticated resources.
////
. link:cookbook_embedding_cherokee.html[Embedding Cherokee]
. link:cookbook_managing_logs.html[Managing logs]
////
*********************************
-link:modules.html[Modules]
+link:modules.html[Modules]: Information about the standard modules.
*********************************
-include::modules.txt[]
+ . link:modules_balancers.html[Balancers]: Load balancing strategies.
+ - link:modules_balancers_round_robin.html[Round robin]: Round Robin strategy.
+ . link:modules_encoders.html[Encoders]: Compression and filters.
+ - link:modules_encoders_gzip.html[gzip]: `gzip` compression.
+ - link:modules_encoders_deflate.html[deflate]: `deflate` compression.
+ . link:modules_handlers.html[Handlers]: Connection handling modules.
+ - link:modules_handlers_file.html[Static Content]: Send files..
+ - link:modules_handlers_dirlist.html[Only listing]: List directories.
+ - link:modules_handlers_common.html[List & Send]: List directories and send files.
+ - link:modules_handlers_redir.html[Redirection]: URL forwards and rewrites.
+ - link:modules_handlers_cgi.html[CGI]: Common Gateway Interface.
+ - link:modules_handlers_fcgi.html[FastCGI]: Fast Common Gateway Interface.
+ - link:modules_handlers_scgi.html[SCGI]: Simple Common Gateway Interface.
+ - link:modules_handlers_server_info.html[Server Info]: Provide info about Cherokee.
+ - link:modules_handlers_mirror.html[Generic balancer]: Load balancing module.
+ - link:modules_handlers_admin.html[Remote Administration]: Cherokee administration handler.
+ . link:modules_loggers.html[Loggers]: Logging mechanisms.
+ - link:modules_loggers_combined.html[Combined]: Combined Log Format.
+ - link:modules_loggers_ncsa.html[Common (NCSA)]: Common Log Format.
+ - link:modules_loggers_w3c.html[w3c]: W3C Log Format.
+ . link:modules_validators.html[Validators]: Authentication mechanisms.
+ - link:modules_validators_plain.html[Plain]: Plain file mechanism.
+ - link:modules_validators_htpasswd.html[htpasswd]: htpasswd mechanism.
+ - link:modules_validators_htdigest.html[htdigest]: htdigest mechanism.
+ - link:modules_validators_ldap.html[LDAP]: Lightweight Directory Acces Protocol mechanism.
+ - link:modules_validators_mysql.html[MySQL]: Database mechanism.
+ - link:modules_validators_pam.html[PAM]: Pluggable Authentication Module mechanism.
+
*********************************
-link:other.html[Other information]
+link:other.html[Other information]: Miscellaneus.
*********************************
-include::other.txt[]
+ - link:other_goodies.html[Cherokee Goodies]: Interesting Cherokee features.
////
- FAQ
- Community
@@ -46,7 +100,8 @@ include::other.txt[]
link:dev.html[Development info]
*********************************
-include::dev.txt[]
+ . link:dev_debug.html[Debugging]: Resources available to debug Cherokee.
+ . link:dev_cherokee.conf.html[cherokee.conf]: Internal configuration specs.
////
. link:dev_api.html[API introduction]
. link:dev_examples.html[Examples]
View
9 doc/media/css/cherokee_doc.css
@@ -84,13 +84,13 @@ tt {
h1, h2, h3, h4, h5, h6 {
color: #527bbd;
font-family: sans-serif;
- margin-top: 1.2em;
+ _margin-top: 1.2em;
margin-bottom: 0.5em;
line-height: 1.3;
}
h1, h2, h3 {
- border-bottom: 2px solid silver;
+ border-bottom: 1px solid silver;
}
h2 {
@@ -361,3 +361,8 @@ div.toclevel4 {
float:left;
background:#f6f6f6;
}
+
+/*Navigation bar*/
+#nav_bar {
+
+}
View
56 doc/modules.txt
@@ -1,29 +1,29 @@
+== link:index.html[Index] -> Modules
- . link:modules_balancers.html[Balancers]
- - link:modules_balancers_round_robin.html[Round robin]
- . link:modules_encoders.html[Encoders]
- - link:modules_encoders_gzip.html[gzip]
- - link:modules_encoders_deflate.html[deflate]
- . link:modules_handlers.html[Handlers]
- - link:modules_handlers_file.html[Static Content]
- - link:modules_handlers_dirlist.html[Only listing]
- - link:modules_handlers_common.html[List & Send]
- - link:modules_handlers_redir.html[Redirection]
- - link:modules_handlers_cgi.html[CGI]
- - link:modules_handlers_fcgi.html[FastCGI]
- - link:modules_handlers_scgi.html[SCGI]
- - link:modules_handlers_server_info.html[Server Info]
- - link:modules_handlers_mirror.html[Generic balancer]
- - link:modules_handlers_admin.html[Remote Administration]
- . link:modules_loggers.html[Loggers]
- - link:modules_loggers_combined.html[Combined]
- - link:modules_loggers_ncsa.html[Common (NCSA)]
- - link:modules_loggers_w3c.html[w3c]
- . link:modules_validators.html[Validators]
- - link:modules_validators_plain.html[Plain]
- - link:modules_validators_htpasswd.html[htpasswd]
- - link:modules_validators_htdigest.html[htdigest]
- - link:modules_validators_ldap.html[LDAP]
- - link:modules_validators_mysql.html[MySQL]
- - link:modules_validators_pam.html[PAM]
-
+ . link:modules_balancers.html[Balancers]: Load balancing strategies.
+ - link:modules_balancers_round_robin.html[Round robin]: Round Robin strategy.
+ . link:modules_encoders.html[Encoders]: Compression and filters.
+ - link:modules_encoders_gzip.html[gzip]: `gzip` compression.
+ - link:modules_encoders_deflate.html[deflate]: `deflate` compression.
+ . link:modules_handlers.html[Handlers]: Connection handling modules.
+ - link:modules_handlers_file.html[Static Content]: Send files..
+ - link:modules_handlers_dirlist.html[Only listing]: List directories.
+ - link:modules_handlers_common.html[List & Send]: List directories and send files.
+ - link:modules_handlers_redir.html[Redirection]: URL forwards and rewrites.
+ - link:modules_handlers_cgi.html[CGI]: Common Gateway Interface.
+ - link:modules_handlers_fcgi.html[FastCGI]: Fast Common Gateway Interface.
+ - link:modules_handlers_scgi.html[SCGI]: Simple Common Gateway Interface.
+ - link:modules_handlers_server_info.html[Server Info]: Provide info about Cherokee.
+ - link:modules_handlers_mirror.html[Generic balancer]: Load balancing module.
+ - link:modules_handlers_admin.html[Remote Administration]: Cherokee administration handler.
+ . link:modules_loggers.html[Loggers]: Logging mechanisms.
+ - link:modules_loggers_combined.html[Combined]: Combined Log Format.
+ - link:modules_loggers_ncsa.html[Common (NCSA)]: Common Log Format.
+ - link:modules_loggers_w3c.html[w3c]: W3C Log Format.
+ . link:modules_validators.html[Validators]: Authentication mechanisms.
+ - link:modules_validators_plain.html[Plain]: Plain file mechanism.
+ - link:modules_validators_htpasswd.html[htpasswd]: htpasswd mechanism.
+ - link:modules_validators_htdigest.html[htdigest]: htdigest mechanism.
+ - link:modules_validators_ldap.html[LDAP]: Lightweight Directory Acces Protocol mechanism.
+ - link:modules_validators_mysql.html[MySQL]: Database mechanism.
+ - link:modules_validators_pam.html[PAM]: Pluggable Authentication Module mechanism.
View
2 doc/modules_balancers.txt
@@ -1,3 +1,5 @@
+== link:index.html[Index] -> link:modules.html[Modules]
+
Modules: Balancers
------------------
View
2 doc/modules_balancers_round_robin.txt
@@ -1,3 +1,5 @@
+== link:index.html[Index] -> link:modules.html[Modules] -> link:modules_balancers.html[Balancers]
+
Balancer: Round Robin
---------------------
View
2 doc/modules_encoders.txt
@@ -1,3 +1,5 @@
+== link:index.html[Index] -> link:modules.html[Modules]
+
Modules: Enconders
------------------
View
2 doc/modules_encoders_deflate.txt
@@ -1,3 +1,5 @@
+== link:index.html[Index] -> link:modules.html[Modules] -> link:modules_encoders.html[Encoders]
+
Enconder: deflate
-----------------
View
2 doc/modules_encoders_gzip.txt
@@ -1,3 +1,5 @@
+== link:index.html[Index] -> link:modules.html[Modules] -> link:modules_encoders.html[Encoders]
+
Enconder: Gzip
--------------
View
2 doc/modules_handlers.txt
@@ -1,3 +1,5 @@
+== link:index.html[Index] -> link:modules.html[Modules]
+
Modules: Handlers
-----------------
View
2 doc/modules_handlers_admin.txt
@@ -1,3 +1,5 @@
+== link:index.html[Index] -> link:modules.html[Modules] -> link:modules_handlers.html[Handlers]
+
Handler: Remote Administration
------------------------------
View
2 doc/modules_handlers_cgi.txt
@@ -1,3 +1,5 @@
+== link:index.html[Index] -> link:modules.html[Modules] -> link:modules_handlers.html[Handlers]
+
Handler: CGI
------------
View
2 doc/modules_handlers_common.txt
@@ -1,3 +1,5 @@
+== link:index.html[Index] -> link:modules.html[Modules] -> link:modules_handlers.html[Handlers]
+
Handler: List & Send
--------------------
View
2 doc/modules_handlers_dirlist.txt
@@ -1,3 +1,5 @@
+== link:index.html[Index] -> link:modules.html[Modules] -> link:modules_handlers.html[Handlers]
+
Handler: Directory Listing
--------------------------
View
2 doc/modules_handlers_fcgi.txt
@@ -1,3 +1,5 @@
+== link:index.html[Index] -> link:modules.html[Modules] -> link:modules_handlers.html[Handlers]
+
Handler: FastCGI
----------------
View
2 doc/modules_handlers_file.txt
@@ -1,3 +1,5 @@
+== link:index.html[Index] -> link:modules.html[Modules] -> link:modules_handlers.html[Handlers]
+
Handler: Static Content
-----------------------
View
2 doc/modules_handlers_mirror.txt
@@ -1,3 +1,5 @@
+== link:index.html[Index] -> link:modules.html[Modules] -> link:modules_handlers.html[Handlers]
+
Handler: Generic Balancer
-------------------------
View
2 doc/modules_handlers_redir.txt
@@ -1,3 +1,5 @@
+== link:index.html[Index] -> link:modules.html[Modules] -> link:modules_handlers.html[Handlers]
+
Handler: Redirection
--------------------
View
2 doc/modules_handlers_scgi.txt
@@ -1,3 +1,5 @@
+== link:index.html[Index] -> link:modules.html[Modules] -> link:modules_handlers.html[Handlers]
+
Handler: SCGI
-------------
View
2 doc/modules_handlers_server_info.txt
@@ -1,3 +1,5 @@
+== link:index.html[Index] -> link:modules.html[Modules] -> link:modules_handlers.html[Handlers]
+
Handler: Server Info
--------------------
The Server Info handler is used to create rules that can provide
View
2 doc/modules_loggers.txt
@@ -1,3 +1,5 @@
+== link:index.html[Index] -> link:modules.html[Modules]
+
Modules: Loggers
----------------
View
2 doc/modules_loggers_combined.txt
@@ -1,3 +1,5 @@
+== link:index.html[Index] -> link:modules.html[Modules] -> link:modules_loggers.html[Loggers]
+
Logger: Combined
~~~~~~~~~~~~~~~~
View
7 doc/modules_loggers_ncsa.txt
@@ -1,5 +1,8 @@
-NCSA
-~~~~
+== link:index.html[Index] -> link:modules.html[Modules] -> link:modules_loggers.html[Loggers]
+
+Logger: NCSA
+~~~~~~~~~~~~
+
Also known as the _Common log format_ (*CLF*). This is a standard
format produced by many web servers and read by many log analysis
tools. Some of the fields specified by the format might actually be
View
2 doc/modules_loggers_w3c.txt
@@ -1,3 +1,5 @@
+== link:index.html[Index] -> link:modules.html[Modules] -> link:modules_loggers.html[Loggers]
+
Logger: W3C
~~~~~~~~~~~
View
2 doc/modules_validators.txt
@@ -1,3 +1,5 @@
+== link:index.html[Index] -> link:modules.html[Modules]
+
Modules: Validators
-------------------
View
2 doc/modules_validators_htdigest.txt
@@ -1,3 +1,5 @@
+== link:index.html[Index] -> link:modules.html[Modules] -> link:modules_validators.html[Validators]
+
Validator: Htdigest
~~~~~~~~~~~~~~~~~~~
View
6 doc/modules_validators_htpasswd.txt
@@ -1,5 +1,7 @@
-Htpasswd Validator
-~~~~~~~~~~~~~~~~~~
+== link:index.html[Index] -> link:modules.html[Modules] -> link:modules_validators.html[Validators]
+
+Validator: Htpasswd
+~~~~~~~~~~~~~~~~~~~
This validator uses htpasswd files, which are very common on Apache
web sever environments. It stores one line per entry with the user
View
3 doc/modules_validators_ldap.txt
@@ -1,5 +1,8 @@
+== link:index.html[Index] -> link:modules.html[Modules] -> link:modules_validators.html[Validators]
+
Validator: LDAP
~~~~~~~~~~~~~~~
+
The LDAP validator allows you to authenticate a user using the
Lightweight Directory Access Protocol v3.
View
6 doc/modules_validators_mysql.txt
@@ -1,5 +1,7 @@
-Mysql Validator
-~~~~~~~~~~~~~~~
+== link:index.html[Index] -> link:modules.html[Modules] -> link:modules_validators.html[Validators]
+
+Validator: Mysql
+~~~~~~~~~~~~~~~~
The MySQL validator allows you to authenticate a user against a MySQL database.
View
2 doc/modules_validators_pam.txt
@@ -1,3 +1,5 @@
+== link:index.html[Index] -> link:modules.html[Modules] -> link:modules_validators.html[Validators]
+
Validator: PAM
~~~~~~~~~~~~~~
View
2 doc/modules_validators_plain.txt
@@ -1,3 +1,5 @@
+== link:index.html[Index] -> link:modules.html[Modules] -> link:modules_validators.html[Validators]
+
Validator: Plain
~~~~~~~~~~~~~~~~
View
4 doc/other.txt
@@ -1 +1,3 @@
- - link:other_goodies.html[Cherokee Goodies]
+== link:index.html[Index] -> Other information
+
+ - link:other_goodies.html[Cherokee Goodies]: Interesting Cherokee features.
View
6 doc/other_goodies.txt
@@ -1,5 +1,7 @@
-Cherokee goodies
-----------------
+== link:index.html[Index] -> link:other.html[Other information]
+
+Other: Cherokee goodies
+-----------------------
There are several important features of Cherokee that really do make a
difference in real-world production environments.

0 comments on commit 3c76ca4

Please sign in to comment.