Changeset 1701

Show
Ignore:
Timestamp:
07/29/08 17:38:47 (5 months ago)
Author:
taher
Message:

--

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • cherokee/trunk/ChangeLog

    r1698 r1701  
     12008-07-29  Taher Shihadeh <taher@unixwars.com> 
     2        * doc/cherokee_tweak.txt: added some documentation. 
     3         
     42008-07-29  Milo van der Linden <milovanderlinden@gmail.com> 
     5        * doc/admin.txt, doc/compiling_and_installing_unix.txt: some  
     6        documentation patches. 
     7         
    182008-07-28  Taher Shihadeh <taher@unixwars.com> 
    29        * cherokee-tweak.1, cherokee-admin.1, cherokee.1: manpages needed 

  • cherokee/trunk/doc/Makefile.am

    r1651 r1701  
    2323download.html \ 
    2424generating_ssl_keys.html \ 
    25 icons.html 
     25icons.html \ 
     26cherokee_tweak.html 
    2627 
    2728dochandlersdir = $(docdir)/ 
    …… 
    8586media/images/admin_handler_dirlist_ex.png \ 
    8687media/images/admin_handler_onlylisting.png \ 
    87 media/images/admin_handler_onlylisting_ex.png 
     88media/images/admin_handler_onlylisting_ex.png \ 
     89media/images/admin_launch.png 
    8890 
    8991 

  • cherokee/trunk/doc/admin.txt

    r1647 r1701  
    22-------------- 
    33 
    4 This section describes the Cherokee configuration admin interface. It is designed to 
    5 make the configuration of the cherokee web server really easy. 
     4Cherokee comes with a web browser administration interface. From this interface the  
     5webserver can be configured. 
    66 
    7 If cherokee is going to be running in the same host, just use: 
     7image::media/images/admin_launch.png[Cherokee admin interface] 
     8 
     9 
     10If you want to access the administration interface from the same computer that you installed cherokee on 
     11simply start the administration interface by running: 
    812---- 
    9 $ cherokee-admin 
     13cherokee-admin 
    1014---- 
    11 And redirect your internet browser to 127.0.0.1:9090. By default, the interface will 
    12 be listening on port 9090 at 127.0.0.1. There are some advanced options thought: 
     15Then redirect your web browser to 127.0.0.1:9090 this is the default port for the 
     16administration interface.  
    1317 
    14     * *-h*: Show usage 
    15     * *-a*: Listen all interfaces 
    16     * *-C*: Use a different configuration file 
    17     * *-d*: Use a custom admin-interface path 
     18If you want to access the administration interface from another computer, you need to bind the cherokee  
     19administration interface to all network interfaces: 
     20---- 
     21cherokee-admin -b 
     22---- 
     23WARNING: By starting cherokee-admin listening on all interfaces, everyone that can access the computer can 
     24alter your cherokee configuration. Don't use this in a production environment! 
    1825 
    19 Example: 
     26[grid="rows"] 
     27``~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
     28Parameter,             Description 
     29~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
     30`-h`, Show usage 
     31`-b`, Listen all interfaces 
     32`-C`, Use a different configuration file 
     33`-d`, Use a custom admin-interface path 
     34`-P`, Use a different port for the administration interface 
     35~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
     36 
     37.Example: 
     38Make cherokee use a different configuration file, listen on port 9091 and grab 
     39the administration interface application from a different path: 
    2040---- 
    21 $ cherokee-admin -a -P 9091 -C /etc/cherokee/cherokee2.conf \ 
     41cherokee-admin -a -P 9091 -C /etc/cherokee/cherokee2.conf \ 
    2242                 -d /path/to/svn/trunk/cherokee-admin/ 
    2343---- 
    24 image::media/images/admin_launch.png[Cherokee admin interface] 
    2544 
     45 

  • cherokee/trunk/doc/compiling_and_installing_unix.txt

    r1647 r1701  
    22-------------------------------- 
    33 
    4 Dependencies 
    5 ~~~~~~~~~~~ 
     4Required 
     5~~~~~~~~ 
    66 
    77The following requirements exist for building Cherokee: 
    …… 
    1212  platforms with different compilers, so it shouldn't be a problem. 
    1313 
    14 * Optional:  
     14Optional 
     15~~~~~~~~  
    1516 
    1617  * Python: Cherokee includes a number of Quality Assurance tests  
    …… 
    2526    with its development files.  
    2627 
    27 The simplest way 
    28 ~~~~~~~~~~~~~~~~ 
     28Quickstart 
     29~~~~~~~~~~ 
    2930 
    30 First, link:download.html[download] a fresh copy of Cherokee, then run: 
     31. link:download.html[Download] a fresh copy of Cherokee 
     32. Configure the package for your system: 
     33+ 
     34---- 
     35./configure --localstatedir=/var --prefix=/usr --sysconfdir=/etc --with-wwwroot=/var/www 
     36---- 
     37. Compile the package: 
     38+ 
     39---- 
     40make 
     41---- 
     42. Install the programs and any data files: 
     43+ 
     44---- 
     45make install 
     46---- 
     47. Start Cherokee link:admin.html[admin] 
    3148 
    32     - $> **./configure --localstatedir=/var --prefix=/usr --sysconfdir=/etc 
    33       --with-wwwroot=/var/www** To configure the package for your system.    
    34     - $> **make** To compile the package. 
    35     - $> **make install** To install the programs and any data files. 
     49Advanced parameters 
     50~~~~~~~~~~~~~~~~~~~ 
    3651 
    37 Others parameters 
    38 ~~~~~~~~~~~~~~~~~ 
    39  
    40 If you want to learn more about 'configure' you can run *./configure --help* 
     52If you want to learn more about 'configure' you can run `./configure --help` 
    4153 
    4254[grid="rows"] 
    4355``~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
    44 Parameters,             Description 
     56Parameter,             Description 
    4557~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
    46 '--with-wwwroot=DIR',   Specifies the Root directory 
    47 '--disable-epoll',      Disable epoll() support 
    48 '--disable-pthread',    Disable threading support 
    49 '--disable-readdir_r',  Disable readdir_r usage 
    50 '--disable-ipv6',       Disable IPv6 support 
    51 '--disable-pam',        Disable PAM support 
    52 '--disable-tls',        Disable TLS/SSL support 
    53 '--enable-tls=',        gnutls|openssl 
     58`--with-wwwroot=DIR`,   Specify the webserver root directory 
     59`--disable-epoll`,      Disable epoll() support 
     60`--disable-pthread`,    Disable threading support 
     61`--disable-readdir_r`,  Disable readdir_r usage 
     62`--disable-ipv6`,       Disable IPv6 support 
     63`--disable-pam`,        Disable PAM support 
     64`--disable-tls`,        Disable TLS/SSL support 
     65`--enable-tls=`,        gnutls|openssl 
    5466~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
    5567 
    56 Install and config directories 
    57 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
     68Autostart 
     69~~~~~~~~~ 
    5870 
    59 If you need to auto-start cherokee at boot (through init's runlevel) you can  
    60 find a start/stop script in the contrib source directory:: 
     71If you need the cherokee webserver to start at boot (through init's runlevel) you can  
     72find a start/stop script in the contrib source directory: 
    6173 
    6274---- 

  • cherokee/trunk/doc/index.txt

    r1664 r1701  
    7373    - How to link:cross_compile_cherokee.html[cross compile Cherokee] (Win32 from Linux or OS X) 
    7474    - How to link:generating_ssl_keys.html[generate SSL keys] 
     75    - ling:cherokee_tweak.html[Cherokee Tweak]: command-line interface for administrative tasks. 
    7576 
    7677Internal configuration system