Changeset 736

Show
Ignore:
Timestamp:
05/02/07 23:13:36 (1 year ago)
Author:
brian
Message:

finished the compiling and installing doc. this is used to test the output of documentation on the site.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • cherokee-www/trunk/docs/en_US/compiling_and_installing.md

    r734 r736  
    99The following requirements exist for building Cherokee: 
    1010 
    11 - **Building tools**: Cherokee is built on the top of the autoconf and automake tools, hence your systems has to have some basic system programs like a sh shell, make and a ANSI C compiler. We have compiled Cherokee in various platforms with different compilers, so it shouldn't be a problem. 
     11- __Building tools__: Cherokee is built on the top of the autoconf and automake tools, hence your systems has to have some basic system programs like a sh shell, make and a ANSI C compiler. We have compiled Cherokee in various platforms with different compilers, so it shouldn't be a problem. 
    1212 
    13 - **Optional** 
     13- __Optional__ 
    1414 - Python: Cherokee includes a number of Quality Assurances tests written in Python language. If you are planning to contribute code into the project, or you just want to test everything is working in the server, you will need a Python interpreter installed on your system. 
    15  - TLS libraries: Cherokee support two different SSL/TLS libraries: OpenSSL and GNUTLS. If you want to compile Cherokee with secure connections support, you need to have one of that libraries with its development files. 
     15 - TLS libraries: Cherokee support two different SSL/TLS libraries: [OpenSSL](http://www.openssl.org/) and [GNUTLS](http://www.gnu.org/software/gnutls/). If you want to compile Cherokee with secure connections support, you need to have one of that libraries with its development files. 
    1616 
    1717Download 
    1818-------- 
    1919 
    20 Cherokee can be downloaded from the Cherokee Web Server download site or any of its mirrors. Some users of Cherokee on unix-like systems will be better off downloading and compiling a source version. The build process (described below) is easy, and it allows you to customize your server to suit your needs. Anyway, we provide binary packages for some operating systems and GNU/Linux distributions: Cherokee binary packages
     20Cherokee can be downloaded from the [Cherokee Web Server download site](http://www.cherokee-project.com/downloads) or any of its mirrors. Some users of Cherokee on unix-like systems will be better off downloading and compiling a source version. The build process (described below) is easy, and it allows you to customize your server to suit your needs. Anyway, we provide binary packages for some operating systems and GNU/Linux distributions: [Cherokee binary packages](http://www.cherokee-project.com/downloads)
    2121 
    2222If you know the URL of the cherokee sources that you would like to download, for example, cherokee-x.y.z.tar.gz, you can just use the follow command: 
    2323 
    24     wget http://www.cherokee-project.com/download 
     24    wget http://www.cherokee-project.com/download/x.y/x.y.z/cherokee-x.y.z.tar.gz -O - | gzip -dc - | tar xfv - 
     25 
     26Secure connections: TLS / SSL 
     27----------------------------- 
     28 
     29In order to activate the secure connections support you has to ensure you have one of GNUTLS or OpenSSL libraries installed on your system. The configuration script will detect if there is a suitable installation of that libraries. If it finds one of them, it will compile the server with SSL/TLS support. Anyway you can specify who do you want to compile the it: 
     30 
     31To disable the the SSL/TLS support just add the follow parameter to configure: 
     32 
     33    --disable-tls 
     34 
     35To force to compile using the GNU TLS library: 
     36 
     37    --enable-tls=gnutls 
     38 
     39To force to compile using the OpenSSL: 
     40 
     41    --enable-tls=openssl 
     42 
     43IPv6 support 
     44------------ 
     45 
     46Cherokee supports IPv6. If your building system supports it, the server will be built with this feature enabled. If it isn't supported or enabled on your system, the binary simply won't be able to work with a IPv6 stack. If Cherokee is compiled with IPv6 support it will work with both stacks: IPv4 and IPv6 at same time. Anyway there is a configuration option that will allow you to disable the IPv6 support on run time. 
     47 
     48To disable the IPv6 support: 
     49 
     50    --disable-ipv6 
     51 
     52Compilation 
     53----------- 
     54 
     55There are a few very important configure parameters: prefix, sysconfdir and with-wwwroot. Usually it is a good idea to use these three parameters. A very common configure script call is: 
     56 
     57    ./configure --prefix=/usr --sysconfdir=/etc --with-wwwroot=/var/www 
     58 
     59After this, the sources will be ready to get compiled. This should be enough 
     60 
     61    make 
     62 
     63but you can also add compilation parameters. For example, if you are using gcc and you want to compile the Cherokee with debug information just execute make like this 
     64 
     65    make CFLAGS="-O0 -g" 
     66 
     67Installation 
     68------------ 
     69 
     70Oposite to other programs, it is mandatory to install Cherokee. It uses libraries and extension modules that will not work if you try to execute it from the installation directory. In order to install everything, just execute 
     71 
     72    make install 
     73 
     74If you are making a system wide installation you will need to become root first. 
     75 
     76If you wish auto start cherokee at boot (through init's runlevel) you can find a start/stop script into the contrib source directory: 
     77 
     78    cp contrib/cherokee /etc/init.d/ 
     79 
     80additionaly you need to create symlinks at the correct runlevels rc directories, this can can be done by many ways and distributions offer its own tools to do it.