Changeset 1752

Show
Ignore:
Timestamp:
08/06/08 18:39:41 (5 months ago)
Author:
taher
Message:

--

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • cherokee/trunk/ChangeLog

    r1751 r1752  
     12008-08-06  Taher Shihadeh <taher@unixwars.com> 
     2 
     3 
    142008-08-06  Alvaro Lopez Ortega  <alvaro@alobbs.com> 
    25 

  • cherokee/trunk/admin/ModuleRedir.py

    r1749 r1752  
    1616        Module.__init__ (self, 'redir', cfg, prefix, submit_url) 
    1717        FormHelper.__init__ (self, 'redir', cfg) 
    18                  
     18 
    1919    def _op_render (self): 
    2020        cfg_key = "%s!rewrite" % (self._prefix) 

  • cherokee/trunk/admin/PageEntry.py

    r1744 r1752  
    114114        pre  = self._conf_prefix 
    115115        tabs = [] 
    116          
     116 
    117117        # Rule Properties 
    118         tabs += [('Rule', self._render_rule())]         
     118        tabs += [('Rule', self._render_rule())] 
    119119 
    120120        # Handler 
    121121        table = TableProps() 
    122         e = self.AddPropOptions_Reload (table, 'Handler', '%s!handler'%(pre),  
     122        e = self.AddPropOptions_Reload (table, 'Handler', '%s!handler'%(pre), 
    123123                                        modules_available(HANDLERS), NOTE_HANDLER) 
    124124        self.AddPropEntry (table, 'Document Root', '%s!document_root'%(pre), NOTE_DOCUMENT_ROOT) 
    …… 
    134134        txt  = '<h1>%s</h1>' % (self._get_title (html=True)) 
    135135        txt += self.InstanceTab (tabs) 
    136         form = Form (self.submit_url, add_submit=False) 
     136        form = Form (self.submit_url, auto=False) 
    137137        return form.Render(txt) 
    138138 

  • cherokee/trunk/doc/Makefile.am

    r1744 r1752  
    2828bundle_cherokee-tweak.html \ 
    2929bundle_spawn-fcgi.html \ 
    30 config_walkthrough.html \ 
     30bundle_cget.html \ 
     31config_quickstart.html \ 
    3132config_general.html \ 
    3233config_virtual_servers.html \ 

  • cherokee/trunk/doc/TOC.txt

    r1744 r1752  
    55 . link:basics_requirements.html[Requirements] 
    66 . link:basics_download.html[Download] 
    7  . link:basics_installation_unix.html[Installation] 
    8    - link:basics_installation_unix.html[Unix] 
    9    - link:basics_installation_windows.html[Windows] 
     7 . link:basics_installation_unix.html[Installation: Unix] 
     8 . link:basics_installation_windows.html[Installation: Windows] 
    109 . link:basics_upgrade.html[Upgrading Cherokee] 
    1110 . link:basics_running_cherokee.html[Running Cherokee] 
    …… 
    1918 . link:bundle_cherokee-guardian.html[cherokee-guardian] 
    2019 . link:bundle_cherokee-tweak.html[cherokee-tweak] 
    21  . link:bundle_spawn-fcgi.html[spawn-fcgi] 
     20 . link:bundle_cget.html[cget] 
    2221 
    2322************************** 
    2423Configuration 
    2524************************** 
    26   Walkthrough         <1>      link:config_walkthrough.html[] 
     25  . Quickstart         <1>     link:config_quickstart.html[] 
    2726  . link:config_general.html[General] 
    2827  . link:config_virtual_servers.html[Virtual servers] 

  • cherokee/trunk/doc/TODO

    r1724 r1752  
    44Needs: 
    55---------- 
    6 * [1] Improve the navigability of the documentation. 
    7 * [2] Define a convenient hierarchical structure, generate a TOC, etc.  
     6 [1] Improve the navigability of the documentation. 
     7 [2] Define a convenient hierarchical structure, generate a TOC, etc.  
    88      Currently the structure reflects more the internal architecture of  
    99      Cherokee rather than a traditional manual. 
    …… 
    2525      documentations scope. A Development section could be introduced when we 
    2626      design the new general draft. 
    27 * <8> Table with equivalent functionality (and hopefully a full setup example) 
    28       to that of specific  mod_* Apache modules. 
     27* <8> Reference table of functionalities to be achieved (and hopefully 
     28      a full setup example). 
    2929* <9> Cherokee on exotic devices 
    30  
    31 Actual Structure: 
    32 ------------------------ 
    33   Currently there is a way to generate a combined documentation with a TOC, 
    34   but navigability is less than optimal. A combined.html file can be created 
    35   using Asciidoc with the doc/build/build_combined.sh script, but internal  
    36   navigability is less than optimal. There might be a way to fix this other 
    37   than combining the whole documentation into a unique TXT file for Asciidoc 
    38   to process. The mentioned script creates the following Table of Contents: 
    39  
    40   1. Download 
    41   2. Cherokee Documentation 
    42     2.1. Compiling and Installing 
    43     2.2. Configuration Interface 
    44     2.3. General configuration 
    45     2.4. Virtual Servers 
    46     2.5. Encoders 
    47     2.6. Icons 
    48     2.7. Advanced topics 
    49     2.8. Other advanced topics 
    50     2.9. Internal configuration system 
    51   3. Compiling and installing on Unix 
    52     3.1. Required 
    53     3.2. Optional 
    54     3.3. Quickstart 
    55     3.4. Advanced parameters 
    56     3.5. Autostart 
    57   4. Cherokee Admin 
    58   5. General Configuration 
    59     5.1. Binding 
    60     5.2. IPv6 support 
    61     5.3. Timeout 
    62     5.4. KeepAlive 
    63     5.5. Server Tokens 
    64     5.6. Execution User and Group 
    65   6. Virtual Server 
    66     6.1. Add a new Virtual Server 
    67     6.2. Basics 
    68     6.3. Domain names 
    69     6.4. Behavior 
    70     6.5. Error Handler 
    71     6.6. Logging 
    72     6.7. Security 
    73   7. Authentication 
    74     7.1. Htpasswd Validator 
    75         7.1.1. Parameters 
    76         7.1.2. Compatibility 
    77         7.1.3. Example 
    78     7.2. Htdigest Validator 
    79         7.2.1. Parameters 
    80         7.2.2. Compatibility 
    81         7.2.3. Example 
    82     7.3. Mysql Validator 
    83         7.3.1. Parameters 
    84         7.3.2. Compatibility 
    85         7.3.3. Example 
    86     7.4. Pam Validator 
    87         7.4.1. Parameters 
    88         7.4.2. Compatibility 
    89         7.4.3. Example 
    90     7.5. Plain Validator 
    91         7.5.1. Syntax 
    92         7.5.2. Parameters 
    93         7.5.3. Compatibility 
    94         7.5.4. Example 
    95   8. Virtual Server Rule 
    96     8.1. OnlySecure 
    97     8.2. Allow From 
    98     8.3. Examples 
    99     8.4. Authentication 
    100   9. Icons 
    101   10. Advanced Configuration 
    102   11. Debugging Cherokee 
    103   12. How to cross compile Cherokee 
    104      12.1. Cherokee-Win32 from Linux 
    105      12.2. Cherokee-Win32 from OS X 
    106   13. How to generate SSL keys 
    107      13.1. Locate CA.pl or CA.sh 
    108      13.2. Create a new CA 
    109      13.3. Generate a certificate request 
    110      13.4. Sign the certificate request 
    111      13.5. Self signed certificates 
    112   14. Cherokee Tweak 
    113   15. Internal Configuration 
    114      15.1. Introduction 
    115      15.2. Server 
    116      15.3. Server Encoders 
    117      15.4. Virtual Server 
    118      15.5. Defining a virtual server behavior 
    119      15.6. Logs 
    120      15.7. Inclusion of Configuration 
    121   16. Loggers 
    122      16.1. Combined 
    123      16.2. NCSA 
    124      16.3. W3C 
    125   17. Handler: CGI 
    126      17.1. Parameters 
    127      17.2. Examples 
    128   18. Handler: List & Send 
    129      18.1. Parameters 
    130      18.2. Examples 
    131   19. Handler: Directory Listing 
    132      19.1. Parameters 
    133      19.2. Examples 
    134   20. Handler: FastCGI 
    135      20.1. Parameters 
    136      20.2. Examples 
    137      20.3. Configuring PHP 
    138      20.4. Note for developers 
    139   21. Handler: File sending 
    140      21.1. Parameters 
    141      21.2. Examples 
    142   22. Handler: Redirections 
    143      22.1. Parameters 
    144      22.2. Examples 
    145   23. Handler: SCGI 
    146   24. Balancer: Round Robin 
    147   25. Enconder: Gzip 
    148  
    149 Future structure: 
    150 ------------------------ 
    151   To be determined. Navigability strategy must be drafted. 
    152   Each module could have a screenshot. 
    153   The proposed structure reuses the points of the previous documents shown  
    154   between brackets, and between '<>' the documentation tasks proposed above.  
    155  
    156   Refer to TOC.txt to see it. 

  • cherokee/trunk/doc/basics_requirements.txt

    r1718 r1752  
    1515 
    1616Software 
    17 ~~~~~~~~  
     17~~~~~~~~ 
    1818Cherokee has no dependencies besides a standard libc. Everything else 
    1919is optional. Obviously anything beyond mere static content serving 
    2020must be available for Cherokee to correctly execute the task. This 
    2121means you will need PHP if you want Cherokee to serve PHP dynamic 
    22 content, MySQL or LDAP if you set up theses as authentication 
    23 mechanisms for protected content and so on. 
     22content, MySQL or LDAP development libraries if you want built-in 
     23support for these as authentication mechanisms for protected content 
     24and so on. 
     25 
    2426 
    2527If you intend to build Cherokee from source however, you will need 
    …… 
    3335 
    3436* Python: Cherokee has an administrative web interface written in 
    35   Python, so if you intend to use cherokee-admin you will need this.  
     37  Python, so if you intend to use cherokee-admin you will need this. 
    3638  For disk space constrained environments this won't be an issue 
    3739  since you would probably want to make a minimal install in your 
    …… 
    5052* If you want to make a build that serves secure content, you will 
    5153  need TLS libraries. Cherokee supports two different SSL/TLS 
    52   libraries: OpenSSL and GNUTLS. You need to have one of those 
    53   libraries with its development files. 
    54  
     54  libraries: OpenSSL and GNUTLS. You need to have the development 
     55  files of one of these in order to build a package that suits your 
     56  needs. 

  • cherokee/trunk/doc/config_quickstart.txt

    r1744 r1752  
    22------------------------ 
    33 
     4This section briefly describes the whole administration web interface 
     5provided by link:bundle_cherokee-admin.html[cherokee-admin]. This is 
     6the only recommended way of configuring Cherokee. If you are looking 
     7for development information, you should refer to the apropriate 
     8section, especially link:dev_cherokee.conf.html[cherokee.conf] file 
     9specification. 
    410 
    5 General configuration 
    6 ~~~~~~~~~~~~~~~~~~~~~ 
     11We will first show a quick overview of the available options, followed 
     12by a simple walkthrough. You can learn more about the options in their 
     13specific documentation entries. 
    714 
    8 There are a number a link:general.html[general configuration] entries that specify the 
    9 most significant configuration options such as the port - or ports - 
    10 that the server will listen to, the default timeout, whether to 
    11 support keep-alive connections and so on. 
     15Overview 
     16~~~~~~~~ 
     17* link:config_general.html[General]:: 
     18  There are a number of entries that specify the most significant 
     19  configuration options such as the port - or ports - that the server 
     20  will listen to, the default timeout, whether to support keep-alive 
     21  connections and so on. 
    1222 
    13 Virtual Servers 
    14 ~~~~~~~~~~~~~~~ 
     23* link:config_virtual_servers.html[Virtual servers]:: 
     24  If you want your web server to work with more than one domain you 
     25  will have to create link:config_virtual_servers.html[Virtual 
     26  servers] other than the `default` one. Each one will have a 
     27  completely independent configuration: paths, behavior, logging 
     28  facilities, etc. 
    1529 
    16 If you want your web server to work with more than one link:vserver.html[virtual server]  
    17 you will have just to create them. Each more will have a 
    18 complete independent configuration: paths, behavior, logging 
    19 facilities, etc. 
     30* link:config_encoding.html[Encoding]:: 
     31  The encoders allow to transform whatever information the server is 
     32  sending as a response of a request, no matter what handler is 
     33  generating it. 
    2034 
    21 Encoders 
    22 ~~~~~~~~ 
     35* link:config_icons.html[Icons]:: 
     36  Associate icon images with one or more file extensions. Used to 
     37  offer directory listings. 
    2338 
    24 The encoders allow to transform whatever information the server  
    25 is sending as a response of a request, no matter what handler  
    26 is generating it.  
     39* link:config_mime_types.html[Mime Types]:: 
     40  Manage MIME types. 
    2741 
    28     - link:modules_encoders_gzip.html[gzip] - GZip compression 
    29      
    30       Encodes the output with GZip 
     42* link:config_advanced.html[Advanced]:: 
     43  This is to configure the most complex parameters of the server and how 
     44  it interacts with the operating system. If you are unsure about any of 
     45  the options here, better not mingle with them. Default values should 
     46  work just fine. 
    3147 
    32 Icons 
    33 ~~~~~ 
    34  
    35 The link:config_icons.html[Icons] configuration associates an icon 
    36 image with one or more file extensions. This information will be used 
    37 mainly by the link:modules_handlers_dirlist.html[dirlist] handler. 
    38  
    39  
    40 Advanced topics 
    41 ~~~~~~~~~~~~~~~ 
    42  
    43 There is an link:advanced.html[advanced section] that allows to 
    44 configure the most complex parameters of the server and how it works 
    45 with the operating system. 
    46  
    47 If you are unsure about any of the options presented within the 
    48 advanced section, we recommend you to not change it and use the 
    49 default value. 
    50  
    51  
    52 Other advanced topics 
    53 ~~~~~~~~~~~~~~~~~~~~~ 
    54  
    55     - link:debug.html[Debugging] Cherokee 
    56     - How to link:cross_compile_cherokee.html[cross compile Cherokee] (Win32 from Linux or OS X) 
    57     - How to link:generating_ssl_keys.html[generate SSL keys] 
    58     - link:cherokee_tweak.html[Cherokee Tweak]: command-line interface for administrative tasks. 
    59  
    60 Internal configuration system 
    61 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
    62  
    63 The administration interface is highly recommended, and is in fact the 
    64 only administration mechanism that should be used to configure 
    65 Cherokee. However, there is another way in which Cherokee developers 
    66 and very advance users can modify the configuration. 
    67  
    68 The link:internal_configuration.html[internal configuration system] text file format is documented so 
     48Walkthrough 
     49~~~~~~~~~~~ 

  • cherokee/trunk/doc/config_virtual_servers_rule.txt

    r1744 r1752  
    7676validaton mechanism. The following `validators` are available: 
    7777 
    78     - link:modules_validators_htdigest.html[htdigest] - **Htdigest** 
     78    - link:modules_validators_plain.html[plain] - **Plain text file** 
     79 
     80      Uses a plain flat file to perform HTTP authentication. 
     81 
     82    - link:modules_validators_htpasswd.html[htpasswd] - **Htpasswd file** 
     83 
     84      Uses an htpasswd file to perform HTTP authentication. 
     85 
     86    - link:modules_validators_htdigest.html[htdigest] - **Htdigest file** 
    7987 
    8088      Uses an htdigest-generated file to perform HTTP authentication. 
    8189 
    82     - link:modules_validators_htpasswd.html[htpasswd] - **Htpasswd** 
    83  
    84       Uses an htpasswd file to perform HTTP authentication. 
    85  
    86     - link:modules_validators_ldap.html[ldap] - **LDAP Authentication** 
     90    - link:modules_validators_ldap.html[ldap] - **LDAP server** 
    8791 
    8892      Uses an LDAP directory to perform HTTP authentication. 
    8993 
    90     - link:modules_validators_mysql.html[mysql] - **MySQL Authentication** 
     94    - link:modules_validators_mysql.html[mysql] - **MySQL server** 
    9195 
    9296      Uses a MySQL database to perform HTTP authentication. 
    …… 
    9599 
    96100      Uses PAM to perform HTTP authentication. 
    97  
    98     - link:modules_validators_plain.html[plain] - **Plain Flat File Authentication** 
    99  
    100       Uses a plain flat file to perform HTTP authentication. 
    101101 
    102102