Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 192 lines (121 sloc) 5.297 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
1a14085 @Borkason Hyperlink formatting
Borkason authored
7 Visit our main website for the latest updates: www.cherokee-project.com_.
8
9 .. _www.cherokee-project.com: http://www.cherokee-project.com
1827c9d @davidjb Updating and restructuring readme's content and to use RST
davidjb authored
10
11 Compiling from source
12 ---------------------
13
14 Building from the repository
15 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
16
17 To build from the repository, you will require ``autoconf``, ``automake``, and
18 ``libtool`` tools to be available, typically available on your distribution
19 either by default or by running the following on Debian-based systems::
20
21 sudo apt-get install autoconf automake libtool
22
23 or, for Yum-based systems, such as RedHat, CentOS or Fedora::
24
25 sudo yum install autoconf automake libtool
26
e766cdf @kallisti5 Readme: Add info on pacman packages
kallisti5 authored
27 or, for Pacman-based systems such as ArchLinux::
28
29 sudo pacman -Sy autoconf automake libtool
30
cd10017 @Borkason Updated GIT instructions
Borkason authored
31 To check out the code from GitHub, do the following::
1827c9d @davidjb Updating and restructuring readme's content and to use RST
davidjb authored
32
33 git clone http://github.com/cherokee/webserver.git
34
35 Once cloned, ``cd`` into the resulting source directory and run
800659d @davidjb Updating details about autogen.sh
davidjb authored
36 ``./autogen.sh`` to set up the environment and generate ``./configure``::
1827c9d @davidjb Updating and restructuring readme's content and to use RST
davidjb authored
37
38 cd webserver
39 ./autogen.sh [options]
40 make
41 make install
42
800659d @davidjb Updating details about autogen.sh
davidjb authored
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
1827c9d @davidjb Updating and restructuring readme's content and to use RST
davidjb authored
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
8fe4315 @davidjb Updating mailing list url and fix formatting
davidjb authored
97 http://lists.cherokee-project.com/listinfo/cherokee
1827c9d @davidjb Updating and restructuring readme's content and to use RST
davidjb authored
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
8fe4315 @davidjb Updating mailing list url and fix formatting
davidjb authored
104
1827c9d @davidjb Updating and restructuring readme's content and to use RST
davidjb authored
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 How to build a MacOS X binary package
157 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
158
159 ::
160
161 ./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
162 make -j8
163 packages/osx/build.py
164
165 Development
166 ^^^^^^^^^^^
167
168 ::
169
170 ./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
d784213 @skinkie Adds support for Automake's "Silent Building" mechanism.
skinkie authored
171 make V=1 CFLAGS="-ggdb3 -O0" -j8
1827c9d @davidjb Updating and restructuring readme's content and to use RST
davidjb authored
172
173 How to create a self signed certificate for TLS
174 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
175
176 ::
177
178 openssl req -days 1000 -new -x509 -nodes -out /etc/cherokee/ssl/cherokee.pem -keyout /etc/cherokee/ssl/cherokee.pem
179
44a49e1 @davidjb Adding FAQ to readme about how to produce a .tar.gz distribution
davidjb authored
180 How to create a release .tar.gz
181 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
182
183 ::
492b65a @davidjb Minor formatting fix
davidjb authored
184
cd10017 @Borkason Updated GIT instructions
Borkason authored
185 git clone http://github.com/cherokee/webserver.git
44a49e1 @davidjb Adding FAQ to readme about how to produce a .tar.gz distribution
davidjb authored
186 cd webserver
187 ./autogen.sh
188 make dist-gzip
189
190 The resulting file will be created in the current directory and will be
191 a ``.tar.gz`` archive.
Something went wrong with that request. Please try again.