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

…7f1-0310-9951-d761b3857238

ChangeLog

@@ -1,3 +1,12 @@
+2009-01-19 Taher Shihadeh  <taher@unixwars.com>
+
+	* doc/dev_debug.txt, doc/basics_why_cherokee.txt,
+	doc/config_general.txt, doc/index.txt, doc/config_quickstart.txt,
+	doc/modules_handlers_file.txt, doc/cookbook_optimizations.txt,
+	doc/bundle_cherokee-admin.txt, doc/dev_cherokee.conf.txt,
+	doc/modules.txt, doc/modules_balancers_ip_hash.txt: documentation
+	updates for the upcomming 0.98
+
 2009-01-19  Alvaro Lopez Ortega  <alvaro@octality.com>
 
 	* cherokee/main_admin.c (config_server): Adds a few basic MIME
@@ -26,7 +35,7 @@
 	* doc/modules_balancers.txt, doc/modules_balancers_ip_hash.txt,
 	doc/Makefile.am: Adds some basic documentation about the IP Hash
 	load balancer.
-	
+
 	* cherokee/handler_server_info.c (AJAX_JS): Fixes a Javascript
 	parsing error. 'default' is a reserved work, so it cannot be used
 	as a dict index without quotes.
@@ -53,8 +62,8 @@
 
 2009-01-15  Jonathan Hernandez  <ion@suavizado.com>
 
-	* cherokee/handler_server_info.c: Enhacements to CSS, 
-        Use Javascript DOM to generate the info page instead innerHTML. 
+	* cherokee/handler_server_info.c: Enhacements to CSS, Use
+	Javascript DOM to generate the info page instead innerHTML.
 
 2009-01-15  Alvaro Lopez Ortega  <alvaro@octality.com>
 
@@ -214,7 +223,7 @@
 	configure.in, admin/consts.py, admin/Makefile.am,
 	admin/ModuleIpHash.py: Adds a new load balancer. It implements a
 	new balancing strategy by which load is balanced among the
-	back-end server based on the client IP. All the request comming
+	back-end server based on the client IP. All the request coming
 	from the same IP will be delivered to the same back-end server.
 
 2009-01-03  Alvaro Lopez Ortega  <alvaro@octality.com>
@@ -353,7 +362,7 @@
 
 	* cherokee/server.c: Print more information as part of the banner:
 	The bound ports, tracing, and I/O cache support are now included.
-	
+
 	* cherokee/trace.c: Adds a shorter path for CHEROKEE_TRACE=all.
 
 2008-12-29  Alvaro Lopez Ortega  <alvaro@octality.com>

doc/basics_why_cherokee.txt

@@ -3,7 +3,7 @@
 Why Cherokee?
 -------------
 
-Welcome to the Cherokee 0.11 documentation. Cherokee is a
+Welcome to the Cherokee 0.98 documentation. Cherokee is a
 high-performance web server. It is very fast, flexible and easy to
 configure. In fact, it is the fastest web server there is. Check out
 the link:http://www.cherokee-project.com/benchmarks.html[benchmarks]

doc/bundle_cherokee-admin.txt

@@ -29,11 +29,11 @@ no future accesses will be possible.
 ----
 Login:
   User:              admin
-  One-time Password: 72O3GRxZfTrE2zHx
+  One-time Password: F4c7cyogxhTGbp1r
 
-Cherokee Web Server 0.11.0 (Nov 13 2008): Listening on port 9090, TLS disabled,
-IPv6 disabled, using epoll, 1024 fds system limit, max. 505 connections,
-single thread
+Cherokee Web Server 0.98.0b2721 (Jan 19 2009): Listening on port 127.0.0.1:9090,
+TLS disabled, IPv6 disabled, using epoll, 1024 fds system limit, max. 505
+connections, caching I/O, single thread
 ----
 
 Then redirect your web browser to 127.0.0.1:9090, which is the default

doc/config_general.txt

@@ -4,8 +4,8 @@ General Configuration
 ---------------------
 
 [[networking]]
-Networking
-~~~~~~~~~~
+Network
+~~~~~~~
 
 image::media/images/admin_general_networking.png[General]
 
@@ -18,7 +18,7 @@ compiled with IPv6 support (--with-ipv6), this configuration entry
 will be fully functional, otherwise it will be ignored.
 
 
-TLS/SSL Back-end
+SSL/TLS Back-end
 ^^^^^^^^^^^^^^^^
 Specifies the TLS/SSL backend to be used, if any. The current option
 is OpenSSL.
@@ -56,14 +56,14 @@ Ports to listen
 
 image::media/images/admin_general_ports.png[Ports to listen]
 
-This section allows to configure the port that the server will listen
-to.
+This section allows to configure the ports that the server will be
+listening to. You can add several different ports, and configure
+whether they will be used for HTTP or HTTPS.
 
 Each binding entry can be configured to listen to a network
 interface. In case the text entry is empty, the server will accept
 connection from the port on any interface.
 
-
 [[server_permissions]]
 Server Permissions
 ~~~~~~~~~~~~~~~~~~

doc/config_quickstart.txt

@@ -77,11 +77,11 @@ administration tool, so you will need system administrator rights.
 
 Login:
   User:              admin
-  One-time Password: 72O3GRxZfTrE2zHx
+  One-time Password: yp7F1pMhtmD58DbB
 
-Cherokee Web Server 0.11.0 (Nov 13 2008):: Listening on port 9090, TLS disabled,
-IPv6 disabled, using epoll, 1024 fds system limit, max. 505 connections,
-single thread
+Cherokee Web Server 0.98.0b2721 (Jan 19 2009): Listening on port 127.0.0.1:9090,
+TLS disabled, IPv6 disabled, using epoll, 1024 fds system limit, max. 505
+connections, caching I/O, single thread
 ----
 
 Now you can access the administration interface simply by opening your

doc/cookbook_optimizations.txt

@@ -17,13 +17,12 @@ into your specific Cherokee build. This can be done by:
 ----
 $ cherokee -i
 Compilation
- Version: 0.11.0
+ Version: 0.98.0
 
 [...]
 
 Support
  IPv6: yes
- OpenSSL: no
  Pthreads: yes
  Tracing: yes
  sendfile(): yes

doc/dev_cherokee.conf.txt

@@ -31,7 +31,7 @@ contain values.
 Let's see a basic example::
 +
 ----
-    server!port = 80
+    server!bind!1!port = 80
     server!keepalive = 1
 ----
 
@@ -57,9 +57,9 @@ is run as root or whether to use keep-alive connections.
 ```~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 **Key**,                          **Type**, **Description**
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-server!port,                      Number         , TCP port for HTTP
-server!tls,                       String         , TLS/SSL backend: libssl
-server!port_tls,                  Number         , TCP port for HTTPS
+server!bind!#!port,               Number         , Listen to a TCP port. '#' is a secuential \
+                                                   number since many ports can be listened at once.
+server!bind!#!tls,                Bool           , on|off: whether the listened port '#' is for HTTPS.
 server!max_fds,                   Number         , Max open file descriptors
 server!listen_queue,              Number         , Length of the listen queue
 server!thread_number,             Number         , Number of threads
@@ -93,10 +93,10 @@ server!module_deps,               Path           , Path to the plug-in inter-dep
 Value                     , Description
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Product                   , Cherokee
-Minor                     , Cherokee/0.11
-Minimal                   , Cherokee/0.11.0
-OS                        , Cherokee/0.11.0 (UNIX)
-Full                      , Cherokee/0.11.0 b2311 (UNIX)
+Minor                     , Cherokee/0.98
+Minimal                   , Cherokee/0.98.0
+OS                        , Cherokee/0.98.0 (UNIX)
+Full                      , Cherokee/0.98.0 b2721 (UNIX)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 ``server!thread_policy`` parameters
@@ -566,7 +566,7 @@ might wish to rewrite in the headers before relaying the connection.
 This is a basic example:
 
 ----
-server!port = 1234
+server!bind!1!port = 1234
 
 # The proxy configuration
 vserver!1!nick = default

doc/dev_debug.txt

@@ -56,11 +56,13 @@ CHEROKEE_TRACE variable, with the desired options:
 ****
 cherokee# CHEROKEE_TRACE="common" cherokee
 
-Cherokee Web Server 0.11.0 (Nov 13 2008): Listening on port 80, TLS disabled,
+Cherokee Web Server 0.98.0 (Jan 19 2009): Listening on ports ALL:80,
 
-IPv6 enabled, using epoll, 1024 fds system limit, max. 505 connections, 10
+ALL:443(TLS), TLS disabled, IPv6 enabled, using epoll, 1024 fds system
 
-threads, 50 connections per thread, standard scheduling policy
+limit, max. 505 connections, caching I/O, 10 threads, 50 connections per
+
+thread, standard scheduling policy, tracing 'common'
 
 handler_common.c:0143 (                     stat_file): /var/www//images/powered_by_cherokee.png, use_iocache=0 re=0
 

doc/index.txt

@@ -1,4 +1,4 @@
-== Cherokee 0.11 documentation
+== Cherokee 0.98 documentation
 
 *********************************
 link:basics.html[Getting started]: Cherokee basics

doc/modules.txt

@@ -1,14 +1,10 @@
 == link:index.html[Index] -> Modules
 
-  . 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 filtering.
-    - link:modules_encoders_gzip.html[gzip]: compress using gzip algorithm.
-    - link:modules_encoders_deflate.html[deflate]: compress using deflate algorithm.
   . 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_custom_error.html[HTTP error]: Generate custom HTTP errors.
     - 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.
@@ -19,10 +15,6 @@
     - link:modules_handlers_dbslayer.html[MySQL bridge]: MySQL over HTTP bridge.
     - 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.
@@ -31,3 +23,13 @@
     - link:modules_validators_mysql.html[MySQL]: Database mechanism.
     - link:modules_validators_pam.html[PAM]: Pluggable Authentication Module mechanism.
     - link:modules_validators_authlist.html[Fixed list]: Fixed authentication list.
+  . link:modules_encoders.html[Encoders]: Compression and filtering.
+    - link:modules_encoders_gzip.html[gzip]: compress using gzip algorithm.
+    - link:modules_encoders_deflate.html[deflate]: compress using deflate algorithm.
+  . 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_balancers.html[Balancers]: Load balancing strategies.
+    - link:modules_balancers_round_robin.html[Round robin]: Round Robin strategy.
+    - link:modules_balancers_ip_hash.html[IP Hash]: Client IP hash strategy.

doc/modules_balancers_ip_hash.txt

@@ -3,7 +3,7 @@
 Balancer: IP Hash
 -----------------
 
-The IP Hash load balancer modules distributes the incoming requests
+The IP Hash load balancer module distributes the incoming requests
 among the upstreams based on the IP address of the client. This method
 guarantees that the client request will always be transferred to the
 same server.

doc/modules_handlers_file.txt

@@ -31,5 +31,7 @@ Lets imagine your virtual server DocumentRoot points to /var/www.
 
 image::media/images/admin_handler_file.png[Handler file]
 
-This configuration will make Cherokee to serve each file inside
-/var/www_static/images as files.
+This is a simple example that will make Cherokee able of serving each
+CSS file under /var/www or any subdirectory with the IO/cache setting
+enabled. This would only not apply if a `final` rule with higher
+priority specified otherwise.