Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 192 lines (120 sloc) 5.353 kB
1827c9d @davidjb Updating and restructuring readme's content and to use RST
davidjb authored
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 and so forth)::
38
39 cd webserver
40 ./autogen.sh [options]
41 make
42 make install
43
44 Several examples of using ``./autogen.sh`` follow shortly in the
45 `Frequently Asked Questions (FAQ)`_ section.
46
47 Building from a tar.gz file
48 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
49
50 After downloading (likely from http://www.cherokee-project.com/downloads.html)
51 and extracting, you should run ``./configure``, with options as appropriate.
52 The standard options are documented in the ``INSTALL`` file. Typically,
53 the most interesting options are:
54
55 * the usual ``--prefix=/usr``
56 * ``--localstatedir=/var``
57 * ``--sysconfdir=/etc``
58
59 After running ``./configure``, issues the ``make`` command, and then ``make
60 install`` (excuting this last command as root if the destination permissions
61 require that).
62
63 Tying this all together will result in commands like the following::
64
65 wget http://www.cherokee-project.com/download/trunk/cherokee-latest-snapshot.tar.gz
66 tar xf cherokee-latest-snapshot.tar.gz
67 cd cherokee-latest-snapshot
68 ./configure --prefix=/usr --sysconfdir=/etc --localstatedir=/var
69 make
70 sudo make install
71
72 The exact options passed to ``./configure`` can vary based upon your
73 configuration.
74
75
76 License
77 -------
78
79 Cherokee is released under GPL v2. Read the ``COPYING`` file for more
80 information.
81
82
83 Mailing lists
84 -------------
85
86 There are several mailing lists available for Cherokee and they are listed
87 at:
88
89 http://lists.cherokee-project.com/
90
91 The main mailing list, where questions should be sent and general
92 discussion takes place, is:
93
8fe4315 @davidjb Updating mailing list url and fix formatting
davidjb authored
94 http://lists.cherokee-project.com/listinfo/cherokee
1827c9d @davidjb Updating and restructuring readme's content and to use RST
davidjb authored
95
96 There are also a few technical mailing lists. Developers and package
97 maintainers should subscribe to these mailing lists as well as the main mailing
98 list:
99
100 http://lists.cherokee-project.com/listinfo/cherokee-dev
8fe4315 @davidjb Updating mailing list url and fix formatting
davidjb authored
101
1827c9d @davidjb Updating and restructuring readme's content and to use RST
davidjb authored
102 http://lists.cherokee-project.com/listinfo/cherokee-commits
103
104 The mailing lists' archives are available at:
105
106 http://lists.cherokee-project.com/pipermail/cherokee/
107
108 Don't hesitate to subscribe and contribute to any of the mailing lists!
109
110
111 IRC channel
112 -----------
113
114 Communicate with the Cherokee community via `IRC
115 <irc://irc.freenode.net/#cherokee>`_:
116
117 irc.freenode.net, channel #cherokee
118
119
120 Frequently Asked Questions (FAQ)
121 --------------------------------
122
123 Here is a list of the most frequently asked questions regarding
124 compilation and similar topics:
125
126 How to compile it
127 ^^^^^^^^^^^^^^^^^
128
129 ::
130
131 ./configure --prefix=/usr --sysconfdir=/etc --localstatedir=/var
132 make
133
134 How to create dynamic modules
135 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
136
137 Modules are created dynamically by default.
138
139 How to configure the module xyz to be linked statically
140 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
141
142 ::
143
144 ./configure --prefix=/usr --sysconfdir=/etc --localstatedir=/var --enable-static-module=xyz
145
146 How to build everyhing statically
147 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
148
149 ::
150
151 ./configure --prefix=/usr --sysconfdir=/etc --localstatedir=/var --enable-static-module=all
152
153
154 How to compile it on Windows
155 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
156
157 ::
158
159 ./configure --prefix=/usr --sysconfdir=/etc --localstatedir=/var --enable-static-module=all --enable-static --enable-shared=no --enable-beta --enable-trace
160
161 How to build a MacOS X binary package
162 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
163
164 ::
165
166 ./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
167 make -j8
168 packages/osx/build.py
169
170 Development
171 ^^^^^^^^^^^
172
173 ::
174
175 ./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
176 make CFLAGS="-ggdb3 -O0" -j8
177
178 How to cross compile the Win32 version
179 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
180
181 From Linux: http://alobbs.com/news/1201
182 From MacOS: http://alobbs.com/news/1299
183 From Win32: http://unixwars.com/2008/07/17/c/
184
185 How to create a self signed certificate for TLS
186 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
187
188 ::
189
190 openssl req -days 1000 -new -x509 -nodes -out /etc/cherokee/ssl/cherokee.pem -keyout /etc/cherokee/ssl/cherokee.pem
191
Something went wrong with that request. Please try again.