Changeset 1740

Show
Ignore:
Timestamp:
08/05/08 18:33:51 (5 months ago)
Author:
taher
Message:

--

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • cherokee/trunk/ChangeLog

    r1731 r1740  
     12008-08-05  Taher Shihadeh <taher@unixwars.com> 
     2 
     3        * doc/config_*, doc/bundle_*, doc/cookbook_*, doc/dev_*: dompleted 
     4        documenting another section, plus multiple fixes to the existing 
     5        sections. Some more screeshots added. 
     6 
     7        * admin/Page*.py: minor fixes. 
     8 
    192008-08-05  Alvaro Lopez Ortega  <alvaro@alobbs.com> 
    210 

  • cherokee/trunk/admin/PageAdvanced.py

    r1697 r1740  
    3434NOTE_PID_FILE     = 'Path of the PID file. If empty, the file will not be created.' 
    3535NOTE_LISTEN_Q     = 'Max. length of the incoming connection queue.' 
    36 NOTE_REUSE_CONNS  = 'Set the number of how many internal connections can be hold for reuse by each thread. Default 20.' 
     36NOTE_REUSE_CONNS  = 'Set the number of how many internal connections can be held for reuse by each thread. Default 20.' 
    3737NOTE_FLUSH_TIME   = 'Sets the number of seconds between log consolidations (flushes). Default: 10 seconds.' 
    3838NOTE_KEEPALIVE_RS = 'Maximum number of HTTP requests that can be served by each keepalive connection.' 
    …… 
    7676        txt += self.Indent(table) 
    7777 
    78         txt += "<h2>Server behaviour</h2>" 
     78        txt += "<h2>Server behavior</h2>" 
    7979        table = TableProps() 
    80         self.AddPropEntry    (table, 'Listening queue lenght', 'server!listen_queue',           NOTE_LISTEN_Q) 
     80        self.AddPropEntry    (table, 'Listening queue length', 'server!listen_queue',           NOTE_LISTEN_Q) 
    8181        self.AddPropEntry    (table, 'Reuse connections',      'server!max_connection_reuse',   NOTE_REUSE_CONNS) 
    8282        self.AddPropEntry    (table, 'Log flush time',         'server!log_flush_elapse',       NOTE_FLUSH_TIME) 
    …… 
    8686        form = Form ("/%s" % (self._id), add_submit=False) 
    8787        return form.Render(txt,DEFAULT_SUBMIT_VALUE) 
    88          
     88 
    8989    def _op_apply_changes (self, uri, post): 
    90         self.ApplyChanges ([], post, DATA_VALIDATION)  
     90        self.ApplyChanges ([], post, DATA_VALIDATION) 
    9191 

  • cherokee/trunk/doc/Makefile.am

    r1724 r1740  
    2828bundle_cherokee-tweak.html \ 
    2929bundle_spawn-fcgi.html \ 
     30config_walkthrough.html \ 
     31config_general.html \ 
     32config_virtual_servers.html \ 
     33config_encoding.html \ 
     34config_icons.html \ 
     35config_mime_types.html \ 
     36config_advanced.html \ 
     37cookbook_cross_compilation.html \ 
     38cookbook_authentication.html \ 
     39cookbook_ssl.html \ 
    3040index.html \ 
    31 authentication.html \ 
    32 general.html \ 
    3341loggers.html \ 
    34 vserver.html \ 
    35 debug.html \ 
    3642entry.html \ 
    37 cross_compile_cherokee.html \ 
    38 internal_configuration.html \ 
    39 advanced.html \ 
    40 generating_ssl_keys.html \ 
    41 icons.html \ 
    4243modules_balancers_round_robin.html \ 
    4344modules_encoders_gzip.html \ 
     45modules_encoders_deflate.html \ 
    4446modules_handlers_file.html \ 
    4547modules_handlers_dirlist.html \ 
    …… 
    4749modules_handlers_redir.html \ 
    4850modules_handlers_cgi.html \ 
    49 modules_handlers_fastcgi.html \ 
     51modules_handlers_cgi.html \ 
    5052modules_handlers_scgi.html \ 
    5153modules_loggers_combined.html \ 
    …… 
    5759modules_validators_mysql.html \ 
    5860modules_validators_pam.html \ 
    59 modules_validators_plain.html 
     61modules_validators_plain.html \ 
     62dev_debug.html \ 
     63dev_cherokee.conf.html 
    6064 
    6165docmediacssdir = $(docdir)/media/css/ 

  • cherokee/trunk/doc/TOC.txt

    r1724 r1740  
    99   - link:basics_installation_windows.html[Windows] 
    1010 . link:basics_upgrade.html[Upgrading Cherokee] 
    11  . link:basics_running_cherokee.txt[Running Cherokee] 
     11 . link:basics_running_cherokee.html[Running Cherokee] 
    1212 
    1313************************** 
    …… 
    2424Configuration 
    2525************************** 
    26   Walkthrough         <1>       link:config_walkthrough.html 
    27   General             [5]      link:config_general.html 
    28   Virtual servers     [6]      link:config_virtual_servers.html 
    29   Encoding                     link:config_encoding.html 
    30   Icons               [9]      link:config_icons.html 
    31   Mime Types                   link:config_mime_types.html 
    32   Advanced            [10]     link:config_advanced.html 
     26  Walkthrough         <1>       link:config_walkthrough.html[] 
     27  . link:config_general.html[General] 
     28  . link:config_virtual_servers.html[Virtual servers] 
     29  . link:config_encoding.html[Encoding] 
     30  . link:config_icons.html[Icons] 
     31  . link:config_mime_types.html[Mime Types] 
     32  . link:config_advanced.html[Advanced] 
    3333 
    3434************************** 
    3535Cookbook 
    3636************************** 
    37   Reference table     <8>       link:cookbook_reference.html 
    38   Optimizing Cherokee <2>       link:cookbook_optimizing_cherokee.html 
    39   Cross compilation   [12]      link:cookbook_cross_compilation.html 
    40   Embedding Cherokee  <9>       link:cookbook_embedding_cherokee.html 
    41   Managing logs       <5>       link:cookbook_managing_logs.html <rotations and cherokee-tweak?> 
    42   Authentication      [8] <3>   link:cookbook_authentication.html 
    43   SSL/TLS, certs      [13]<6>   link:cookbook_ssl.html 
    44   Setting up PHP      <4>       link:cookbook_php.html 
    45   Setting up Django   <4>       link:cookbook_django.html 
    46   Setting up RoR      <4>       link:cookbook_ror.html 
     37  Reference table     <8>       link:cookbook_reference.html[] 
     38  Optimizing Cherokee <2>       link:cookbook_optimizing_cherokee.html[] 
     39  Cross compilation   [12]      link:cookbook_cross_compilation.html[] 
     40  Embedding Cherokee  <9>       link:cookbook_embedding_cherokee.html[] 
     41  Managing logs       <5>       link:cookbook_managing_logs.html[] <rotations and cherokee-tweak?> 
     42  Authentication      [8] <3>   link:cookbook_authentication.html[] 
     43  SSL/TLS, certs      [13]<6>   link:cookbook_ssl.html[] 
     44  Setting up PHP      <4>       link:cookbook_php.html[] 
     45  Setting up Django   <4>       link:cookbook_django.html[] 
     46  Setting up RoR      <4>       link:cookbook_ror.html[] 
    4747 
    4848************************** 
    4949Modules 
    5050************************** 
    51   Balancers 
    52     Round robin        [24]     link:modules_balancers_round_robin.html 
    53   Encoders 
    54     gzip               [25]     link:modules_encoders_gzip.html 
    55   Handlers 
    56     cgi                [17]     link:modules_handlers_cgi.html 
    57     common             [18]     link:modules_handlers_common.html 
    58     dirlist            [19]     link:modules_handlers_dirlist.html 
    59     fastcgi            [20]     link:modules_handlers_fastcgi.html 
    60     file               [21]     link:modules_handlers_file.html 
    61     redir              [22]     link:modules_handlers_redir.html 
    62     scgi               [23]     link:modules_handlers_scgi.html 
    63   Loggers              [16] 
    64     combined           [16.1]   link:modules_loggers_combined.html 
    65     ncsa               [16.2]   link:modules_loggers_ncsa.html 
    66     w3c                [16.3]   link:modules_loggers_w3c.html 
    67   Validators           [7] 
    68     htdigest           [7.2]    link:modules_validators_htdigest.html 
    69     htpasswd           [7.1]    link:modules_validators_htpasswd.html 
    70     ldap               [7.1]    link:modules_validators_ldap.html 
    71     mysql              [7.3]    link:modules_validators_mysql.html 
    72     pam                [7.4]    link:modules_validators_pam.html 
    73     plain              [7.5]    link:modules_validators_plain.html 
     51  Balancers                     link:modules_balancers.html[] 
     52    Round robin        [24]     link:modules_balancers_round_robin.html[] 
     53  Encoders                      link:modules_encoders.html[] 
     54    link:modules_encoders_gzip.html[gzip] 
     55    link:modules_encoders_deflate.html[deflate] 
     56  Handlers                      link:modules_handlers.html[] 
     57    List & Send        [18]     link:modules_handlers_common.html[] 
     58    Static Content     [21]     link:modules_handlers_file.html[] 
     59    Only listing       [19]     link:modules_handlers_dirlist.html[] 
     60    Redirection        [22]     link:modules_handlers_redir.html[] 
     61    CGI                [17]     link:modules_handlers_cgi.html[] 
     62    FastCGI            [20]     link:modules_handlers_fcgi.html[] 
     63    SCGI               [23]     link:modules_handlers_scgi.html[] 
     64    Server Info                 link:modules_handlers_server_info.html[] 
     65    Generic balancer            link:modules_handlers_mirror.html[] 
     66    Remote Administration       link:modules_handlers_admin.html[] 
     67  Loggers              [16]     link:modules_loggers.html[] 
     68    combined           [16.1]   link:modules_loggers_combined.html[] 
     69    ncsa               [16.2]   link:modules_loggers_ncsa.html[] 
     70    w3c                [16.3]   link:modules_loggers_w3c.html[] 
     71  Validators           [7]      link:modules_validators.html[] 
     72    htdigest           [7.2]    link:modules_validators_htdigest.html[] 
     73    htpasswd           [7.1]    link:modules_validators_htpasswd.html[] 
     74    ldap               [7.1]    link:modules_validators_ldap.html[] 
     75    mysql              [7.3]    link:modules_validators_mysql.html[] 
     76    pam                [7.4]    link:modules_validators_pam.html[] 
     77    plain              [7.5]    link:modules_validators_plain.html[] 
    7478 
    7579************************** 
    …… 
    8286Development info 
    8387************************** 
    84   Debugging           [11]     link:dev_debug.html 
    85   cherokee.conf       [15]     link:dev_cherokee.conf.html 
    86   API introduction              link:dev_api.html 
    87   Examples                      link:dev_examples.html 
     88  . link:dev_debug.html[Debugging] 
     89  . link:dev_cherokee.conf.html[cherokee.conf] 
     90  API introduction              link:dev_api.html[] 
     91  Examples                      link:dev_examples.html[] 

  • cherokee/trunk/doc/bundle_cherokee-admin.txt

    r1724 r1740  
    7070       `cherokee-admin` accepts the following options: 
    7171 
    72        `-h, --help` 
     72       -h, --help:: 
    7373               Shows brief usage information 
    7474 
    75        `-V, --version` 
     75       -V, --version:: 
    7676               Show version and exit 
    7777 
    78        `-b, --bind[=IP]` 
     78       -b, --bind[=IP]:: 
    7979               By  default `cherokee-admin` binds only to 127.0.0.1 (localhost), 
    8080               which means you can only connect to it from  the  same  system. 
    81                With this parameter you can specify the network address to lis‐ 
    82                ten to. If no IP is provided, it will bind to all interfaces. 
     81               With this parameter you can specify the network address 
     82               to listen to. If no IP is provided, it will bind to all 
     83               interfaces. 
    8384 
    84        `-C, --target=PATH` 
     85 
     86       -C, --target=PATH:: 
    8587               Requests  a  configuration  file  different  than  the  default 
    8688               /etc/cherokee/cherokee.conf to be used 
    8789 
    88        `-d, --appdir=DIR` 
     90       -d, --appdir=DIR:: 
    8991               Uses a custom admin-interface path 
    9092 
    91        `-p, --port=NUM` 
     93       -p, --port=NUM:: 
    9294               Specifies an alternative port. By default, 9090. 
    9395 
    …… 
    9799more in-depth explanations of the usage of the interface as a 
    98100configuration tool. 
    99  

  • cherokee/trunk/doc/bundle_cherokee-config.txt

    r1724 r1740  
    2626       `cherokee-config` accepts the following options: 
    2727 
    28        --version 
    29                Print the currently installed version of CHEROKEE on 
    30                the standard output. 
     28       --version:: 
     29               Print the currently installed version of CHEROKEE on the standard output. 
    3130 
    3231 
    33        --libs  Print the linker flags that are necessary to  link  a  CHEROKEE 
    34                program. 
     32       --libs:: 
     33               Print the linker flags that are necessary to  link  a  CHEROKEE program. 
    3534 
    36        --cflags 
    37                Print the compiler flags that are necessary to compile 
    38                a CHEROKEE program. 
     35       --cflags:: 
     36               Print the compiler flags that are necessary to compile a CHEROKEE program. 
    3937 
    4038 
    41        --prefix=PREFIX 
    42                If specified, use PREFIX instead  of  the  installation  prefix 
    43                that  CHEROKEE was built with when computing the output for the 
    44                --cflags and --libs options.  This  option  must  be  specified 
    45                before any --libs or --cflags options. 
     39       --prefix=PREFIX:: 
     40               If specified, use PREFIX instead  of  the  installation 
     41               prefix that  CHEROKEE was built with when computing the 
     42               output for the --cflags and --libs options.  This 
     43               option  must  be  specified before any --libs or 
     44               --cflags options. 
    4645********************************************************************** 

  • cherokee/trunk/doc/bundle_cherokee-tweak.txt

    r1724 r1740  
    3636       cherokee-tweak accepts the following options: 
    3737 
    38        -h, --help 
     38       -h, --help:: 
    3939               Shows brief usage information 
    4040 
    41        -V, --version 
     41       -V, --version:: 
    4242               Prints version and exits 
    4343 
    44        -u, --user= STRING 
     44       -u, --user= STRING:: 
    4545               Specifies the user name with which to identify to the server 
    4646 
    47        -p, --password= STRING 
     47       -p, --password=STRING:: 
    4848               Specifies the password with which to identify to the server 
    4949 
    50        -c, --command=STRING 
     50       -c, --command=STRING:: 
    5151               Required option. Command to execute: logrotate, trace or info 
    5252 
    53        -a, --url=URL 
     53       -a, --url=URL:: 
    5454               Required  option. URL where the administrative interface can be 
    5555               found.  This target must be  defined  previously  in  cherokee- 
    …… 
    5959               highly encouraged. 
    6060 
    61        -l, --log=PATH 
     61       -l, --log=PATH:: 
    6262               Log file to be rotated (Only to be used when -c is logrotate) 
    6363 
    64        -t, --trace=STRING 
     64       -t, --trace=STRING:: 
    6565               Modules to be traced (Only to be used when -c is trace). Chero‐ 
    6666               kee must have been compiled with the --enable-trace for this to 
    …… 
    7474Administration`. This can be done through the 'Virtual Servers' option, 
    7575in 'Behaviour' and using the 'Add new rule' option. 
     76 
     77image::media/images/cherokee-tweak.png[Setting up an admin interface] 
    7678 
    7779Please note that while you are at it, the deffinition of a security 

  • cherokee/trunk/doc/bundle_cherokee.txt

    r1724 r1740  
    2020 
    2121*OPTIONS*:: 
    22        This command will launch the Cherokee webserver. It accepts the 
    23        following options: 
     22       This command will launch the Cherokee webserver. It accepts the following options. 
    2423 
    25  
    26        -h, --help 
     24       -h, --help:: 
    2725               Prints a brief help message and terminates execution 
    2826 
    29        -V, --version 
     27       -V, --version:: 
    3028               Prints Cherokee’s version and terminates execution 
    3129 
    32        -t, --test 
    33                Perform a sanity check on the configuration  file.  The  server 
    34                will not run. 
     30       -t, --test:: 
     31               Perform a sanity check on the configuration  file.  The  server will not run. 
    3532 
    36        -d, --detach 
    37                Launches  the server as a background process (default behaviour 
    38                is to stay attached to the controlling terminal). 
     33       -d, --detach:: 
     34               Launches  the server as a background process (default behaviour is to stay attached to the controlling terminal). 
    3935 
    40        -C, --config=PATH 
    41                Specifies  a  configuration  file  other   than   the   default 
    42                /etc/cherokee/cherokee.conf 
     36       -C, --config=PATH:: 
     37               Specifies  a  configuration  file  other   than   the   default /etc/cherokee/cherokee.conf 
    4338 
    44        -p, --port=PORT 
     39       -p, --port=PORT:: 
    4540               TCP port number to which the server will listen. 
    4641 
    47        -r, --documentroot=PATH 
    48                Launches  a server exposing statically the specified directory. 
    49                When launched with -r, the configuration file is  ignored, and 
    50                the Cherokee instance runs with its default values. 
     42       -r, --documentroot=PATH:: 
     43               Launches  a server exposing statically the specified directory. When launched with -r, the configuration file is  ignored, and the Cherokee instance runs with its default values. 
    5144 
    52        -i, --print 
     45       -i, --print:: 
    5346               Print server technical information. 
    5447********************************************************************** 

  • cherokee/trunk/doc/bundle_spawn-fcgi.txt

    r1724 r1740  
    2525       spawn-fcgi accepts the following options: 
    2626 
    27        -h      General usage instructions 
     27       -h:: 
     28             General usage instructions 
    2829 
    29        -f <fcgiapp> 
    30                Filename of the FastCGI application to spawn 
     30       -f <fcgiapp>:: 
     31             Filename of the FastCGI application to spawn 
    3132 
    32        -a <addr> 
    33                IP address to bind to (for TCP/IP-based IPC) 
     33       -a <addr>:: 
     34             IP address to bind to (for TCP/IP-based IPC) 
    3435 
    35        -p <port> 
    36                TCP port to bind to (for TCP/IP-based IPC) 
     36       -p <port>:: 
     37             TCP port to bind to (for TCP/IP-based IPC) 
    3738 
    38        -s <path> 
    39                Path to the Unix-domain socket to bind to  (for  Unix  sockets- 
    40                based IPC) 
     39       -s <path>:: 
     40             Path to the Unix-domain socket to bind to  (for  Unix  sockets-based IPC) 
    4141 
    42        -C <children> 
    43                (PHP only) Number of children to spawn. Defaults to 5. 
     42       -C <children>:: 
     43             (PHP only) Number of children to spawn. Defaults to 5. 
    4444 
    45        -F <children> 
    46                Number of children to fork. Defaults to 1. 
     45       -F <children>:: 
     46             Number of children to fork. Defaults to 1. 
    4747 
    48        -P <path> 
    49                Name of the PID file for spawned processes 
     48       -P <path>:: 
     49             Name of the PID file for spawned processes 
    5050 
    51        -n      No forking should take place (for daemontools) 
     51       -n:: 
     52             No forking should take place (for daemontools) 
    5253 
    53        -v      Shows version information and exits 
     54       -v:: 
     55             Shows version information and exits 
    5456 
    55        -c <dir> 
    56                Chroot to specified directory (can only be invoked by root) 
     57       -c <dir>:: 
     58             Chroot to specified directory (can only be invoked by root) 
    5759 
    58        -u      User ID to change to (can only be invoked by root) 
     60       -u:: 
     61             User ID to change to (can only be invoked by root) 
    5962 
    60        -g      Group ID to change to (can only be invoked by root) 
     63       -g:: 
     64             Group ID to change to (can only be invoked by root) 
    6165********************************************************************** 

  • cherokee/trunk/doc/config_advanced.txt

    r1647 r1740  
    22---------------------- 
    33 
    4 To be written 
     4Through this section you can fine-tune several of Cherokee's 
     5parameters. You should not attempt to do so unless you really know 
     6what you are doing. For most cases the default parameters will work 
     7just fine. 
     8 
     9You should at least read the chapter 
     10link:cookbook_optimizing_cherokee.html[Optimizing Cherokee] before you 
     11start tweaking things here. 
    512 
    613image::media/images/admin_advanced.png[Cherokee Admin interface] 
    714 
     15System tweaking 
     16~~~~~~~~~~~~~~~ 
     17* Thread Number: 
     18  Adjust the number of threads for Cherokee to work with. Increasing 
     19  this will allow for better parallelization at the cost of system 
     20  resources. Highly constrained environments such as embedded devices 
     21  will probably be fine with just one. This doesn't translate into 
     22  just one connection at the time, since a thread can handle many. 
     23 
     24* Thread Policy: 
     25  Defines the thread policy to be applied by the OS: FIFO, Round Robin 
     26  or Dynamic. 
     27 
     28* File descriptors: 
     29  This can alter the number of file descriptors handled by the server 
     30  should handle. The default value is what `ulimit -n` reports. An 
     31  increase in this value improves performance under very high server load. 
     32 
     33Server tweaking 
     34~~~~~~~~~~~~~~~ 
     35* Polling Method: 
     36  This affects the internal file descriptor polling method among the 
     37  ones supported by the OS. The full list of options is `epoll()`, `poll()` 
     38  and `select()`. If you don't know what this is or how this affects 
     39  performance, just choose `Automatic`. This will choose the most 
     40  efficient one among the present at any given time. 
     41 
     42* Sendfile min/max size: 
     43  These allow to configure the range of file sizes that can be sent 
     44  with `sendfile()`. Default: [32768 Bytes - 2 GB]. 
     45 
     46* Panic action: 
     47  This specifies the program that will be called in case the server 
     48  fails. It defaults to `cherokee-panic`, which is provided with 
     49  Cherokee. This in turn performs the actions specified in the 
     50  `CHEROKEE_PANIC_OUTPUT` environment variable. If none is set, it will 
     51  attempt to send an email to the system administrator with a 
     52  backtrace of what happened. As a last resort, if no mailer is 
     53  available in the system, it will simply try to show this information 
     54  on screen if possible. 
     55 
     56* PID file: 
     57  If specified, a PID file will be created in that path. This is 
     58  useful to trace what is going on with Cherokee. 
     59 
     60Server behavior 
     61~~~~~~~~~~~~~~~ 
     62* Listening queue length: This specifies the size of the incoming 
     63  connection queue. It is the effective buffer of connections that 
     64  will be served even if there are no connection slots available at 
     65  the moment. 
     66 
     67* Reuse connections: 
     68  Cherokee implements an intelligent mechanism to reuse connections if 
     69  possible, allowing it to improve performance by not having to 
     70  reinitialize structures in memory that can serve perfectly well for 
     71  more than one time. It defaults to 20. Though this mechanism is an obvious 
     72  improvent, limiting this limit is useful for cases when a sudden 
     73  burst of connections happens. In those cases it doesn't make much 
     74  sense to keep reusing many more connections than those of an average 
     75  load for any other moment. 
     76 
     77* Log flush time: 
     78  Time interval in seconds to wait between log updates. Defaults to 10 seconds. 
     79 
     80* Max keepalive reqs: 
     81  This limits the number of HTTP requests that can be served by each 
     82  keepalive connection. Keepalive connections improve performance, but 
     83  surpasing certain amount of requests per each connection is an 
     84  indicator that something out of the ordinary is happening. This 
     85  prevents the appearence of any problems related to these situations. 
     86 

  • cherokee/trunk/doc/config_general.txt

    r1647 r1740  
    55 
    66 
    7 Binding 
    8 ~~~~~~~ 
    9 When the server is initiated it opens a port and starts listening to incoming  
    10 requests. By default this is port 80 and it will use all the  
    11 network interfaces of the machine, which is usually the desired behavior.  
     7Networking 
     8~~~~~~~~~~ 
     9 
     10Binding: 
     11^^^^^^^ 
     12When the server is initiated it opens a port and starts listening to 
     13incoming requests. By default this is port 80 and it will use all the 
     14network interfaces of the machine, which is usually the desired 
     15behavior. The *Port TLS* specifies the port to be used for secure 
     16connections. 
    1217 
    1318 
    1419IPv6 support 
    15 ~~~~~~~~~~~~ 
    16 The IPv6 configuration key brings the possibility of activating or deactivating  
    17 the IPv6 support at the server. If Cherokee has been compiled with IPv6  
    18 support (--with-ipv6), this configuration entry will be fully functional,  
    19 otherwise it will be ignored. 
     20^^^^^^^^^^^^ 
     21The IPv6 configuration key brings the possibility of activating or 
     22deactivating the IPv6 support at the server. If Cherokee has been 
     23compiled with IPv6 support (--with-ipv6), this configuration entry 
     24will be fully functional, otherwise it will be ignored. 
    2025 
    2126 
     27Listen 
     28^^^^^^ 
     29This specifies the IP of the network interface to use. It can be left 
     30empty. 
     31 
     32 
     33Basic Behavior 
     34~~~~~~~~~~~~~~ 
     35 
    2236Timeout 
    23 ~~~~~~~ 
    24 Sets the number of seconds that Cherokee will wait before closing the  
    25 connection.  
     37^^^^^^^ 
     38Sets the number of seconds that Cherokee will wait before closing the 
     39connection. 
    2640 
    2741 
    2842KeepAlive 
    29 ~~~~~~~~~ 
    30 Enables the global keep-alive support for the client requests. 
    31 It increases the client performance by reusing a connection for more  
    32 than one request. It should most probably be turned on. 
     43^^^^^^^^^ 
     44Enables the global keep-alive support for the client requests. It 
     45increases the client performance by reusing a connection for more than 
     46one request. It should most probably be turned on. 
    3347 
    3448 
    3549Server Tokens 
    36 ~~~~~~~~~~~~~ 
     50^^^^^^^^^^^^^ 
     51 
     52This specifies the string that Cherokee should use to identify 
     53itself. 
    3754 
    3855[grid="rows"] 
    3956``~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
    40 Parameters,                Description 
     57Parameters               , Description 
    4158~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
    4259Product                  , Cherokee 
    43 Minor                    , Cherokee/{cherokee_version} 
    44 Minimal                  , Cherokee/{cherokee_version} 
    45 OS                       , Cherokee/{cherokee_version} (UNIX) 
    46 Full                     , Cherokee/{cherokee_version} (UNIX) Ext/0.0 Ext2/0.0 
     60Minor                    , Cherokee/0.8 
     61Minimal                  , Cherokee/0.8.0 
     62OS                       , Cherokee/0.8.0 (UNIX) 
     63Full                     , Cherokee/0.8.0 b1234 (UNIX) 
    4764~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
    4865 
    49 By default, Cherokee will use **Full**. 
     66By default, Cherokee will use *Full*. 
    5067 
    5168 
    52 Execution User and Group 
    53 ~~~~~~~~~~~~~~~~~~~~~~~~ 
    5469 
    55 The User directive configures which user the Cherokee daemon will normally  
    56 run as. By default, Cherokee runs as root which is considered undesirable  
    57 in all but the most trustful network configurations.  
     70Server Permissions 
     71~~~~~~~~~~~~~~~~~~ 
    5872 
    59 The User directive used in conjunction with the Group directive instructs  
    60 the daemon to switch to the specified user and group as quickly as  
    61 possible after startup.  
     73User & Group 
     74^^^^^^^^^^^^ 
    6275 
    63 There are two possible formats: using the user or group name, or using  
     76The User directive configures which user the Cherokee daemon will 
     77normally run as. By default, Cherokee runs as root which is considered 
     78undesirable in all but the most trustful network configurations. 
     79 
     80The User directive used in conjunction with the Group directive 
     81instructs the daemon to switch to the specified user and group as 
     82quickly as possible after startup. 
     83 
     84There are two possible formats: using the user or group name, or using 
    6485the system ID. 
    6586 
     87Chroot 
     88^^^^^^ 
     89 
     90Cherokee can be jailed inside a directory. Note that this should not 
     91be used as the sole security measure. 

  • cherokee/trunk/doc/config_icons.txt

    r1647 r1740  
    33 
    44The icons configuration file associates an icon image with one or more 
    5 file extensions. This information will be used mainly by the link:modules_handlers_dirlist.html[dirlist] handler. 
     5file extensions. This information will be used mainly by the 
     6link:modules_handlers_dirlist.html[dirlist] handler. 
    67 
    7 * **Files** 
    8  
    9    - This section lets you specify an icon for certain filenames such as "core" or "README".  
    10      It accepts wild-card strings (using * and ?) 
    11  
    12 image::media/images/admin_icons3.png[Icons] 
    138 
    149* **Extensions** 
    1510 
    16     - In the same way, it allows to associate icons with extensions 
     11    - This allows to associate icons with extensions. 
    1712 
    1813image::media/images/admin_icons1.png[Icons] 
    …… 
    2116* **Special icons** 
    2217 
    23     - **Directory**: In this case, it specifies the icon to be used with Directories. 
     18    - **Directory**: In this case, it specifies the icon to be used 
     19        with Directories. 
    2420 
    25     - **ParentDirectory**: This entry is used to assign an Icon to the "go to the parent  
    26       directory" action. 
     21    - **ParentDirectory**: This entry is used to assign an Icon to the 
     22        "go to the parent directory" action. 
    2723 
    28     - **Default**: This is the icon that will be shown if any of the previous ones matched.  
     24    - **Default**: This is the icon that will be shown if any of the 
     25        previous ones matched. 
    2926 
    3027image::media/images/admin_icons2.png[Icons] 
     28 
     29* **Files** 
     30 
     31   - This section lets you specify an icon for certain filenames such 
     32     as "core" or "README". It accepts wild-card strings (using * and 
     33     ?) 
     34 
     35image::media/images/admin_icons3.png[Icons] 
     36 

  • cherokee/trunk/doc/config_virtual_servers.txt

    r1647 r1740  
    22-------------- 
    33 
    4 'Virtual Server' is an abstraction mechanism that allows you to define a custom  
    5 number of parameters and rules that have to be applied to one or more domains. 
    6  
    7 In a Cherokee server there must be at least one virtual server named default,  
    8 and there is no maximum number.  
    9 It is important to know that this server cannot be deleted. 
    10  
    11 When the server receives a request it will try to match the domain name specified  
    12 in the virtual server that should handle it. In case no virtual server matches  
    13 the request, default will be used. 
    14  
    15  
    16 Add a new Virtual Server 
    17 ~~~~~~~~~~~~~~~~~~~~~~~~ 
    18 You have to enter the server name and a valid Document Root directory in  
    19 order to create a new virtual server. 
     4'Virtual Server' is an abstraction mechanism that allows you to define 
     5a custom number of parameters and rules that have to be applied to one 
     6or more domains. 
     7 
     8In a Cherokee server there must be at least one virtual server named 
     9default, and there is no maximum number. It is important to know that 
     10this server cannot be deleted. 
     11 
     12When the server receives a request it will try to match the domain 
     13name specified in the virtual server that should handle it. In case no 
     14virtual server matches the request, default will be used. 
     15 
     16Three main options are accessible through this menu: 
     17. Virtual Server List 
     18. Add new Virtual Server 
     19. Clone Virtual Server 
     20 
     21*Cloning a Virtual Server* is simply a matter of selecting a target name 
     22and a source virtual server currently present. Every setting will be 
     23duplicated. From then onwards changes applied to any of them, be it 
     24the original or the copied Virtual Servers, will only apply to the 
     25implicated one. This is a great way to set up complex domains, 
     26since you can use the existing ones as templates to be refined with 
     27further work. 
     28 
     29*To add a new Virtual Server* you have to enter the server name and a 
     30valid Document Root directory. 
    2031 
    2132image::media/images/admin_vserver.png[Virtual server] 
    …… 
    2435- *Document Root* 
    2536 
    26 This directive sets the directory from which Cherokee will serve files.  
    27 The set of rules is checked from the highest to the lowest possible priority.  
    28 Once a rule is matched, the server appends the path from the requested URL to  
    29 the document root to make the path to the document. If it is a directory, this  
    30 information is used. If other rules apply to a parent directory, those are applied  
    31 as well without overwriting the original behavior: 
    32  
    33 ---- 
    34          http://www.example.com/index.html refers to /var/www/index.html 
    35 ---- 
    36  
    37 This might seem complicated but it's actually simple to understand. For example suppose  
    38 you had a directory called /secret that was protected with authentication, and there 
    39 was also a rule with higher priority for /secret/cgi that only specified to use  
    40 the CGI handler. Under these circumstances, if a request was received for  
    41 /secret/cgi/something then the CGI handler would be taken and it would inherit the  
    42 authentication specified for /secret. 
     37This directive sets the directory from which Cherokee will serve 
     38files. The set of rules is checked from the highest to the lowest 
     39possible priority. Once a rule is matched, the server appends the path 
     40from the requested URL to the document root to make the path to the 
     41document. If it is a directory, this information is used. If other 
     42rules apply to a parent directory, those are applied as well without 
     43overwriting the original behavior: 
     44 
     45---- 
     46        http://www.example.com/index.html refers to /var/www/index.html 
     47---- 
     48 
     49This might seem complicated but it's actually simple to 
     50understand. For example suppose you had a directory called /secret 
     51that was protected with authentication, and there was also a rule with 
     52higher priority for /secret/cgi that only specified to use the CGI 
     53handler. Under these circumstances, if a request was received for 
     54/secret/cgi/something then the CGI handler would be taken and it would 
     55inherit the authentication specified for /secret. 
     56 
    4357 
    4458- *Name* 
    4559 
    46 Name is an alias. The domain names handled by the virtual server should be  
    47 specified later in the virtual server details page. 
    48 -- 
    49  
    50 Now, we can configure our new virtual server.  
     60Name is an alias. The domain names handled by the virtual server 
     61should be specified later in the virtual server details page. 
     62 
     63-- 
     64 
     65The *Virtual Server List* is by far the most interesting of these 
     66three main options. It gives an overview of the existing virtual 
     67servers, and allows to configure in detail every possible setting. 
     68 
     69image::media/images/admin_vserver_vserver.png[Virtual server overview] 
     70 
     71A detailed explanation of every tab follows. 
    5172 
    5273Basics 
    …… 
    5677- *Directory Indexes* 
    5778 
    58 The DirectoryIndex directive sets the list of resources to look for when  
    59 the client requests an index of the directory by specifying a / at the end  
    60 of the directory name. Several URLs may be given, in which case the server  
    61 will return the first one that it finds. If none of the resources exist, the  
    62 server will reply according to the handler behavior. 
     79The DirectoryIndex directive sets the list of resources to look for 
     80when the client requests an index of the directory by specifying a / 
     81at the end of the directory name. Several URLs may be given, in which 
     82case the server will return the first one that it finds. If none of 
     83the resources exist, the server will reply according to the handler 
     84behavior. 
     85 
    6386 
    6487Note that the documents do not need to be relative to the directory: 
    6588 
    6689---- 
    67            index.html,index.txt,/cgi-bin/index.pl 
    68 ---- 
    69  
    70 would cause the CGI script /cgi-bin/index.pl to be executed if neither  
     90       index.html,index.txt,/cgi-bin/index.pl 
     91---- 
     92 
     93would cause the CGI script /cgi-bin/index.pl to be executed if neither 
    7194index.html nor index.txt existed in a directory. 
    7295 
    73 There is a special case in which the directory index entry starts with  
    74 a slash. For example, /cgi-bin/index.pl. In that case, it will use it as  
    75 the object accessible under that public address of the same virtual server, 
    76 so it will take care about the possible configuration of  
    77 the /cgi-bin/ directory and/or the pl extension. 
     96There is a special case in which the directory index entry starts with 
     97a slash. For example, /cgi-bin/index.pl. In that case, it will use it 
     98as the object accessible under that public address of the same virtual 
     99server, so it will take care about the possib