Changeset 1786

Show
Ignore:
Timestamp:
08/12/08 20:01:37 (3 months ago)
Author:
taher
Message:

--

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • cherokee/trunk/ChangeLog

    r1785 r1786  
     12008-08-12  Taher Shihadeh <taher@unixwars.com> 
     2        * doc/cookbook_ror.txt, doc/cookbook_php.txt, 
     3        doc/cookbook_django.txt, doc/cookbook_optimizations.txt, 
     4        doc/modules_handlers_cgi.txt, doc/modules_handlers_fcgi.txt, 
     5        doc/modules_validators_mysql.txt, doc/modules_validators_ldap.txt, 
     6        doc/modules_validators_pam.txt, doc/other_goodies.txt: more 
     7        changes and some new docs. 
     8 
    192008-08-12  Alvaro Lopez Ortega  <alvaro@alobbs.com> 
    210 

  • cherokee/trunk/doc/Makefile.am

    r1776 r1786  
    1010 
    1111.txt.html: 
    12         $(ASCIIDOC) -o $@ $<  
     12        $(ASCIIDOC) $<  
    1313 
    1414docdir = $(datadir)/doc/cherokee 
    …… 
    4545cookbook_authentication.html \ 
    4646cookbook_ssl.html \ 
     47cookbook_optimizations.html \ 
     48cookbook_php.html \ 
     49cookbook_ror.html \ 
     50cookbook_django.html \ 
    4751modules.html \ 
    4852modules_balancers.html \ 

  • cherokee/trunk/doc/TOC.txt

    r1777 r1786  
    4242///// 
    4343  Reference table     <8>       link:cookbook_reference.html[] 
    44   Optimizing Cherokee <2>       link:cookbook_optimizing_cherokee.html[] 
     44  Optimizing Cherokee <2>       link:cookbook_optimizations.html[] <descriptors, iocache, x-sendfile, 
    4545///// 
    4646 
    …… 
    4949//// 
    5050  Embedding Cherokee  <9>       link:cookbook_embedding_cherokee.html[] 
    51   Managing logs       <5>       link:cookbook_managing_logs.html[] <rotations and cherokee-tweak?> 
     51  Managing logs       <5>       link:cookbook_managing_logs.html[] <backends, rotations and cherokee-tweak?> 
    5252  Authentication      [8] <3>   link:cookbook_authentication.html[Authentication] 
    5353  SSL/TLS, certs      [13]<6>   link:cookbook_ssl.html[] 
    54   Setting up PHP      <4>       link:cookbook_php.html[] 
     54//// 
     55  . link:cookbook_php.html[Setting up PHP] 
     56////// 
    5557  Setting up Django   <4>       link:cookbook_django.html[] 
    5658  Setting up RoR      <4>       link:cookbook_ror.html[] 
    57 //// 
     59////// 
    5860 
    5961********************************* 
    …… 
    8587    - link:modules_validators_htpasswd.html[htpasswd] 
    8688    - link:modules_validators_htdigest.html[htdigest] 
    87 ////// 
    88     - ldap               [7.1]  link:modules_validators_ldap.html[LDAP] 
    89     - mysql              [7.3]  link:modules_validators_mysql.html[MySQL] 
    90 ////// 
     89    - link:modules_validators_ldap.html[LDAP] 
     90    - link:modules_validators_mysql.html[MySQL] 
    9191    - link:modules_validators_pam.html[PAM] 
    9292 
    …… 
    9595********************************* 
    9696 
    97   FAQ 
    98   Community 
    9997  - link:other_goodies.html[Cherokee Goodies] 
     98//// 
     99  - FAQ 
     100  - Community 
     101//// 
    100102 
    101103********************************* 
    …… 
    106108  . link:dev_cherokee.conf.html[cherokee.conf] 
    107109//// 
    108   . API introduction           link:dev_api.html[] 
    109   . Examples                   link:dev_examples.html[] 
     110  . API introduction    link:dev_api.html[] 
     111  . Examples            link:dev_examples.html[] 
    110112//// 

  • cherokee/trunk/doc/modules_handlers_cgi.txt

    r1776 r1786  
    1818Change to UID         , String  , Executes each CGI under its owner's user ID. 
    1919Error handler         , Boolean , Use CGI output as error message. 
    20 Check file            , Boolean , Check whether the file exists to build PATH_INFO. 
     20Check file            , Boolean , Check file existence to build PATH_INFO. 
    2121Pass request          , Boolean , Pass request headers. 
    2222Allow X-Sendfile      , Boolean , Use the non-standard X-Sendfile header. 
    2323~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
     24 
     25Note that the link:other_goodies.html#x-sendfile[X-Sendfile] feature 
     26also supports `X-Accel-Redirect` headers transparently. This is to 
     27allow the migration of applications supporting it whithout having to 
     28make major code rewrites. 
     29 
     30Warning: 
     31~~~~~~~~ 
     32 
     33The `Check file` flag affects how PATH_INFO is generated. You should 
     34disable this when you have an application that is running the whole 
     35virtual server tree, as it is a common source of problems. You can 
     36look at a practical example about PATH_INFO in the 
     37link:modules_handlers_common.html[File & Send] handler documentation. 
    2438 
    2539Examples 

  • cherokee/trunk/doc/modules_handlers_fcgi.txt

    r1776 r1786  
    2323~~~~~~~~~~ 
    2424 
    25 The options common to link:modules_handlers_cgi.html[CGI] are: 
     25To set up the general gateway options, read about the common 
     26parameters shared with the link:modules_handlers_cgi.html[CGI] handler. 
    2627 
    27 [grid="rows"] 
    28 `~~~~~~~~~~~~~~~~`~~~~~~~~~~`~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
    29 Parameters            , Type           , Description 
    30 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
    31 Script Alias          , String  , It defines a kind of execution interpreter. \ 
    32                                   The CGI will be run as a parameter of this \ 
    33                                   script. 
    34 Change to UID         , String  , Executes each CGI under its owner's user ID. 
    35 Error handler         , Boolean , Use CGI output as error message. 
    36 Check file            , Boolean , Check whether the file exists to build PATH_INFO. 
    37 Pass request          , Boolean , Pass request headers. 
    38 Allow X-Sendfile      , Boolean , Use the non-standard X-Sendfile header. 
    39 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
    40  
    41 To setup the balancing options read the 
     28To set up the balancing options read the 
    4229link:modules_balancers.html[Balancers] section for general information 
    4330and the link:modules_balancers_round_robin.html[Round robin] section 
    …… 
    4633Examples 
    4734~~~~~~~~ 
    48 This example shows a typical usage of FastCGI. It connects to a 
    49 FastCGI server located in localhost in port 8002. If no server is 
    50 running, the webserver will run the FastCGI server by issuing the command 
    51 defined as the *Interpreter* sub-parameter: 
    52  
    53 image::media/images/admin_handler_fastcgi1.png[Fastcgi] 
    54  
    55 This example shows a typical usage of multiple FastCGI servers. It 
    56 connects to FastCGI servers located in several locations. If no 
    57 server is running in the local computer, the webserver will run the 
    58 FastCGI server by issuing the specified command. Note that for remote 
    59 FastCGI servers, you are responsible to run the FastCGI servers there 
    60 manually: 
    61  
    62 image::media/images/admin_handler_fastcgi2.png[Fastcgi] 
    63  
    64  
    65 Configuring PHP 
    66 ~~~~~~~~~~~~~~~ 
    67  
    68 The **PHP_FCGI_CHILDREN** environment variable is mandatory for PHP 
    69 FastCGI servers.  It defines how much children should serve the 
    70 requests coming from the webserver. 
    71  
    72 If you define **PHP_FCGI_MAX_REQUESTS**, the value should be negative 
    73 so that PHP would take as many requests as possible. If you leave it 
    74 unset, PHP will take the default value (500) and your 500th request 
    75 will be rejected and the FCGI handler will return an Error 500 
    76 (Internal server error) for it. 
    77  
     35Refer to the link:cookbook.html[Cookbook] if you want specific 
     36examples on how to configure this 
     37handler. The recipe about link:cookbook_php.html[setting up PHP] is a 
     38good starting point. 
    7839 
    7940Note for developers 

  • cherokee/trunk/doc/modules_validators_ldap.txt

    r1777 r1786  
    3434Example 
    3535^^^^^^^ 
    36 To be written 
     36 
     37Here is an example of what could be reflected in the 
     38link:dev_cherokee.conf.html[cherokee.conf] configuration file after 
     39setting up this authentication mechanism. Refer to the 
     40link:cookbook_authentication.html[Authentication] recipe for a full 
     41hands-on approach. 
     42 
     43---- 
     44vserver!10!rule!500!auth = ldap 
     45vserver!10!rule!500!auth!base_dn = Example DN 
     46vserver!10!rule!500!auth!bind_dn = Directory Manager 
     47vserver!10!rule!500!auth!bind_pw = secretpassword 
     48vserver!10!rule!500!auth!methods = basic 
     49vserver!10!rule!500!auth!port = 389 
     50vserver!10!rule!500!auth!realm = secret 
     51vserver!10!rule!500!auth!server = ldap.example.com 
     52vserver!10!rule!500!auth!tls = 0 
     53vserver!10!rule!500!match = directory 
     54vserver!10!rule!500!match!directory = /auth 
     55vserver!10!rule!500!match!final = 0 
     56vserver!10!rule!500!only_secure = 0 
     57---- 

  • cherokee/trunk/doc/modules_validators_mysql.txt

    r1647 r1786  
    1111Parameter                 , Description 
    1212~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
    13 __host__                  , Optional. The running that is running the      \ 
     13__host__                  , Optional. The server that is running the      \ 
    1414                            MySQL database server. Default: __localhost__. 
    1515__port__                  , Optional. The port that MySQL is listening on. \ 
    …… 
    4040Example 
    4141^^^^^^^ 
     42 
     43Here is an example of what could be reflected in the 
     44link:dev_cherokee.conf.html[cherokee.conf] configuration file after 
     45setting up this authentication mechanism. Refer to the 
     46link:cookbook_authentication.html[Authentication] recipe for a full 
     47hands-on approach. 
     48 
    4249---- 
    43     vserver!default!directory!/members!handler = mysql 
    44     vserver!default!directory!/members!handler!user = brian 
     50vserver!10!rule!500!auth = mysql 
     51vserver!10!rule!500!auth!database = auth_users 
     52vserver!10!rule!500!auth!host = localhost 
     53vserver!10!rule!500!auth!methods = basic,digest 
     54vserver!10!rule!500!auth!passwd = db_passwd 
     55vserver!10!rule!500!auth!port = 3306 
     56vserver!10!rule!500!auth!query = SELECT password FROM auth_users WHERE username= '${user}' 
     57vserver!10!rule!500!auth!realm = secret 
     58vserver!10!rule!500!auth!use_md5_passwd = 1 
     59vserver!10!rule!500!auth!user = db_user 
     60vserver!10!rule!500!match = directory 
     61vserver!10!rule!500!match!directory = /auth 
     62vserver!10!rule!500!match!final = 0 
     63vserver!10!rule!500!only_secure = 0 
    4564---- 

  • cherokee/trunk/doc/modules_validators_pam.txt

    r1777 r1786  
    2424restriction list is provided. 
    2525 
     26 
     27Here is an example of what could be reflected in the 
     28link:dev_cherokee.conf.html[cherokee.conf] configuration file after 
     29setting up this authentication mechanism. Refer to the 
     30link:cookbook_authentication.html[Authentication] recipe for a full 
     31hands-on approach. 
     32 
    2633---- 
    2734vserver!10!rule!500!auth = pam 

  • cherokee/trunk/doc/other_goodies.txt

    r1776 r1786  
    3131absolutely no cost. 
    3232 
     33Note that the X-Sendfile feature also supports `X-Accel-Redirect` 
     34header, a similar feature offered by other web servers. 
     35This is to allow the migration of applications supporting it whithout 
     36having to make major code rewrites. 
     37 
    3338 
    3439[zero-downtime]