Changeset 1724

Show
Ignore:
Timestamp:
08/04/08 18:55:15 (5 months ago)
Author:
taher
Message:

--

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • cherokee/trunk/ChangeLog

    r1722 r1724  
     12008-08-04  Taher Shihadeh <taher@unixwars.com> 
     2 
     3        * doc/basics_*, doc/bundle_*: completed a couple of the new sections. 
     4         
     52008-08-04  Taher Shihadeh <taher@unixwars.com> 
     6 
     7        * doc/modules_validators_ldap.txt: documentation for the LDAP handler. 
     8 
    192008-08-04  Alvaro Lopez Ortega  <alvaro@alobbs.com> 
    210 
    …… 
    6142008-08-03  Taher Shihadeh <taher@unixwars.com> 
    715 
    8         * doc/*: more documentation contributions and refactoring. 
     16       * doc/*: more documentation contributions and refactoring. 
    917 
    10182008-08-03  Alvaro Lopez Ortega  <alvaro@alobbs.com> 
    …… 
    991072008-08-01  Taher Shihadeh <taher@unixwars.com> 
    100108 
    101         * doc/build/installation_unix.txt, doc/build/download.txt, 
    102         doc/build/installation_windows.txt, doc/build/why_cherokee.txt, 
    103         doc/build/running_cherokee.txt, doc/build/TODO: beggining to 
    104         upload the new proposed documentation drafts. 
     109       * doc/build/installation_unix.txt, doc/build/download.txt, 
     110       doc/build/installation_windows.txt, doc/build/why_cherokee.txt, 
     111       doc/build/running_cherokee.txt, doc/build/TODO: beggining to 
     112       upload the new proposed documentation drafts. 
    105113 
    1061142008-08-01  Alvaro Lopez Ortega  <alvaro@alobbs.com> 

  • cherokee/trunk/cherokee-guardian.1

    r1553 r1724  
    3131.B cherokee\-guardian 
    3232.SH DESCRIPTION 
    33 \fBcherokee\fP is an extremely fast, flexible and embedable web 
     33\fBcherokee\fP is an extremely fast, flexible and embeddable web 
    3434server.  \fBcherokee\-guardian\fP is the recommended way to invoke 
    3535cherokee - It will launch Cherokee with any options specified to it 
    …… 
    5353in the body of the message. The submission address is cherokee@cherokee-project.com. 
    5454.SH "SEE ALSO" 
    55 For information on the options with which Cherokee itself accepts, 
     55For information on the options which Cherokee itself accepts, 
    5656please refer to  \&\fIcherokee\fR\|(1) 
    5757. 

  • cherokee/trunk/cherokee.1

    r1698 r1724  
    1313.\" the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. 
    1414.\" 
    15 .TH Cherokee 1 "July 28, 2008" 
     15.TH Cherokee 1 "August 04, 2008" 
    1616.\" Please update the above date whenever this man page is modified. 
    1717.\" 
    …… 
    3131.B cherokee [options] 
    3232.SH DESCRIPTION 
    33 \fBcherokee\fP is an extremely fast, flexible and embedable web server. 
     33\fBcherokee\fP is an extremely fast, flexible and embeddable web server. 
    3434.\" .PP 
    3535.\" It also... 
    36 .SH EXAMPLE 
     36.SH OPTIONS 
    3737This command will launch the Cherokee webserver. It accepts the 
    3838following options: 
     39.TP 8 
     40.B \-h, --help 
     41Prints a brief help message and terminates execution 
     42.TP 8 
     43.B \-V, --version 
     44Prints Cherokee's version and terminates execution 
     45.TP 8 
     46.B \-t, --test 
     47Perform a sanity check on the configuration file. The server will not run. 
    3948.TP 8 
    4049.B \-d, --detach 
    …… 
    4352.TP 8 
    4453.B \-C, --config=PATH 
    45 Specifies a configuration file other than the default 
    46 /etc/cherokee/cherokee.conf 
     54Specifies an alternative path for the configuration file to use instead 
     55of the default cherokee.conf 
     56.TP 8 
     57.B \-p, --port=PORT 
     58TCP port number to which the server will listen. 
    4759.TP 8 
    4860.B \-r, --documentroot=PATH 
    …… 
    5163instance runs with its default values. 
    5264.TP 8 
    53 .B \-p, --port=PORT 
    54 TCP port number to which the server will listen. 
    55 .TP 8 
    56 .B \-t, --test 
    57 Perform a sanity check on the configuration file. The server will not run. 
    58 .TP 8 
    59 .B \-h, --help 
    60 Prints a brief help message and terminates execution 
    61 .TP 8 
    6265.B \-i, --print 
    63 Print server technical information.TP 8 
    64 .TP 8 
    65 .B \-V, --version 
    66 Prints Cherokee's version and terminates execution 
     66Print server technical information. 
    6767.SH BUGS 
    6868.SS Bug reports 

  • cherokee/trunk/doc/Makefile.am

    r1719 r1724  
    11DOC_RELEASE=0.8.0 
    2 ASCIIDOC=python $(top_srcdir)/doc/build/asciidoc.py -b xhtml11 --conf-file=$(top_srcdir)/doc/build/chunked_template.conf -a cherokee_version=$(DOC_RELEASE) 
     2 
     3ASCIIDOC=python $(top_srcdir)/doc/build/asciidoc.py --unsafe -b xhtml11 --conf-file=$(top_srcdir)/doc/build/chunked_template.conf -a cherokee_version=$(DOC_RELEASE) 
    34ASCIIDOC_TOC=python $(top_srcdir)/doc/build/asciidoc.py -b xhtml11 -s  
    45 
    …… 
    1920basics_installation_unix.html \ 
    2021basics_installation_windows.html \ 
     22basics_upgrade.html \ 
    2123basics_running_cherokee.html \ 
     24bundle_cherokee.html \ 
     25bundle_cherokee-admin.html \ 
     26bundle_cherokee-config.html \ 
     27bundle_cherokee-guardian.html \ 
     28bundle_cherokee-tweak.html \ 
     29bundle_spawn-fcgi.html \ 
    2230index.html \ 
    2331authentication.html \ 
    …… 
    3038internal_configuration.html \ 
    3139advanced.html \ 
    32 admin.html \ 
    33 download.html \ 
    3440generating_ssl_keys.html \ 
    3541icons.html \ 
    36 cherokee_tweak.html 
    37  
    38 dochandlersdir = $(docdir)/ 
    39 dochandlers_DATA = \ 
     42modules_balancers_round_robin.html \ 
     43modules_encoders_gzip.html \ 
    4044modules_handlers_file.html \ 
    4145modules_handlers_dirlist.html \ 
    …… 
    4448modules_handlers_cgi.html \ 
    4549modules_handlers_fastcgi.html \ 
    46 modules_handlers_scgi.html 
    47  
    48 docloggersdir = $(docdir)/ 
    49 docloggers_DATA = \ 
     50modules_handlers_scgi.html \ 
    5051modules_loggers_combined.html \ 
    5152modules_loggers_ncsa.html \ 
    52 modules_loggers_w3c.html 
    53  
    54 docencodersdir = $(docdir)/ 
    55 docencoders_DATA = \ 
    56 modules_encoders_gzip.html 
    57  
    58 docbalancersdir = $(docdir)/ 
    59 docbalancers_DATA = \ 
    60 modules_balancers_round_robin.html 
    61  
    62 docvalidatorsdir = $(docdir)/ 
    63 docvalidators_DATA = \ 
     53modules_loggers_w3c.html \ 
    6454modules_validators_htdigest.html \ 
    6555modules_validators_htpasswd.html \ 
    …… 
    9787media/images/admin_handler_onlylisting.png \ 
    9888media/images/admin_handler_onlylisting_ex.png \ 
    99 media/images/admin_launch.png 
     89media/images/admin_launch.png \ 
     90media/images/tracelor.png \ 
     91media/images/cherokee-tweak.png 
    10092 
    101  
    102 GENERATED_FILES = \ 
    103 $(doc_DATA) \ 
    104 $(dochandlers_DATA) \ 
    105 $(docloggers_DATA) \ 
    106 $(docvalidators_DATA) \ 
    107 $(docbalancers_DATA) \ 
    108 $(docencoders_DATA) 
    109  
     93GENERATED_FILES =   \ 
     94$(docdir_DATA) 
    11095 
    11196EXTRA_DIST = \ 
    …… 
    11398$(docmediacss_DATA) \ 
    11499$(docmediaimages_DATA) 
    115  

  • cherokee/trunk/doc/TOC.txt

    r1718 r1724  
    88   - link:basics_installation_unix.html[Unix] 
    99   - link:basics_installation_windows.html[Windows] 
     10 . link:basics_upgrade.html[Upgrading Cherokee] 
    1011 . link:basics_running_cherokee.txt[Running Cherokee] 
    1112 
    …… 
    1314The Cherokee Bundle 
    1415************************** 
    15   cherokee 
    16   cherokee-admin      [4] 
    17   cherokee-config 
    18   cherokee-guardian 
    19   cherokee-tweak      [14] 
    20   spawn-fcgi 
     16 . link:bundle_cherokee.html[cherokee] 
     17 . link:bundle_cherokee-admin.html[cherokee-admin] 
     18 . link:bundle_cherokee-config.html[cherokee-config] 
     19 . link:bundle_cherokee-guardian.html[cherokee-guardian] 
     20 . link:bundle_cherokee-tweak.html[cherokee-tweak] 
     21 . link:bundle_spawn-fcgi.html[spawn-fcgi] 
    2122 
    2223************************** 
    23 Configuration  
     24Configuration 
    2425************************** 
    25   Walkthrough         <1> 
    26   General             [5] 
    27   Virtual servers     [6] 
    28   Encoding 
    29   Icons               [9] 
    30   Mime Types 
    31   Advanced            [10] 
    32  
    33 ************************** 
    34 Advanced topics 
    35 ************************** 
    36   Debugging           [11] 
    37   Cross compilation   [12] 
    38   Embedding Cherokee  <9> 
    39   Optimizing Cherokee <2> 
     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 
    4033 
    4134************************** 
    4235Cookbook 
    4336************************** 
    44   Reference table     <8> 
    45   Managing logs       <5> 
    46   Authentication      [8] <3> 
    47   SSL/TLS, certs      [13]<6> 
    48   Setting up PHP      <4> 
    49   Setting up Django   <4> 
    50   Setting up RoR      <4> 
     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 
    5147 
    5248************************** 
    …… 
    5450************************** 
    5551  Balancers 
    56     Round robin        [24] 
     52    Round robin        [24]    link:modules_balancers_round_robin.html 
    5753  Encoders 
    58     gzip               [25] 
     54    gzip               [25]    link:modules_encoders_gzip.html 
    5955  Handlers 
    60     cgi                [17] 
    61     common             [18] 
    62     dirlist            [19] 
    63     fastcgi            [20] 
    64     file               [21] 
    65     redir              [22] 
    66     scgi               [23] 
     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 
    6763  Loggers              [16] 
    68     combined           [16.1] 
    69     ncsa               [16.2] 
    70     w3c                [16.3] 
     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 
    7167  Validators           [7] 
    72     htdigest           [7.2] 
    73     htpasswd           [7.1] 
    74     ldap               [7.1] 
    75     mysql              [7.3] 
    76     pam                [7.4] 
    77     plain              [7.5] 
     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 
    7874 
    7975************************** 
    …… 
    8480 
    8581************************** 
    86 Development info      <7> 
     82Development info 
    8783************************** 
    88   cherokee.conf       [15] 
    89   API introduction 
    90   Examples 
     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 

  • cherokee/trunk/doc/TODO

    r1718 r1724  
    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 
     20* <5> How to manage logs  (make specific mention of usage of Cherokee-Tweak). 
    2121* <6> How to manage security (SSL/TLS, certs, etc) 
    2222* <7> Development documentation would be nice to have, Stefan de Konink  
    …… 
    154154  between brackets, and between '<>' the documentation tasks proposed above.  
    155155 
    156  
    157                            
    158   Getting started: 
    159     Why Cherokee?                       why_cherokee.txt 
    160     Requirements                        requirements.txt 
    161     Download            [1]             download.txt 
    162     Installation 
    163      Unix               [3]             installation_unix.txt 
    164      Windows                            installation_windows.txt [incomplete] 
    165     Running Cherokee                    running_cherokee.txt 
    166  
    167   The Cherokee Bundle: 
    168     cherokee 
    169     cherokee-admin      [4] 
    170     cherokee-config 
    171     cherokee-guardian 
    172     cherokee-tweak      [14] 
    173     spawn-fcgi 
    174  
    175   Configuration  
    176     Walkthrough         <1> 
    177      General            [5] 
    178      Virtual servers    [6] 
    179      Encoding 
    180      Icons              [9] 
    181      Mime Types 
    182      Advanced           [10] 
    183  
    184   Advanced topics 
    185     Debugging           [11] 
    186     Cross compilation   [12] 
    187       Embedded Cherokee <9> 
    188     Optimizing Cherokee <2> 
    189  
    190   Cookbook 
    191     Equivalencies table <8> 
    192     Security 
    193       Managing logs     <5> 
    194       Authentication    [8] <3> 
    195       SSL/TLS, certs    [13]<6> 
    196     Setting up PHP      <4> 
    197     Setting up Django   <4> 
    198     Setting up RoR      <4> 
    199  
    200   Modules 
    201     Balancers 
    202      Round robin        [24] 
    203     Encoders 
    204      gzip               [25] 
    205     Handlers 
    206      cgi                [17] 
    207      common             [18] 
    208      dirlist            [19] 
    209      fastcgi            [20] 
    210      file               [21] 
    211      redir              [22] 
    212      scgi               [23] 
    213     Loggers             [16] 
    214      combined           [16.1] 
    215      ncsa               [16.2] 
    216      w3c                [16.3] 
    217     Validators          [7] 
    218      htdigest           [7.2] 
    219      htpasswd           [7.1] 
    220      ldap               [7.1] 
    221      mysql              [7.3] 
    222      pam                [7.4] 
    223      plain              [7.5] 
    224  
    225   Internal conf format  [15] 
    226  
    227   Other resources: 
    228     manpages 
    229     FAQ 
    230     Community 
    231  
    232   Development info      <7> 
    233     API introduction 
    234     Examples 
     156  Refer to TOC.txt to see it. 

  • cherokee/trunk/doc/basics_download.txt

    r1719 r1724  
    2727--------------------------------------------------------------------------- 
    2828 
    29 Finally, if you are a developer or simple want to test out the bleeding edge 
     29Finally, if you are a developer or simply want to test out the bleeding edge 
    3030version, you can access our Subversion repository. Be advised, this is the 
    3131development branch, so use it at your own risk! 

  • cherokee/trunk/doc/basics_running_cherokee.txt

    r1719 r1724  
    66. Automatic start: this makes use of the mechanism offered by your OS 
    77  that should have been configured when Cherokee was installed. It 
    8   will run making use of the link:cherokee.conf.html[`cherokee.conf`] 
     8  will run making use of the link:dev_cherokee.conf.html[`cherokee.conf`] 
    99  present in your system. 
     10 
     11. Guardian wrapper: The 
     12  link:bundle_cherokee-guardian.html[cherokee-guardian] program comes 
     13  as a standard part of the Cherokee bundle. It is a security 
     14  mechanism that ensures Cherokee's recovery in case of any system 
     15  failure. This is what is actually launched when Cherokee is 
     16  automatically started. 
    1017 
    1118. Command line: Cherokee supports a series of parameters to launch it 
    1219  from the command line. Refer to the the appropriate documentation 
    13   section about link:cherokee.html[`cherokee`] to see the complete 
     20  section about link:bundle_cherokee.html[`cherokee`] to see the complete 
    1421  list of optional arguments. 
    15   
     22 
    1623. Cherokee-Admin: The administrative web interface allows you to setup 
    1724  and launch Cherokee. This is probably where you want to start if you 
    1825  have just installed the web server. Launch the 
    19   link:cherokee_admin.html[`cherokee-admin`] process and follow the 
    20   link:walkthrough.html[Walktrhough] section of the documentation. 
     26  link:bundle_cherokee_admin.html[`cherokee-admin`] process and follow the 
     27  link:config_walkthrough.html[Walktrhough] section of the documentation. 
    2128 

  • cherokee/trunk/doc/basics_why_cherokee.txt

    r1719 r1724  
    22------------- 
    33 
    4 Welcome to the Cherokee {cherokee_version} documentation.  
     4Welcome to the Cherokee {cherokee_version} documentation. 
    55Cherokee is high-performance web server. It is very fast, flexible and 
    66easy to configure. It offers support for the widespread technologies 
    …… 
    1111It is highly efficient, extremely lightweight and provides rock solid 
    1212stability. Among its many features there is one that deserves special 
    13 credit: a user friendly interface called cherokee-admin that is 
    14 provided for a no-hassle configuration of every single feature of the 
    15 server.  
     13credit: a user friendly interface called 
     14link:bundle_cherokee-admin.html[cherokee-admin] that is provided for a no-hassle 
     15configuration of every single feature of the server. This 
     16administration interface allows you to configure the web server 
     17without having to worry about editing a text file written with a 
     18certain syntax. 
     19 
     20image::media/images/admin_index.png[Cherokee Admin interface] 
    1621 
    1722Unlike many other web servers out there, Cherokee gracefully handles 
    …… 
    2530literally multiply your existing hardware's performance, extending its 
    2631life cycle or allowing you to have a smaller, more efficient, compact 
    27 and easier to maintain IT infrastructure.  
     32and easier to maintain IT infrastructure. 
    2833 
    2934Best of all, Cherokee is free software, has a thoroughly designed 
    …… 
    3237with, thus allowing you to customize, modify or extend everything to 
    3338suit specific needs. It is also very actively maintained, and every 
    34 interesting feature request is carefully considered.  
     39interesting feature request is carefully considered. 
    3540 
    3641But don't trust everything you are told. Check out the benchmarks and 
    3742the rest of the documentation to learn more, and give it a try to 
    38 squeeze your hardware to the fullest. You will not be disapointed.  
     43squeeze your hardware to the fullest. You will not be disapointed. 
    3944That you can trust. 

  • cherokee/trunk/doc/build/chunked_template.conf

    r1648 r1724  
    1818  </head> 
    1919<body> 
     20<div id="toc"> 
     21include::../TOC.inc[] 
     22</div> 
    2023 
    2124[footer] 

  • cherokee/trunk/doc/debug.txt

    r1721 r1724  
    8787 
    8888  image::media/images/tracelor.png[Output of tracelor.py] 
    89  
    90  
    91  

  • cherokee/trunk/doc/index.txt

    r1702 r1724  
    22---------------------- 
    33 
    4 Welcome to the Cherokee {cherokee_version} documentation. 
    54 
    6 Compiling and Installing 
    7 ~~~~~~~~~~~~~~~~~~~~~~~~ 
    8  
    9 If you are not comfortable with rolling your own Cherokee, then check our  
    10 listings of pre-compiled link:http://www.cherokee-project.com/downloads.html[binaries]. 
    11 Specific instructions for building your own copy are available at:  
    12  
    13     - link:compiling_and_installing_unix.html[Unix] 
    14     - link:compiling_and_installing_windows.html[Windows] 
    15  
    16 Configuration Interface 
    17 ~~~~~~~~~~~~~~~~~~~~~~~ 
    18  
    19 Cherokee provides an administration interface named link:admin.html[Cherokee Admin]  
    20 that allows to configure the web server without having to worry about 
    21 editing a text file written with a certain syntax. 
    22  
    23 image::media/images/admin_index.png[Cherokee Admin interface] 
    245 
    256General configuration 

  • cherokee/trunk/doc/modules_validators_ldap.txt

    r1721 r1724  
    2323__tls__               , Optional. Enable the use of TLS based integrity. \ 
    2424                        Defaults to __0__. 
    25 __ca_file__           , Optional. It Certificate File. Must be provided  \ 
     25__ca_file__           , Optional. It's the CA filename. Must be provided  \ 
    2626                        if TLS is enabled.  
    2727~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~