Changeset 1773

Show
Ignore:
Timestamp:
08/08/08 21:20:20 (4 months ago)
Author:
taher
Message:

--

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • cherokee/trunk/ChangeLog

    r1771 r1773  
     12008-08-08  Taher Shihadeh <taher@unixwars.com> 
     2 
     3        * doc/modules_handlers_cgi.txt, doc/modules_validators.txt, 
     4        doc/modules_handlers_common.txt, doc/modules_handlers_fcgi.txt, 
     5        doc/modules_balancers.txt, doc/modules_handlers.txt, 
     6        doc/basics_why_cherokee.txt, doc/modules_handlers_redir.txt, 
     7        doc/config_quickstart.txt, doc/modules_handlers_file.txt, 
     8        doc/modules_loggers.txt, doc/modules_handlers_dirlist.txt, 
     9        doc/other_goodies.txt, doc/modules_encoders.txt: more 
     10        documentation. 
     11 
    1122008-08-07  Taher Shihadeh <taher@unixwars.com> 
    213 
    …… 
    1829        additions. Documentation looks better now. Still lots of work to 
    1930        do. 
    20  
    2131 
    22322008-08-07  Alvaro Lopez Ortega  <alvaro@alobbs.com> 

  • cherokee/trunk/doc/Makefile.am

    r1771 r1773  
    5151modules_encoders_gzip.html \ 
    5252modules_encoders_deflate.html \ 
     53modules_handlers.html \ 
    5354modules_handlers_file.html \ 
    5455modules_handlers_dirlist.html \ 
    …… 
    6263modules_loggers_ncsa.html \ 
    6364modules_loggers_w3c.html \ 
     65modules_validators.html \ 
    6466modules_validators_htdigest.html \ 
    6567modules_validators_htpasswd.html \ 
    …… 
    6870modules_validators_pam.html \ 
    6971modules_validators_plain.html \ 
     72other_goodies.html \ 
    7073dev.html \ 
    7174dev_debug.html \ 

  • cherokee/trunk/doc/TOC.txt

    r1771 r1773  
    6666    - link:modules_encoders_gzip.html[gzip] 
    6767    - link:modules_encoders_deflate.html[deflate] 
     68  . link:modules_handlers.html[Handlers] 
     69    - link:modules_handlers_file.html[Static Content] 
     70    - link:modules_handlers_dirlist.html[Only listing] 
     71    - link:modules_handlers_common.html[List & Send] 
     72    - link:modules_handlers_redir.html[Redirection] 
     73    - link:modules_handlers_cgi.html[CGI] 
    6874//// 
    69   Handlers                      link:modules_handlers.html[] 
    70     List & Send        [18]     link:modules_handlers_common.html[] 
    71     Static Content     [21]     link:modules_handlers_file.html[] 
    72     Only listing       [19]     link:modules_handlers_dirlist.html[] 
    73     Redirection        [22]     link:modules_handlers_redir.html[] 
    74     CGI                [17]     link:modules_handlers_cgi.html[] 
    75     FastCGI            [20]     link:modules_handlers_fcgi.html[] 
    76     SCGI               [23]     link:modules_handlers_scgi.html[] 
    77     Server Info                 link:modules_handlers_server_info.html[] 
    78     Generic balancer            link:modules_handlers_mirror.html[] 
    79     Remote Administration       link:modules_handlers_admin.html[] 
    80   Loggers              [16]     link:modules_loggers.html[] 
    81     combined           [16.1]   link:modules_loggers_combined.html[] 
    82     ncsa               [16.2]   link:modules_loggers_ncsa.html[] 
    83     w3c                [16.3]   link:modules_loggers_w3c.html[] 
    84   Validators           [7]      link:modules_validators.html[] 
    85     htdigest           [7.2]    link:modules_validators_htdigest.html[] 
    86     htpasswd           [7.1]    link:modules_validators_htpasswd.html[] 
    87     ldap               [7.1]    link:modules_validators_ldap.html[] 
    88     mysql              [7.3]    link:modules_validators_mysql.html[] 
    89     pam                [7.4]    link:modules_validators_pam.html[] 
    90     plain              [7.5]    link:modules_validators_plain.html[] 
     75    - FastCGI            [20]   link:modules_handlers_fcgi.html[] 
     76    - SCGI               [23]   link:modules_handlers_scgi.html[] 
     77    - Server Info               link:modules_handlers_server_info.html[] 
     78    - Generic balancer          link:modules_handlers_mirror.html[] 
     79    - Remote Administration     link:modules_handlers_admin.html[] 
     80  . link:modules_loggers.html[Loggers] 
     81    - combined           [16.1] link:modules_loggers_combined.html[] 
     82    - ncsa               [16.2] link:modules_loggers_ncsa.html[] 
     83    - w3c                [16.3] link:modules_loggers_w3c.html[] 
     84  . link:modules_validators.html[Validators] 
     85    - htdigest           [7.2]  link:modules_validators_htdigest.html[htdigest] 
     86    - htpasswd           [7.1]  link:modules_validators_htpasswd.html[htpasswd] 
     87    - ldap               [7.1]  link:modules_validators_ldap.html[LDAP] 
     88    - mysql              [7.3]  link:modules_validators_mysql.html[MySQL] 
     89    - pam                [7.4]  link:modules_validators_pam.html[PAM] 
     90    - plain              [7.5]  link:modules_validators_plain.html[Plain] 
    9191//// 
    9292 
    …… 
    9797  FAQ 
    9898  Community 
     99  - link:other_goodies.html[Cherokee Goodies] 
    99100 
    100101********************************* 

  • cherokee/trunk/doc/TODO

    r1765 r1773  
    55---------- 
    66  [1] Improve the navigability of the documentation. 
    7   [2] Define a convenient hierarchical structure, generate a TOC, etc.  
    8       Currently the structure reflects more the internal architecture of  
     7  [2] Define a convenient hierarchical structure, generate a TOC, etc. 
     8      Currently the structure reflects more the internal architecture of 
    99      Cherokee rather than a traditional manual. 
    1010  [3] Integrate the current docs into the new tree. 
    …… 
    1414------------------------------------- 
    1515  <1> How to configure virtual hosts from beginning to end, step by step. 
    16 * <2> How to tune scalability (IO cache & file, number of threads, increment  
    17       descriptors...) 
     16* <2> How to tune scalability (IO cache & file, number of threads, 
     17   increase descriptors, X-Sendfile...) 
    1818* <3> How to setup authenticated resources 
    1919* <4> How to configure the most spread apps servers (php, django, RoR,..) 
    20 * <5> How to manage logs  (make specific mention of usage of Cherokee-Tweak). 
     20* <5> How to manage logs  (make specific mention of usage of 
     21   Cherokee-Tweak and log backers). 
    2122* <6> How to manage security (SSL/TLS, certs, etc) 
    2223* <7> Development documentation 

  • cherokee/trunk/doc/basics_why_cherokee.txt

    r1724 r1773  
    22------------- 
    33 
    4 Welcome to the Cherokee {cherokee_version} documentation. 
    5 Cherokee is high-performance web server. It is very fast, flexible and 
    6 easy to configure. It offers support for the widespread technologies 
    7 nowadays: FastCGI, SCGI, PHP, CGI, TLS and SSL encrypted connections, 
    8 Virtual hosts, Authentication, on the fly encoding, Load balancing, 
    9 Apache compatible log files, and much more. 
     4Welcome to the Cherokee {cherokee_version} documentation. Cherokee is 
     5high-performance web server. It is very fast, flexible and easy to 
     6configure. It offers support for the widespread technologies nowadays: 
     7FastCGI, SCGI, PHP, CGI, X-Sendfile, TLS and SSL encrypted 
     8connections, Virtual hosts, Authentication, on the fly encoding, Load 
     9balancing, Apache compatible log files, zero downtime updates and much 
     10more. 
    1011 
    1112It is highly efficient, extremely lightweight and provides rock solid 
    1213stability. Among its many features there is one that deserves special 
    1314credit: a user friendly interface called 
    14 link:bundle_cherokee-admin.html[cherokee-admin] that is provided for a no-hassle 
    15 configuration of every single feature of the server. This 
     15link:bundle_cherokee-admin.html[cherokee-admin] that is provided for a 
     16no-hassle configuration of every single feature of the server. This 
    1617administration interface allows you to configure the web server 
    1718without having to worry about editing a text file written with a 
    …… 
    2122 
    2223Unlike many other web servers out there, Cherokee gracefully handles 
    23 many concurrent connections, has a low memory footprint and provides load 
    24 balancing facilities. As such, it is suitable for usage among a wide 
    25 variety of systems, from tiny embedded devices to huge enterprise 
     24many concurrent connections, has a low memory footprint and provides 
     25load balancing facilities. As such, it is suitable for usage among a 
     26wide variety of systems, from tiny embedded devices to huge enterprise 
    2627grade infrastructures. It is also multiplatform, offering native 
    2728performance for Unix, Linux and Windows systems. 
    …… 
    3435Best of all, Cherokee is free software, has a thoroughly designed 
    3536architecture, is completely modular and has a clean and neat code 
    36 base. Anyone and everyone can have access to it to study and tinker 
    37 with, thus allowing you to customize, modify or extend everything to 
    38 suit specific needs. It is also very actively maintained, and every 
     37base. Anyone and everyone can have access to the code fot study and 
     38tinkering, thus allowing you to customize, modify or extend everything 
     39to suit specific needs. It is also very actively maintained, and every 
    3940interesting feature request is carefully considered. 
     41 
     42As you can see, Cherokee comes with many 
     43link:other_goodies.html[goodies] that allow to achieve unprecedented 
     44performance. 
    4045 
    4146But don't trust everything you are told. Check out the benchmarks and 

  • cherokee/trunk/doc/config_quickstart.txt

    r1771 r1773  
    197197handler for the `/auth` rule and nothing would be served. 
    198198+ 
    199 Refer to the Cookbook for detailed examples on the different options. 
     199Refer to the link:cookbook_authentication.html[Cookbook] for detailed 
     200examples on the different options. 
    200201+ 
    201202Lastly, lets configure a redirection rule by choosing a "Regular 
    …… 
    210211Note that the `Type` of the *Redirection* is `External`. This means 
    211212the server will instruct the requesting web client to fetch the 
    212 redirected URL, which means the client will allways know what the 
     213redirected URL, which means the client will always know what the 
    213214final URL is. This also means the redirection can be done to servers 
    214215other than your own. If it were internal, the redirection would be 
    215 invisible (no URL rewrite), but if it was done to an external server 
    216 the `Virtual Domain` setting wouldn't apply and your `default` virtual 
    217 domain would have to handle the connection. Having the theoretical 
    218 content hosted elsewhere, an error would occur. 
     216invisible (not showing the target  URL), but it would be limited to 
     217the same `virtual server`. 
    219218+ 
    220219A much more general redirection could be one using these values: 
    …… 
    234233`http://example.net/image.jpg` would return 
    235234`http://example.com/example.net/image.jpg`. 
     235+ 
     236If you need more details, Check out the documentation for the 
     237link:modules_handlers_redir.html[redirection] handler. 

  • cherokee/trunk/doc/modules_balancers.txt

    r1771 r1773  
    4444This is the list of currently supported balancing strategies: 
    4545 
    46 * link:modules_balancers_round_robin.html[Round RobinFriki] 
     46* link:modules_balancers_round_robin.html[Round Robin] 

  • cherokee/trunk/doc/modules_encoders.txt

    r1771 r1773  
    2121. Deny, Allow 
    2222. Allow, Deny 
     23 
     24This is the list of currently provided encoders: 
     25 
     26* link:modules_encoders_gzip.html[gzip] 
     27* link:modules_encoders_deflate.html[deflate] 

  • cherokee/trunk/doc/modules_handlers_cgi.txt

    r1647 r1773  
    1010 
    1111[grid="rows"] 
    12 ```~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
    13 Parameters              , Type           , Description 
    14 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
    15 Script Alias            , String         , It defines a kind of execution interpreter. 
    16 Change to UID           , String         , It interprets each CGI as it owner user. 
    17 Error handler           , Boolean        , Use CGI output as error message. 
    18 Check file              , Boolean        , Check if the file exists. 
    19 Pass request            , Boolean        , Pass request headers. 
    20 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
    21  
     12`~~~~~~~~~~~~~~~~`~~~~~~~~~~`~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
     13Parameters            , Type           , Description 
     14~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
     15Script Alias          , String  , It defines a kind of execution interpreter. \ 
     16                                  The CGI will be run as a parameter of this \ 
     17                                  script. 
     18Change to UID         , String  , Executes each CGI under its owner's user ID. 
     19Error handler         , Boolean , Use CGI output as error message. 
     20Check file            , Boolean , Check if the file exists. 
     21Pass request          , Boolean , Pass request headers. 
     22Allow X-Sendfile      , Boolean , Use the non-standard X-Sendfile header. 
     23~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
    2224 
    2325Examples 
    2426~~~~~~~~ 
    2527 
    26 This is a pretty common example. It defines a directory called cgi which points  
    27 to a path out of the Sever root directory where are located the CGI programs. 
     28This is a pretty common example. It defines a directory called `cgi` 
     29which points to a path out of the Sever root directory where the 
     30CGI programs are located. 
    2831 
    29 image::media/images/admin_handler_cgi.png[Cgi] 
     32image::media/images/admin_handler_cgi.png[CGI] 
    3033 

  • cherokee/trunk/doc/modules_handlers_common.txt

    r1647 r1773  
    22-------------------- 
    33 
    4 The **List & Send** (``common`` internally) handler behaviour depends 
     4The **List & Send** (``common`` internally) handler behavior depends 
    55on whether it replies a request for a directory or a file. 
    66 
    7 In case a directory is requested, it will use the link:modules_handlers_dirlist.html[Listing Only] 
    8 handler in order to list its content. And, in the case a file is 
    9 request, it will use the link:modules_handlers_file.html[File Sending] handler. 
     7In case a directory is requested, it will use the 
     8link:modules_handlers_dirlist.html[Listing Only] handler in order to 
     9list its contents. And, in case a file is request, it will use the 
     10link:modules_handlers_file.html[File Sending] handler. 
    1011 
    1112Parameters 
    1213~~~~~~~~~~ 
    1314[grid="rows"] 
    14 ```~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
    15 Parameters              , Type           , Description 
    16 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
    17 ``pathInfo``            , boolean        , Makes the handler to stop parsing the \ 
    18                                            pathinfo string. Default: ``Disabled``. 
    19 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
     15`~~~~~~~~~~~`~~~~~~~~~`~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
     16Parameters  , Type    , Description 
     17~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
     18`PathInfo`  , boolean , Makes the handler to stop parsing the \ 
     19                        pathinfo string. Default: `Disabled`. 
     20~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
    2021 
    21 Besides, it inherits all the parameters from the link:modules_handlers_file.html[file] and link:modules_handlers_dirlist.html[dirlist] handlers. 
     22Besides, it inherits all the parameters from the 
     23link:modules_handlers_file.html[file/Static Content] and 
     24link:modules_handlers_dirlist.html[dirlist/Only listing] handlers. 
    2225 
    23  
    24 * Note, **Pathinfo** explained:: 
     26This example shows the practical effect of **pathinfo**:: 
     27+ 
    2528---- 
    26     $ echo "This a test" > /tmp/1/2/test 
     29    $ echo "This is a test" > /tmp/1/2/test 
    2730    $ curl http://localhost:9999/1/2/test 
    28     This a test 
     31    This is a test 
    2932    $ curl http://localhost:9999/1/2/test/this/is/pathinfo 
    30     This a test 
     33    This is a test 
    3134    $ curl http://localhost:9999/1/2/test.no -D - | grep HTTP 
    3235    HTTP/1.1 404 Not Found 
    …… 
    3639~~~~~~~~ 
    3740 
    38 With this configuration:  
     41This configuration 
    3942 
    4043image::media/images/admin_handler_dirlist.png[Dirlist configuration] 
    4144 
    42 Will return something like:  
     45will return something like 
    4346 
    4447image::media/images/admin_handler_dirlist_ex.png[Dirlist example] 

  • cherokee/trunk/doc/modules_handlers_dirlist.txt

    r1647 r1773  
    44The **Only Listing** handler builds a list of directories and files 
    55within the requested directory, but **does not allow you to download 
    6 its content**. Refer to link:modules_handlers_common.html[List & Send] for the opposite behaviour. 
     6its contents**. Refer to link:modules_handlers_common.html[List & 
     7Send] for the opposite behaviour. 
    78 
    8 Parameters 
    9 ~~~~~~~~~~ 
     9Parameters: Listing 
     10~~~~~~~~~~~~~~~~~~~ 
    1011[grid="rows"] 
    11 ```~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
    12 Parameters              , Type         , Description 
    13 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
    14 ``theme``               , string       , Optional. The theme to use when         \ 
    15                                          displaying the directory listings.      \ 
    16                                          Default: ``default``. 
    17 ``size``                , boolean      , Optional. Display the size of files in  \ 
    18                                          the listings. Default: ``Enabled``.      
    19 ``date``                , boolean      , Optional. Display the last modification \ 
    20                                          date of the files and directories in    \ 
    21                                          the listings. Default: ``Enabled``. 
    22 ``user``                , boolean      , Optional. Display the owner of the      \ 
    23                                          files and directories in the listings.  \ 
    24                                          Default: ``Disabled``. 
    25 ``group``               , boolean      , Optional. Display the group ownership   \ 
    26                                          of the files and directories in the     \ 
    27                                          listings. Default ``Disabled``. 
     12`~~~~~~~~~~~~~~~~`~~~~~~~~~`~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
     13Parameters       , Type    , Description 
     14~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
     15``size``         , boolean , Optional. Display the size of files in the      \ 
     16                             listings. Default: ``Enabled``. 
     17``date``         , boolean , Optional. Display the last modification date of \ 
     18                             the files and directories in the listings.      \ 
     19                             Default: ``Enabled``. 
     20``user``         , boolean , Optional. Display the owner of the files and directories \ 
     21                             in the listings. Default: ``Disabled``. 
     22``group``        , boolean , Optional. Display the group ownership of the files and  \ 
     23                             directories in the listings. Default ``Disabled``. 
     24``symlinks``     , boolean , Optional. Display symbolic links. Default ``Enabled``. 
    2825~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
    2926 
    30 It is possible the change the default theme used when displaying the directory 
    31 listings, and it is also possible to create a new one: 
     27Parameters: Theming 
     28~~~~~~~~~~~~~~~~~~~ 
     29[grid="rows"] 
     30`~~~~~~~~~~~~~~~~`~~~~~~~~~`~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
     31Parameters       , Type    , Description 
     32~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
     33``theme``        , string  , Optional. The theme to use when displaying the  \ 
     34                             directory listings. Default: ``default``. 
     35``icon_dir``     , string  , Optional: Alternative path to a new icon set. 
     36``notice_files`` , string  , Optional: List of notice files to be inserted. 
     37~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
    3238 
     39It is possible to change the default theme used when displaying the directory 
     40listings. 
     41 
     42It is also possible to create a new one:: 
     43+ 
    3344---- 
    3445   $ ls /usr/share/cherokee/themes/firefox3/ 
    3546   entry.html  footer.html  header.html  theme.css 
    3647---- 
     48+ 
     49Simply create a new directory in the above mentioned path containing 
     50the listed files and  you'll be able to select it in `cherokee-admin`. 
    3751 
    3852Examples 
    3953~~~~~~~~ 
    4054 
    41 With this configuration:  
     55This configuration 
    4256 
    4357image::media/images/admin_handler_onlylisting.png[Only listing configuration] 
    4458 
    45 Will return something like:  
     59will return something like 
    4660image::media/images/admin_handler_onlylisting_ex.png[Only listing example] 
    47  
    48  

  • cherokee/trunk/doc/modules_handlers_fcgi.txt

    r1740 r1773  
    7676interpreter was kind of buggy when it had to demultiplex multiple 
    7777requests from the same socket. 
    78             
     78 
    7979The "fastcgi" handler will eventually become the default option. 
    80 However, by the moment "fcgi" is a better option. 
     80However, at the moment "fcgi" is a better option. 
    8181 

  • cherokee/trunk/doc/modules_handlers_file.txt

    r1647 r1773  
    1 Handler: File sending 
    2 --------------------- 
     1Handler: Static Content 
     2----------------------- 
    33 
    4 The **file** handler serves files from its document root.  No more, no less. 
     4The **file** handler serves files from its document root.  No more, no 
     5less. 
    56 
    67Parameters 
    78~~~~~~~~~~ 
    89[grid="rows"] 
    9 ```~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
    10 Parameters              , Type         , Description 
    11 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
    12 ``iocache``             , Boolean      , Optional. Default: ``Enabled``. 
    13 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
     10`~~~~~~~~~~~`~~~~~~~~~`~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
     11Parameters  , Type    , Description 
     12~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
     13``iocache`` , Boolean , Optional. Default: ``Enabled``. 
     14~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
    1415 
    15 By default it will use an internal I/O cache to improve the server performance.  
    16 If you don't want to use it with a directory just unset it using this parameter.  
     16By default it will use an internal I/O cache to improve the server 
     17performance. 
     18If you don't want to use it with a directory just unset it using this 
     19parameter. 
    1720 
    18 It is a good idea to disable to I/O cache if the content of the directory changes 
    19 often. 
     21It is a good idea to disable to I/O cache if the content of the 
     22directory changes often. 
    2023 
    2124Examples 
    …… 
    2528image::media/images/admin_handler_file.png[Handler file] 
    2629 
    27 This configuration will make Cherokee to serve files inside /var/www_static/images  
    28 like files. 
     30This configuration will make Cherokee to serve each file inside 
     31/var/www_static/images as files. 

  • cherokee/trunk/doc/modules_handlers_redir.txt

    r1647 r1773  
    1 Handler: Redirections 
    2 --------------------- 
     1Handler: Redirection 
     2-------------------- 
    33 
    4 The main idea of a redirection is telling to the web client to go to another URL  
    5 when the request URL matchs some rule. 
     4The main idea of a redirection is telling the web client to go to 
     5another URL when the requested URL matches a rule. 
    66 
    7  
    8 For example, if you have URLs like: 
     7For example, if you have URLs like:: 
     8+ 
    99---- 
    1010    http://example.com/inst/photogallery/viewphoto?photoid=1235 
    1111    http://example.com/inst/photogallery/viewcomments?photoid=1235 
    12     http://example.com/inst/photogallery/admin?photoid=1235&method=delete  
     12    http://example.com/inst/photogallery/admin?photoid=1235&method=delete 
    1313---- 
    1414 
    15 You probably would prefer URLs like: 
     15You probably would prefer URLs like:: 
     16+ 
    1617---- 
    1718    http://example.com/photo/1235 
    1819    http://example.com/photo/1235/cmts 
    19     http://example.com/photo/1235/delete  
     20    http://example.com/photo/1235/delete 
    2021---- 
    2122 
    …… 
    2324~~~~~~~~~~ 
    2425 
    25 This directive uses PCRE (Perl Compatible Regular Expressions) to make the substitution.  
     26This directive uses PCRE (Perl Compatible Regular Expressions) to make 
     27the substitution. 
    2628 
    2729* Type: [External | Internal] 
    2830 
    2931  - *Internal*: 
    30     The redirection will happen internally, hence the the internal URL in which the address  
    31     is translated will be invisible for the client. 
     32    The redirection will happen internally, hence the internal URL in 
     33    which the address is translated will be invisible for the client. 
    3234 
    3335  - *External*: 
    34     It works in the same way as the previous one, but in this case, it will redirect  
    35     the connection to the new resource. 
     36    It works in the same way as the previous one, but in this case, it 
     37    will redirect the connection to the new resource. 
    3638 
     39* *Regular Expression* and *Substitution* are the matching request and 
     40   the intended target of such petition. 
    3741 
    3842Virtual hosts and redirections 
     43~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
    3944 
    40 The internals redirections, using the Rewrite key word, are limited to work in  
    41 the same virtual host. All the internal redirections will be processed in the  
    42 original virtual host, which makes quite sense in terms of security. 
     45The internal redirections, using the `internal` keyword, are limited to 
     46work in the same virtual host. All the internal redirections will be 
     47processed in the original virtual host, which makes a lot of sense in 
     48terms of security. 
    4349 
    44 In the case you do need the redirect some resource to another virtual host  
    45 and/or domain, you will have to use an explicit redirection using the external key words. 
     50In case you do need to redirect a resource to another virtual host 
     51and/or domain, you will have to use an explicit redirection using the 
     52`external` keyword. 
    4653 
    4754 
    …… 
    4956~~~~~~~~ 
    5057 
    51 This example will perform an internal redirection: 
     58This example will perform internal redirections: 
    5259 
    53 ``~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
     60`~~~~~~~~~~~~~~~~~~~~`~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
    5461Regular Expression   , Substitution 
    55 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
     62~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
    5663__"/(d+)$"__         , http://example.com/inst/photogallery/viewphoto?photoid=$1 
    5764__"/(\d+)/cmts"__    , http://example.com/viewcomments?photoid=$1 
    5865__"/(\d+)/delete"__  , http://example.com/inst/photogallery/admin?photoid=$1&method=delete 
    59 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
     66~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
    6067 
     68Which would translate into the following redirections for the listed 
     69matching requests: 
    6170 
    62 ``~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
     71`~~~~~~~~~~~~~~~~~~~~~`~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
    6372Request               , Internal translation 
    64 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
     73~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
    6574__/photo/123__        , http://example.com/inst/photogallery/viewphoto?photoid=123 
    6675__/photo/213/cmts__   , http://example.com/viewcomments?photoid=213 
    6776__/photo/501/delete__ , http://example.com/inst/photogallery/admin?photoid=501&method=delete 
    68 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
     77~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
    6978 

  • cherokee/trunk/doc/modules_loggers.txt

    r1744 r1773  
    1 Loggers 
    2 ------- 
     1Modules: Loggers 
     2---------------- 
     3 
     4Loggers are a type of Cherokee modules unsurpisingly used to log 
     5events. They can be configured on a per virtual server basis through 
     6each virtual server's `Logging` section. 
     7 
     8Every `logger` registers information about two types of events, *Accesses* 
     9and *Errors*, in a different format depending on the used `logger`. 
     10 
     11The information can be registered by any of the following mechanisms: 
     12 
     13* File: write to disk. 
     14* System logger: use the syslog standard. 
     15* Standard Error: write to stderr. 
     16* Execute program: send the log entry to the specified program. 
    317 
    418Cherokee currently supports the following loggers: 
    519 
    6 * link:modules_loggers_combined.html[Combined] 
    7 * link:modules_loggers_ncsa.html[NCSA] 
    8 * link:modules_loggers_w3c.html[W3C] 
     20* link:modules_loggers_combined.html[Combined]: Apache compatible. *Recommended*. 
     21* link:modules_loggers_ncsa.html[NCSA]: NCSA style. 
     22* link:modules_loggers_w3c.html[W3C]: W3C standard.