Changeset 1767

Show
Ignore:
Timestamp:
08/07/08 17:51:00 (4 months ago)
Author:
taher
Message:

--

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • cherokee/trunk/doc/TOC.txt

    r1765 r1767  
    4343  Reference table     <8>       link:cookbook_reference.html[] 
    4444  Optimizing Cherokee <2>       link:cookbook_optimizing_cherokee.html[] 
     45//// 
     46 
    4547  . link:cookbook_cross_compilation.html[Cross compilation] 
     48 
     49//// 
    4650  Embedding Cherokee  <9>       link:cookbook_embedding_cherokee.html[] 
    4751  Managing logs       <5>       link:cookbook_managing_logs.html[] <rotations and cherokee-tweak?> 

  • cherokee/trunk/doc/config_quickstart.txt

    r1765 r1767  
    121121While you are at it you should also append the following line to your 
    122122`/etc/hosts` file (in Windows you will find this as 
    123 `%WINDIR%\system32\drivers\etc\hosts` 
     123`%WINDIR%\system32\drivers\etc\hosts`). 
    124124 
    125125---- 
    …… 
    130130`example.org` locally. Of course, once you are out in the Wild (you 
    131131know, in the Internet), you will need proper DNS records. 
     132 
    132133 
    133134*`default`*:: 
    …… 
    140141direction for any particular domain, the contents of your document 
    141142root directory will be exposed ('/var/www' by default unless you 
    142 changed that during the build process). 
     143changed that during the build process). Whenever there is no match for 
     144a virtual server specifically defined in your list, the `default` 
     145virtual server will be the one responding. 
    143146+ 
    144147Right now any file with the 'php' extension will be served after being 
    …… 
    153156serving whatever content is requested directly, simply change the 
    154157`List & Send` handler for the `Static Content` handler. 
    155  
    156158 
    157159 

  • cherokee/trunk/doc/dev_cherokee.conf.txt

    r1740 r1767  
    2424Having said that, let's proceed to describe the configuration file format. It 
    2525is basically a text file that contains a tree where nodes 
    26 contain values. Let's see a basic example: 
    27  
     26contain values. 
     27 
     28Let's see a basic example:: 
     29+ 
    2830---- 
    2931    server!port = 80 
    …… 
    119121~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
    120122 
    121 Example: 
     123Example:: 
     124+ 
    122125---- 
    123126   server!encoder!gzip!allow = html,htm 
    …… 
    179182specifies which is the rule type and its properties. 
    180183 
    181 The general syntax is: 
    182  
    183 vserver ! ``order`` ! rule ! ``prioriry`` ! match 
     184The general syntax is:: 
     185+ 
     186`vserver ! order ! rule ! prioriry ! match` 
    184187 
    185188The rule types plug-ins shipped within a standard Cherokee release 
    …… 
    187190 
    188191*Directory*:: 
    189   The directory specifies how to handle its contents. 
    190  
    191   Example: an entry with priority 20, setting the properties for the 
    192   *icons* directory of the default virtual host would be represented 
    193   by: 
     192The directory specifies how to handle its contents. 
     193+ 
     194Example: an entry with priority 20, setting the properties for the 
     195*icons* directory of the default virtual host would be represented 
     196by: 
     197+ 
    194198---- 
    195199      vserver!1!nick = default 
    …… 
    199203 
    200204*Extension*:: 
    201   It specifies a list of extensions and how they should be handled. 
    202  
    203   Eg: the JPG extensions is: 
     205It specifies a list of extensions and how they should be handled. 
     206+ 
     207Eg: the JPG extensions is: 
     208+ 
    204209---- 
    205210      vserver!1!rule!30!match!type = extensions 
    …… 
    208213 
    209214*Requests*:: 
    210   When a request matches a regular expression entry, it uses its configuration. 
    211  
    212   Eg: requests beginning with 'a' and PHP extension: 
     215When a request matches a regular expression entry, it uses its configuration. 
     216+ 
     217Eg: requests beginning with 'a' and PHP extension: 
     218+ 
    213219----- 
    214220      vserver!1!rule!40!match!type = request 
    …… 
    217223 
    218224*Header*:: 
    219   It tries to match a regular expression against a certain header 
    220   entry. 
    221  
    222   Eg: check whether the Referer header matches a specific host: 
    223  
     225It tries to match a regular expression against a certain header 
     226entry. 
     227+ 
     228Eg: check whether the Referer header matches a specific host: 
     229+ 
    224230---- 
    225231      vserver!1!rule!50!match!type = header 
    …… 
    229235 
    230236*Default*:: 
    231  
    232   This rules matches every request. There must be a default rule 
    233   configured at the end of the rule list to handle the requests that 
    234   did not match any other rule. The end of the list means the smallest 
    235   priority value in relative terms. It doesn't have to be `1` 
    236   necessarily. 
    237  
    238   Eg: Default rule for the 'default' virtual server: 
    239  
     237This rules matches every request. There must be a default rule 
     238configured at the end of the rule list to handle the requests that 
     239did not match any other rule. The end of the list means the smallest 
     240priority value in relative terms. It doesn't have to be `1` 
     241necessarily. 
     242+ 
     243Eg: Default rule for the 'default' virtual server: 
     244+ 
    240245---- 
    241246      vserver!1!rule!1!match = default 
    …… 
    243248      vserver!1!rule!1!handler!iocache = 0 
    244249---- 
    245  
     250+ 
    246251The following parameters are concatenated with any of the previous 
    247252kinds of entry: 
    …… 
    277282- The default virtual server uses the "common" handler as default 
    278283  choice for its root directory: 
    279  
     284+ 
    280285---- 
    281286    vserver!1!nick = default 
    …… 
    287292  accessed from the local loop interface, and have to be handled as a 
    288293  FastCGI: 
    289  
     294+ 
    290295---- 
    291296    vserver!5!nick = example 
    …… 
    299304- ISO images should be handled as files and are protected by a 
    300305  htdigest file using only Digest authentication: 
    301  
     306+ 
    302307---- 
    303308    vserver!1!nick = default 
    …… 
    346351 
    347352- Apache format logs to the regular files: 
     353+ 
    348354---- 
    349355    vserver!1!nick = default 
    …… 
    360366Sometimes it is nice to break out your configuration into several logical files 
    361367to be more modular as well as more organized.  You can use the ``include`` 
    362 configuration to accomplish this.  Here is an example: 
     368configuration to accomplish this. 
     369 
     370Here is an example:: 
     371+ 
    363372---- 
    364373    include = /etc/cherokee/advanced.conf 
    365374---- 
    366 or even, it is possible to specify a directory to include all of its files: 
     375 
     376or even, it is possible to specify a directory to include all of its files:: 
     377+ 
    367378---- 
    368379    include = /etc/cherokee/mods-enabled/ 

  • cherokee/trunk/doc/dev_debug.txt

    r1740 r1767  
    77* To start with, if you are using gcc and you want to compile Cherokee 
    88  with debug information just execute make like this: 
    9  
     9+ 
    1010---- 
    1111  make CFLAGS="-O0 -g3" 
    1212---- 
    13  
    14   And then you'll be able to execute gdb, cgdb, gdbtui.. 
     13+ 
     14And then you'll be able to execute gdb, cgdb, gdbtui.. 
    1515 
    1616* You can use autoconf to set up Cherokee to use static modules: 
    17  
     17+ 
    1818---- 
    1919  ./autogen.sh --localstatedir=/var --prefix=/usr --sysconfdir=/etc  \ 
    …… 
    2626  you must add a special flag to your `configure` or `autogen.sh` 
    2727  statement: 
    28  
     28+ 
    2929---- 
    3030  --enable-trace 
    3131---- 
     32+ 
     33This will let you trace the behavior with a human-readable output. 
     34Now, when you are going to launch the web server, just add the 
     35CHEROKEE_TRACE variable, with the desired options: 
     36+ 
     37**** 
     38cherokee# CHEROKEE_TRACE="common" cherokee 
    3239 
    33   This will let you trace the behavior with a human-readable output. 
    34   Now, when you are going to launch the web server, just add the 
    35   CHEROKEE_TRACE variable, with the desired options: 
     40Cherokee Web Server 0.8.0 (July 21 2008): Listening on port 80, TLS disabled 
    3641 
     42IPv6 enabled, using epoll, 1024 fds system limit, max. 507 connections 
    3743 
    38 ---- 
    39 cherokee# CHEROKEE_TRACE="common" cherokee 
    40 Cherokee Web Server 0.8.0 (July 21 2008): Listening on port 80, TLS disabled 
    41 IPv6 enabled, using epoll, 1024 fds system limit, max. 507 connections 
    42445 threads, 206 fds per thread, standard scheduling policyhandler_common.c:0143 (                     stat_file): /var/www//images/powered_by_cherokee.png, use_iocache=0 re=0 
     45 
    4346handler_common.c:0190 (   cherokee_handler_common_new): request: '/images/powered_by_cherokee.png', local: '/var/www//images/powered_by_cherokee.png', exists 1 
     47 
    4448handler_common.c:0236 (   cherokee_handler_common_new): going for handler_file 
     49 
    4550handler_common.c:0143 (                     stat_file): /var/www//images/default-bg.png, use_iocache=0 re=0 
     51 
    4652handler_common.c:0190 (   cherokee_handler_common_new): request: '/images/default-bg.png', local: '/var/www//images/default-bg.png', exists 1 
     53 
    4754handler_common.c:0236 (   cherokee_handler_common_new): going for handler_file 
     55 
    4856handler_common.c:0143 (                     stat_file): /var/www//images/cherokee-logo.png, use_iocache=0 re=0 
     57 
    4958handler_common.c:0190 (   cherokee_handler_common_new): request: '/images/cherokee-logo.png', local: '/var/www//images/cherokee-logo.png', exists 1 
     59 
    5060handler_common.c:0236 (   cherokee_handler_common_new): going for handler_file 
    51 ---- 
    52  
    53   Of course, you can trace all the modules (handlers, loggers..) you need: 
    54  
     61**** 
     62+ 
     63Of course, you can trace all the modules (handlers, loggers..) you need: 
     64+ 
    5565---- 
    5666CHEROKEE_TRACE="common,static,io_cache" /usr/bin/cherokee 
    5767CHEROKEE_TRACE="all" /usr/bin/cherokee 
    5868---- 
    59  
    60   By default the environment variable contains a list of comma 
    61   separated words, that point the server which parts and actions are 
    62   interesting for your trace. Besides, there are a few special cases: 
    63  
     69+ 
     70By default the environment variable contains a list of comma 
     71separated words, that point the server which parts and actions are 
     72interesting for your trace. Besides, there are a few special cases: 
     73+ 
    6474  - all: Activates all the trace points 
    6575  - time: Prints the time at the beginning of the line 
    …… 
    7686  helps to read the tracing logs by colorizing the thread references 
    7787  and highlighting the words passed through the command line. 
    78  
    79   And example of usage would be: 
    80  
     88+ 
     89An example of usage would be: 
     90+ 
    8191---- 
    8292CHEROKEE_TRACE=thread,all ./cherokee | ../contrib/tracelor.py iocache 
    8393---- 
     94+ 
     95And it would yield an output such as the following. Even if it is 
     96not terribly complicated, it is a handy script to trace the server more 
     97easily. 
    8498 
    85   And it would yield an output such as the following. Even if it is 
    86   not terribly complicated, it is a handy script to trace the server more 
    87   easily. 
    88  
    89   image::media/images/tracelor.png[Output of tracelor.py] 
     99image::media/images/tracelor.png[Output of tracelor.py] 

  • cherokee/trunk/doc/media/css/cherokee_doc.css

    r1765 r1767  
    174174 
    175175div#preamble, 
    176 div.tableblock, div.imageblock, div.exampleblock, div.verseblock, 
     176div.imageblock, div.exampleblock, div.verseblock, 
    177177div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock, 
    178178div.admonitionblock { 
    …… 
    181181//  margin-top: 1.5em; 
    182182  margin-bottom: 1.5em; 
     183 
     184} 
     185 
     186div.tableblock { 
     187margin-left: 10%; 
     188margin-right: 10%; 
     189margin-top: 1.5em; 
     190margin-bottom: 1.5em; 
     191 
    183192} 
    184193