Skip to content
This repository
Browse code

Merge pull request #25 from davidjb/master

Update readme, structure and formatting by davidjb. Thank you very much for this effort!
  • Loading branch information...
commit 5a3960c99bf2b0e43ce8115f81ecf5e78b1a10fd 2 parents 972a891 + 92f31be
Stefan de Konink authored August 06, 2012
113  README
... ...
@@ -1,113 +0,0 @@
1  
-Cherokee Web Server
2  
-===================
3  
-
4  
-Web site
5  
---------
6  
-  http://www.cherokee-project.com/
7  
-
8  
-
9  
-License
10  
--------
11  
-  Cherokee is released under GPL v2. Read the COPYING file for more
12  
-  information.
13  
-
14  
-
15  
-Mailing lists
16  
--------------
17  
-  There are a few mailing lists available. Please, do not hesitate to
18  
-  subscribe to any on them:
19  
-
20  
-    http://lists.cherokee-project.com/
21  
-
22  
-  This is the main mailing list, where questions are sent and general
23  
-  discussion takes place.
24  
-
25  
-  There are also a few technical mailing lists. Developers and package
26  
-  maintainers usually subscribe to these mailing lists as well:
27  
-
28  
-    http://lists.cherokee-project.com/listinfo/cherokee-dev
29  
-    http://lists.cherokee-project.com/listinfo/cherokee-commits
30  
-
31  
-  The mailing lists' archives are available at:
32  
-
33  
-    http://lists.cherokee-project.com/pipermail/cherokee/
34  
-
35  
-
36  
-IRC channel
37  
------------
38  
-  irc.freenode.net, channel #cherokee
39  
-
40  
-
41  
-Building from a tar.gz file
42  
----------------------------
43  
-  Run ./configure, with some options if you wish. The standard options
44  
-  are documented in the INSTALL file.  The only interesting ones are
45  
-  the usual --prefix=/usr, --localstatedir=/var and --sysconfdir=/etc
46  
-
47  
-  Do "make", and then do "make install" (possibly as root if the
48  
-  destination permissions require that).
49  
-
50  
-  That's all.
51  
-
52  
-
53  
-Building from the repository
54  
-----------------------------
55  
-  Check out the code from Github, using e.g.
56  
-
57  
-    git clone http://github.com/cherokee/webserver.git
58  
-
59  
-  cd into the source directory and run ./autogen.sh to setup the
60  
-  environment (you need the standard autoconf tools to do so).
61  
-
62  
-  Then, continue with the following instructions...
63  
-
64  
-
65  
-FAQ
66  
----
67  
-   Here is a list of the most frequently asked questions:
68  
-
69  
-  How to compile it
70  
-  ------------------
71  
-   ./configure --prefix=/usr --sysconfdir=/etc --localstatedir=/var
72  
-   make
73  
-
74  
-  How to create dynamic modules
75  
-  -----------------------------
76  
-   It's the default way.
77  
-
78  
-  How to configure the module xyz to be linked statically
79  
-  -------------------------------------------------------
80  
-   ./configure --prefix=/usr --sysconfdir=/etc --localstatedir=/var --enable-static-module=xyz
81  
-
82  
-  How to build everyhing statically
83  
-  ---------------------------------
84  
-   ./configure --prefix=/usr --sysconfdir=/etc --localstatedir=/var --enable-static-module=all
85  
-
86  
-  How to create a self signed certificate for TLS
87  
-  -----------------------------------------------
88  
-    openssl req -days 1000 -new -x509 -nodes -out /etc/cherokee/ssl/cherokee.pem -keyout /etc/cherokee/ssl/cherokee.pem
89  
-
90  
-  How to compile it on Windows
91  
-  ----------------------------
92  
-   ./configure --prefix=/usr --sysconfdir=/etc --localstatedir=/var --enable-static-module=all --enable-static --enable-shared=no --enable-beta --enable-trace
93  
-
94  
-  How to build a MacOS X binary package
95  
-  -----------------------------------
96  
-   ./autogen.sh --prefix=/usr/local --with-wwwroot=/Library/WebServer/Documents --with-wwwuser=www --with-wwwgroup=www --with-mysql=no --with-ffmpeg=no --with-ldap=no --enable-beta
97  
-   make -j8
98  
-   packages/osx/build.py
99  
-
100  
-  Development
101  
-  -----------
102  
-   ./autogen.sh --prefix=/usr --sysconfdir=/etc --localstatedir=/var --enable-static-module=all --enable-static --enable-shared=no --with-mysql=no --with-ffmpeg=no --with-ldap=no --enable-beta --enable-trace --enable-backtraces --enable-maintainer-mode
103  
-   make CFLAGS="-ggdb3 -O0" -j8
104  
-
105  
-  How to cross compile the Win32 version
106  
-  --------------------------------------
107  
-   From Linux: http://alobbs.com/news/1201
108  
-   From MacOS: http://alobbs.com/news/1299
109  
-   From Win32: http://unixwars.com/2008/07/17/c/
110  
-
111  
---
112  
-Alvaro Lopez Ortega
113  
-alvaro@alobbs.com
194  README.rst
Source Rendered
... ...
@@ -0,0 +1,194 @@
  1
+Cherokee Web Server
  2
+===================
  3
+
  4
+Web site
  5
+--------
  6
+
  7
+Visit our main website for the latest updates: http://www.cherokee-project.com/
  8
+
  9
+Compiling from source
  10
+---------------------
  11
+
  12
+Building from the repository
  13
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  14
+
  15
+To build from the repository, you will require ``autoconf``, ``automake``, and
  16
+``libtool`` tools to be available, typically available on your distribution
  17
+either by default or by running the following on Debian-based systems::
  18
+
  19
+    sudo apt-get install autoconf automake libtool
  20
+
  21
+or, for Yum-based systems, such as RedHat, CentOS or Fedora::
  22
+
  23
+    sudo yum install autoconf automake libtool
  24
+
  25
+To check out the code from GitHub, including all dependencies that are
  26
+specified as Git submodules, do the following::
  27
+
  28
+    git clone --recursive http://github.com/cherokee/webserver.git
  29
+
  30
+or, if using a version of Git < 1.6.5, run::
  31
+
  32
+    git clone http://github.com/cherokee/webserver.git
  33
+    git submodule update --init
  34
+
  35
+Once cloned, ``cd`` into the resulting source directory and run 
  36
+``./autogen.sh`` to set up the environment and generate ``./configure``::
  37
+
  38
+    cd webserver
  39
+    ./autogen.sh [options]
  40
+    make
  41
+    make install
  42
+
  43
+``./autogen.sh`` will accept any optional parameters otherwise typically passed
  44
+to ``./configure``; in doing so you can avoid needing to run ``./configure``
  45
+separately.
  46
+
  47
+Several examples of using ``./autogen.sh`` follow shortly in the
  48
+`Frequently Asked Questions (FAQ)`_ section.
  49
+
  50
+Building from a tar.gz file
  51
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
  52
+
  53
+After downloading (likely from http://www.cherokee-project.com/downloads.html)
  54
+and extracting, you should run ``./configure``, with options as appropriate.
  55
+The standard options are documented in the ``INSTALL`` file.  Typically,
  56
+the most interesting options are:
  57
+
  58
+* the usual ``--prefix=/usr``
  59
+* ``--localstatedir=/var``
  60
+* ``--sysconfdir=/etc``
  61
+
  62
+After running ``./configure``, issues the ``make`` command, and then ``make
  63
+install`` (excuting this last command as root if the destination permissions
  64
+require that).
  65
+
  66
+Tying this all together will result in commands like the following::
  67
+
  68
+    wget http://www.cherokee-project.com/download/trunk/cherokee-latest-snapshot.tar.gz
  69
+    tar xf cherokee-latest-snapshot.tar.gz
  70
+    cd cherokee-latest-snapshot
  71
+    ./configure --prefix=/usr --sysconfdir=/etc --localstatedir=/var
  72
+    make
  73
+    sudo make install
  74
+
  75
+The exact options passed to ``./configure`` can vary based upon your
  76
+configuration.
  77
+
  78
+
  79
+License
  80
+-------
  81
+
  82
+Cherokee is released under GPL v2. Read the ``COPYING`` file for more
  83
+information.
  84
+
  85
+
  86
+Mailing lists
  87
+-------------
  88
+
  89
+There are several mailing lists available for Cherokee and they are listed
  90
+at: 
  91
+
  92
+    http://lists.cherokee-project.com/
  93
+
  94
+The main mailing list, where questions should be sent and general
  95
+discussion takes place, is:
  96
+
  97
+    http://lists.cherokee-project.com/listinfo/cherokee
  98
+
  99
+There are also a few technical mailing lists. Developers and package
  100
+maintainers should subscribe to these mailing lists as well as the main mailing
  101
+list:
  102
+
  103
+    http://lists.cherokee-project.com/listinfo/cherokee-dev
  104
+
  105
+    http://lists.cherokee-project.com/listinfo/cherokee-commits
  106
+
  107
+The mailing lists' archives are available at:
  108
+
  109
+    http://lists.cherokee-project.com/pipermail/cherokee/
  110
+
  111
+Don't hesitate to subscribe and contribute to any of the mailing lists!
  112
+
  113
+
  114
+IRC channel
  115
+-----------
  116
+
  117
+Communicate with the Cherokee community via `IRC
  118
+<irc://irc.freenode.net/#cherokee>`_:
  119
+
  120
+    irc.freenode.net, channel #cherokee
  121
+
  122
+
  123
+Frequently Asked Questions (FAQ)
  124
+--------------------------------
  125
+
  126
+Here is a list of the most frequently asked questions regarding
  127
+compilation and similar topics:
  128
+
  129
+How to compile it
  130
+^^^^^^^^^^^^^^^^^
  131
+
  132
+::
  133
+
  134
+   ./configure --prefix=/usr --sysconfdir=/etc --localstatedir=/var
  135
+   make
  136
+
  137
+How to create dynamic modules
  138
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  139
+
  140
+Modules are created dynamically by default.
  141
+
  142
+How to configure the module xyz to be linked statically
  143
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  144
+
  145
+::
  146
+
  147
+    ./configure --prefix=/usr --sysconfdir=/etc --localstatedir=/var --enable-static-module=xyz
  148
+
  149
+How to build everyhing statically
  150
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  151
+
  152
+::
  153
+
  154
+    ./configure --prefix=/usr --sysconfdir=/etc --localstatedir=/var --enable-static-module=all
  155
+
  156
+
  157
+How to compile it on Windows
  158
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  159
+
  160
+::
  161
+
  162
+    ./configure --prefix=/usr --sysconfdir=/etc --localstatedir=/var --enable-static-module=all --enable-static --enable-shared=no --enable-beta --enable-trace
  163
+
  164
+How to build a MacOS X binary package
  165
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  166
+
  167
+::
  168
+
  169
+    ./autogen.sh --prefix=/usr/local --with-wwwroot=/Library/WebServer/Documents --with-wwwuser=www --with-wwwgroup=www --with-mysql=no --with-ffmpeg=no --with-ldap=no --enable-beta
  170
+    make -j8
  171
+    packages/osx/build.py
  172
+
  173
+Development
  174
+^^^^^^^^^^^
  175
+
  176
+::
  177
+
  178
+    ./autogen.sh --prefix=/usr --sysconfdir=/etc --localstatedir=/var --enable-static-module=all --enable-static --enable-shared=no --with-mysql=no --with-ffmpeg=no --with-ldap=no --enable-beta --enable-trace --enable-backtraces --enable-maintainer-mode
  179
+    make CFLAGS="-ggdb3 -O0" -j8
  180
+
  181
+How to cross compile the Win32 version
  182
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  183
+
  184
+* From Linux: http://alobbs.com/news/1201
  185
+* From MacOS: http://alobbs.com/news/1299
  186
+* From Win32: http://unixwars.com/2008/07/17/c/
  187
+
  188
+How to create a self signed certificate for TLS
  189
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  190
+
  191
+::
  192
+
  193
+    openssl req -days 1000 -new -x509 -nodes -out /etc/cherokee/ssl/cherokee.pem -keyout /etc/cherokee/ssl/cherokee.pem
  194
+
14  doc/basics_download.txt
@@ -32,13 +32,23 @@ Finally, if you are a developer or simply want to test out the bleeding edge
32 32
 version, you can access our Git repository. Be advised, this is the
33 33
 development branch, so use it at your own risk!
34 34
 
35  
-To download simply use:
  35
+To take a copy of our source code repository, simply use:
  36
+
  37
+---------------------------------------------------------------------------
  38
+git clone --recursive https://github.com/cherokee/webserver.git
  39
+---------------------------------------------------------------------------
  40
+
  41
+This will also retrieve the relevant Git submodules we use for this project.
  42
+If you are using a version of Git that is earlier than version 1.6.5, then
  43
+you will need to use the following commands:
36 44
 
37 45
 ---------------------------------------------------------------------------
38 46
 git clone https://github.com/cherokee/webserver.git
  47
+cd webserver
  48
+git submodule update --init
39 49
 ---------------------------------------------------------------------------
40 50
 
41  
-You can also download a package with the latest GIT contents:
  51
+You can also download a package with the latest contents of the Git repository:
42 52
 
43 53
 ---------------------------------------------------------------------------
44 54
 wget https://github.com/cherokee/webserver/zipball/dev
54  doc/basics_installation_git.txt
... ...
@@ -1,6 +1,6 @@
1 1
 == link:index.html[Index] -> link:basics.html[Getting started] -> link:basics_installation.html[Installation]
2 2
 
3  
-Installation from Github
  3
+Installation from GitHub
4 4
 ------------------------
5 5
 
6 6
 The latest, bleeding edge Cherokee release can always be retrieved via
@@ -11,27 +11,54 @@ production environments.
11 11
 Briefly, Git is a system tool used to store and maintain files and a
12 12
 history of their changes over time, and it is an invaluable development
13 13
 tool. The Cherokee source code and related files are kept in a Git repository
14  
-at github.com/cherokee/webserver.git.
  14
+on link:https://github.com/cherokee/webserver[GitHub].
  15
+
  16
+You can read more about Git at link:http://git-scm.com/[git-scm.com].
15 17
 
16 18
 To download the Git repository you will need a special piece of
17  
-software called a Git client.
  19
+software called a Git client. On a Linux-based system, the official 
  20
+command-line client, simply named ``git``, can typically be installed
  21
+from repositories.  For instance, on an Ubuntu or Debian-based system
  22
+install using:
  23
+
  24
+----
  25
+sudo apt-get install git
  26
+----
  27
+
  28
+or on a Yum-based system, such as Fedora, RHEL or CentOS install using:
  29
+
  30
+----
  31
+sudo yum install git-core
  32
+----
18 33
 
19 34
 
20 35
 [[clone]]
21 36
 Cloning the sources
22  
-~~~~~~~~~~~~~~~~~~~~~~~~
  37
+~~~~~~~~~~~~~~~~~~~
  38
+
  39
+To take a copy of the sources for the first time from the repository, use this
  40
+command:
  41
+
  42
+----
  43
+git clone --recursive git://github.com/cherokee/webserver cherokee
  44
+----
23 45
 
24  
-To check out the sources for the first time from the repository, use this command:
  46
+If you are on a system with a version of Git earlier than 1.6.5, then you
  47
+will also need to manually update the Git submodules for this repository:
25 48
 
26 49
 ----
27 50
 git clone git://github.com/cherokee/webserver cherokee
  51
+cd cherokee
  52
+git submodule update --init
28 53
 ----
  54
+ 
29 55
 
30 56
 [[update]]
31 57
 Updating the sources
32 58
 ~~~~~~~~~~~~~~~~~~~~
33 59
 
34  
-To update your sources every day, you use this command:
  60
+To update the source with latest changes, you use this command within your
  61
+local repository:
35 62
 
36 63
 ----
37 64
 git pull -u
@@ -42,14 +69,15 @@ git pull -u
42 69
 Compiling and installing
43 70
 ~~~~~~~~~~~~~~~~~~~~~~~~
44 71
 
45  
-Once you have downloaded the latest GIT head, you will need to
  72
+Once you have downloaded the latest source from Git, you will need to
46 73
 follow the installation instructions for your specific platform.
47 74
 
48  
-Note that some of the files present in the tarball are not present in
49  
-GIT. Most noticeably, the file `./configure` that will be needed for the
50  
-installation process.
  75
+Note that some of the files present in a release tarball are not present in
  76
+Git - the most notable of which is the `./configure` file that will be needed
  77
+for the compilation and installation process.
51 78
 
52  
-To generate the missing files simply run this command:
  79
+To generate the missing files simply run this command within your local
  80
+repository:
53 81
 
54 82
 ----
55 83
 ./autogen.sh
@@ -67,8 +95,8 @@ specified parameters:
67 95
              --localstatedir=/var --enable-trace
68 96
 ----
69 97
 
70  
-You would then be ready to proceed with the standard compilation
71  
-process for your platform:
  98
+Once you have done this, you are now ready to proceed with the standard
  99
+compilation process for your platform:
72 100
 
73 101
 * link:basics_installation_unix.html[Unix installation]
74 102
 * link:basics_installation_windows.html[Windows installation]
5  doc/cookbook_cross_compilation.txt
@@ -39,10 +39,9 @@ RC=i586-mingw32msvc-windres
39 39
 Check out the last development version of Cherokee:
40 40
 
41 41
 ----
42  
-$ git clone git://github.com/cherokee/webserver.git cherokee
  42
+$ git clone --recursive git://github.com/cherokee/webserver.git cherokee
43 43
 $ cd cherokee
44  
-$ git submodule init
45  
-$ git submodule update
  44
+$ git submodule update --init #Not needed on Git >= 1.6.5
46 45
 ----
47 46
 
48 47
 and execute a quite long "configure" command:
5  doc/dev_quickstart.txt
@@ -18,10 +18,9 @@ In principle, provided you have the required tools in your system, it
18 18
 should be as easy as:
19 19
 
20 20
 ----
21  
-    git clone git://github.com/cherokee/webserver.git ~/cherokee
  21
+    git clone --recursive git://github.com/cherokee/webserver.git ~/cherokee
22 22
     cd ~/cherokee_dev
23  
-    git submodule init
24  
-    git submodule update
  23
+    git submodule update --init #not needed on Git >= 1.6.5
25 24
     ./autogen.sh --enable-beta --enable-trace
26 25
     make
27 26
 ----

0 notes on commit 5a3960c

Please sign in to comment.
Something went wrong with that request. Please try again.