Project

General

Profile

HowTo configure Apache to run Redmine » History » Version 20

Anton Kovalenko, 2011-09-22 13:38

1 1 Cyber Sprocket
h1. HowTo configure Apache to run Redmine
2
3 7 Mischa The Evil
{{>toc}}
4 1 Cyber Sprocket
5 2 Cyber Sprocket
These notes assume you already have Redmine running via the webrick server and are looking to get Redmine running via your existing Apache installation.   Most of the commands assume you are in the root installation directory of redmine, so be sure to change directory there before starting.
6 1 Cyber Sprocket
7
h2. For CentOS 5
8
9
h3. Assumptions
10
11
* OS is CentOS 5
12
* Web server is Apache 2
13
** mod_cgi is enabled
14
** name based virtual servers are being used
15 2 Cyber Sprocket
** the web server runs under the user apache, group apache
16 1 Cyber Sprocket
17 4 Cyber Sprocket
h3. Myths
18
19
* You do not need to run mod_fcgid
20
* You do not need to run mod_fastcgi
21 8 William Baum
 
22
bq. -This section needs work. I can't tell if these are the myths or the corrections to the myths.
23
_(note: if someone were so generous to post working, known good, HOWTO steps here for enabling FastCGI, that would be highly valuable to the entire community.- It is reported that www.redmine.org itself runs FastCGI, so it is obviously a valid, worthwhile, stable, performing way to run this great great web app'.)_
24 5 Brad Mace
25 14 Cyber Sprocket
bq. I have added sections detailing the installation and configuration of mod_fastcgi and mod_fcgid below. --wmbaum, (2009-08-30)
26 1 Cyber Sprocket
27 14 Cyber Sprocket
bq. We had problems with getting Rails 2.3.5 working with cgi and fastcgi.  fcgid on Apache2 worked great for 9.3. We tweaked some of the notes based on the recent fcgid updates. -- "cybersprocket":http://www.cybersprocket.com, (2010-04-25)
28
29 1 Cyber Sprocket
h3. Basic Steps
30
31 11 Patrick OMalley
* Install Redmine per the [[RedmineInstall| installation instructions]] and get it running with webrick.
32 1 Cyber Sprocket
33
* Kill the webrick session
34
35
* Copy the public/dispatch.cgi.example to public/dispatch.cgi
36
37 18 Matt Brown
* Edit public/dispatch.cgi to fix the shell script invocation to point to the ruby executable:
38 1 Cyber Sprocket
  @#!/usr/local/bin/ruby@
39 9 Patrick OMalley
  or 
40 1 Cyber Sprocket
  @#!/usr/bin/ruby@
41 18 Matt Brown
  or
42
  @#!c:/ruby_root/bin/ruby.exe@
43 1 Cyber Sprocket
44 10 Patrick OMalley
* Also in public/dispatch.cgi, you may need to change the require line to an absolute path as stated in the comment to something like
45
  @require "/usr/lib/ruby/gems/1.8/gems/rails-2.1.2/lib/dispatcher.rb"@
46 19 Matt Brown
  or
47
  @require "c:/ruby_root/lib/ruby/gems/1.8/gems/rails-2.3.11/lib/dispatcher.rb"@
48 10 Patrick OMalley
49 1 Cyber Sprocket
* Make sure public/dispatch.cgi has execute permissions via:
50
  @# chmod 755 public/dispatch.cgi@
51
52
* Update the config/environment.rb file to force the rails environment to production, simply uncomment this line at the start of the file:
53
  @ENV['RAILS_ENV'] ||= 'production'@
54
55 3 Cyber Sprocket
* Add your virtual host entry to the apache configuration file (/etc/httpd/conf/httpd.conf).  We installed redmine into the /live/redmine folder on our server. _Note: be sure to point your DocumentRoot to the public sub-folder!_
56
57 1 Cyber Sprocket
<pre>
58
    <VirtualHost *:80>
59
        ServerName redmine.<YOUR-DOMAIN>.com
60
        ServerAdmin webmaster@<YOUR-DOMAIN>.com
61
        DocumentRoot /live/redmine/public/
62
        ErrorLog logs/redmine_error_log
63
64
        <Directory "/live/redmine/public/">
65
                Options Indexes ExecCGI FollowSymLinks
66
                Order allow,deny
67
                Allow from all
68
                AllowOverride all
69
        </Directory>
70
    </VirtualHost>
71
</pre>
72
73
* Make sure your files, log, tmp, and vendor directories are all accessible (read/write) by user apache, group apache. We did that via a change of ownership:
74
  @# chown -R apache:apache files log tmp vendor@
75
76
77 2 Cyber Sprocket
h3. Error Messages and Resolutions
78 1 Cyber Sprocket
79 2 Cyber Sprocket
  * @Rails requires RubyGems >= 0.9.4. Please install RubyGems@
80 1 Cyber Sprocket
    Look for rogue versions of ruby binaries.  We had an older version in /usr/bin/ruby as well as /usr/local/bin/ruby.
81
82 2 Cyber Sprocket
  * @Premature script headers@
83
    This is the generic "got something before the Content-Type: header in a CGI script" error from Apache.  Run dispatch.cgi (see below) and see what comes out BEFORE the Content-Type: directive.
84
85 8 William Baum
h3. Helpful Commands
86 2 Cyber Sprocket
87
 * @# which ruby@
88
   tells you which ruby binary is being run when the fully-qualified-filename has not been specified.
89
90
 * @# find / -name ruby@
91
   searches your entire system for any file named ruby, warning: can take a while on large filesystems.
92
 
93
 * @# ruby -v@
94 1 Cyber Sprocket
   tell you what version of ruby you are running by default
95
96
 * @#public/dispatch.cgi@
97
   runs the dispatch CGI script.   It should spit out HTML that start with @Content-Type: text/html; charset=utf-8@, if ANYTHING precedes the Content-Type text you will get a "premature script headers" error in the Apache log files.
98 8 William Baum
99
100
h2. mod_fastcgi
101
102 17 André Jonsson
I suggest getting redmine running with mod_cgi above, not only to verify your basic redmine and apache configuration, but also so you can appreciate the perfomance gains you'll get from mod_fastcgi or mod_fcgid.
103 8 William Baum
104
We'll start with "mod_fastcgi":http://www.fastcgi.com/.  
105
106
Install prerequisites:
107
108
<pre>
109
yum install libtool httpd-devel apr-devel apr
110
</pre>
111
112
h3. Download and Install mod_fastcgi
113
114
<pre>
115
cd /usr/local/src/
116
wget http://www.fastcgi.com/dist/mod_fastcgi-current.tar.gz
117
118
tar -zxvf mod_fastcgi-current.tar.gz
119
cd mod_fastcgi-2.4.6/
120
cp Makefile.AP2 Makefile 
121
make top_dir=/usr/lib/httpd
122
make install top_dir=/usr/lib/httpd
123
</pre>
124
125
Create or edit @/etc/httpd/conf.d/mod_fastcgi.conf@
126
<pre>
127
LoadModule fastcgi_module modules/mod_fastcgi.so
128
<IfModule mod_fastcgi.c>
129
FastCgiIpcDir /tmp/fcgi_ipc/
130
</IfModule>
131
</pre>
132
133
The @/tmp/fcgi_ipc/@ directory needs to be writable to the apache user:
134
<pre>
135
chown -R apache.apache /tmp/fcgi_ipc/
136
chmod -R 777 /tmp/fcgi_ipc/
137
</pre>
138
139
> Note:  I had to do this more than once.. It created directories which it then didn't own.. ??
140
141
h3. Download and install @fcgi@ (for fcgi gem)
142
143
<pre>
144
wget http://www.fastcgi.com/dist/fcgi-2.4.0.tar.gz
145
tar -zxvf fcgi-2.4.0.tar.gz
146
cd fcgi-2.4.0
147
./configure
148
make
149
make install
150
</pre>
151
152
h3. Install fcgi gem:
153
154
<pre>
155
gem install fcgi
156
</pre>
157
158
h2. Configuring redmine to use fastcgi:
159
160
In your redmine/public/ directory, copy @dispatch.fcgi.example@ to @dispatch.fcgi@
161
> Note: Mine was shebanged to "#!/usr/bin/env ruby", which is fine.  I found a reference or two that seemed to indicate the 'env' bit is preferable to calling ruby directly.  If this doesn't work, then you'll need to change it to wherever your ruby is as above.
162
163
@./public/.htaccess@
164
<pre>
165 20 Anton Kovalenko
#RewriteRule ^(stylesheets.*|images.*|favicon.*|javascripts.*|plugin_assets.*|themes.*)$ $1 [L]
166 8 William Baum
#<IfModule mod_fastcgi.c>
167
#       RewriteRule ^(.*)$ dispatch.fcgi [QSA,L]
168
#</IfModule>
169
#<IfModule mod_fcgid.c>
170
#       RewriteRule ^(.*)$ dispatch.fcgi [QSA,L]
171
#</IfModule>
172
#<IfModule mod_cgi.c>
173
#       RewriteRule ^(.*)$ dispatch.cgi [QSA,L]
174
#</IfModule>
175
RewriteRule ^(.*)$ dispatch.fcgi [QSA,L]
176
</pre>
177
178
The default .htaccess will use cgi if it's available, so we need to force fcgi.  You could perhaps rearrange the directives to prefer fcgi -- I just commented out the others and forced it with <code>RewriteRule ^(.*)$ dispatch.fcgi [QSA,L]</code>  You can see which one is actually in use with <code>ps gaux</code>
179
180
Give it a whirl:
181
<pre>
182
/etc/init.d/httpd configtest
183
/etc/init.d/httpd restart
184
</pre>
185
186
h2. Additional Apache Configuration
187
188
When I first fired up apache with redmine, apache started very slowly and sucked up a significantly larger chunk of RAM than normal.  Further investigation revealed that it had fired off *8* @ruby .../redmine/public/dispatch.fcgi@ processes! No wonder it was slow. 
189
190
I was running redmin under the apache default VirtualHost, and the default StartServers, MinSpareServers, etc. applied.  You can adjust the defaults in @/etc/httpd/conf/httpd.conf@ or even better is to run redmine under a @NameVirtualHost@ or a different @VirtualHost@.  This prevents apache from firing off a bunch of extraneous processes, and @NameVirtualHost@ should allow you to configure multiple redmine environments on the same IP without wasting a bunch of resources.
191
192
If you're having issues with apache virtual hosts, this can be very helpful:
193
<pre>
194
/usr/sbin/httpd -t -D DUMP_VHOSTS
195
</pre>
196
197
h2. mod_fcgid
198 1 Cyber Sprocket
199 14 Cyber Sprocket
h3. fcgid from Apache
200
201
"Official Apache mod_fcgid":http://httpd.apache.org/mod_fcgid/ this is the Apache version, seems newer and we had more luck with this than the Coremail hosted version below.
202
203
<pre>
204
cd /usr/local/src/
205
wget http://apache.mirrors.hoobly.com/httpd/mod_fcgid/mod_fcgid-2.3.5.tar.gz
206
tar zxvf mod_fcgid.2.3.5.tgz
207
cd mod_fcgid.2.3.5
208
</pre>
209
210
Configure and Install
211
<pre>
212
./configure.apxs
213
make
214
make install
215
service httpd restart
216
</pre>
217
218
219
220
h3. fcgid from China Coremail service
221
222 8 William Baum
"mod_fcgid":http://fastcgi.coremail.cn/ seems newer and preferable to mod_fastcgi.
223 1 Cyber Sprocket
224 14 Cyber Sprocket
225 1 Cyber Sprocket
<pre>
226 8 William Baum
cd /usr/local/src/
227 14 Cyber Sprocket
wget http://apache.mirrors.hoobly.com/httpd/mod_fcgid/mod_fcgid-2.2.tar.gz
228 13 William Baum
tar zxvf mod_fcgid.2.2.tgz
229
cd mod_fcgid.2.2
230 8 William Baum
</pre>
231
232
Edit Makefile
233
<pre>
234
#top_dir      = /usr/local/apache2
235 1 Cyber Sprocket
top_dir      = /usr/lib/httpd
236 13 William Baum
</pre>
237
238
Build it..
239
<pre>
240
make
241
make install
242 8 William Baum
</pre>
243
244
Edit/create @/etc/httpd/conf.d/mod_fcgid.conf@
245
<pre>
246
LoadModule fcgid_module /usr/lib/httpd/modules/mod_fcgid.so
247
248
<IfModule mod_fcgid.c>
249
    SocketPath /tmp/fcgid_sock/
250
    AddHandler fcgid-script .fcgi
251
</IfModule>
252
</pre>
253
254
Now you should be able to switch between mod_fastcgi and mod_fcgid by renaming one of them to other than *.conf in @/etc/httpd/conf.d/@
255
<pre>
256
cd /etc/httpd/conf.d/
257
mv mod_fastcgi.conf mod_fastcgi.conf.not
258 1 Cyber Sprocket
/etc/init.d/httpd restart
259
</pre>
260 14 Cyber Sprocket
261
262
h3. Either Version, Permissions
263
264
With either fcgid version you may run into problems with the fcgid service starting.   Make sure the socks parent directory (typically /var/log/httpd) has proper permissions.   The default directory permissions for /var/log/httpd is for a standard non-fcgid install of Apache.  You need to add execute permissions for Apache to read/write to the directory properly while it is running fcgid.
265
266
<pre>
267
chmod 755 /var/log/httpd
268
service httpd restart
269
</pre>
270
271 8 William Baum
272
h2. Installation Sources
273
274
In the above steps, I installed from sources only where I didn't find any RPM's in common repo's.  I'm rather surprised that one can't simply @yum install@ mod_fastcgi, mod_fcgid, fcgi, etc., but there we are.  If you find better methods or sources for any of the above, please feel free to update.
275 12 Fred Eisele
276 16 Lu Pon
h2. Ubuntu Server (Version ?) (This not don't work for 8.04 LTS)
277 12 Fred Eisele
278
Install passenger
279
<pre>
280
sudo aptitude install libapache2-mod-passenger
281
</pre>
282
This did switch the type of apache server to worker from prefork but in my case that was acceptable.
283
284
I had installed the redmine tarball into /opt/redmine as redmine-0.8.5 and made a symlink named current.
285
Then make a link to the redmine public directory from the apache DocumentRoot (see /etc/apache2/config.d/*).
286
<pre>
287
ln -s /opt/redmine/current/public /var/www/redmine
288
</pre>
289
290
Updated /etc/apache/config.d/redmine (or wherever your virtualhost is defined) with the following:
291
<pre>
292
RailsEnv production
293
RailsBaseURI /redmine
294
</pre>
295
296
Restart apache.
297 15 Martin Cyr
298
h2. For FreeBSD (and possibly others)
299
300
I found the current instructions to be lacking on some way. With the information above, the scripts and css might not appear correctly, the link get broken and such. Also, some hacks seems to have been lost to history (the #!/bin/bash/ruby hack, wich is not required with this technique). Here is how I got it going.
301
302
Make sure 'Apache 2.2', 'Ruby', 'fastcgi' (including the gem) are installed.
303
First, putting redmine in a sub-directory requires more work and is left for the reader as an exercise to get properly (hint Rewrite is your friend), so from now on, I will assume that redmine will be the DocumentRoot.
304
So here it is, my httpd.conf :
305
<pre>
306
LoadModule fastcgi_module     libexec/apache22/mod_fastcgi.so
307
308
DocumentRoot "/usr/local/www/redmine/public"
309
310
FastCgiServer /usr/local/www/redmine/public/dispatch.fcgi -idle-timeout 120 -initial-env RAILS_ENV=production -initial-env PATH=/usr/local/bin -processes 2
311
312
<Directory /usr/local/www/redmine/public>
313
   AddHandler fastcgi-script fcgi
314
   Order allow,deny
315
   Allow from all
316
   AllowOverride all
317
   Options +FollowSymLinks +ExecCGI
318
   RewriteEngine On
319
   RewriteCond %{REQUEST_FILENAME} !-f
320
   RewriteRule ^(.*)$ dispatch.fcgi
321
</Directory>
322
</pre>
323
324
Now let's explain what happens and why:
325
# _AddHandler fastcgi-script fcgi_: defines that when apache identifies a file with extension fcgi, if should be handled buy the fastcgi-script handler. This definition of a handler is created by the mod_fastcgi.so module (loaded through the LoadModule directive of couse).
326
# _Options +FollowSymLinks +ExecCGI_: tells apache that within this directory, CGI-ish script execution is allowed
327
# _RewriteCond %{REQUEST_FILENAME} !-f_: only rewrite if the file doesn't exist
328
# _RewriteRule ^(.*)$ dispatch.fcgi_: everything goes to dispatch.fcgi
329
# _FastCgiServer /usr/local/www/redmine/public/dispatch.fcgi -idle-timeout 120 -initial-env RAILS_ENV=production -initial-env PATH=/usr/local/bin -processes 2_: This is the main thing. As Scott Laird explains in this "blog":http://scottstuff.net/blog/2005/07/20/apache-tuning-for-rails-and-fastcgi, running FastCGI can run in three modes (see post). This tells FastCGI how to handle our script, with the important part being the initial-env to define what variables should be set in the FastCGI context. As FastCGI starts, it will normally start with a blank (*emtpy*) environment variables, so yeah, your $PATH will be empty, and no /usr/bin/env *will NOT* find the ruby executable in the path and thus failing with the error _env: ruby: No such file or directory_. Also, ruby will not know that he is expected to start in production env. With this line, you don't have to fix your dispatch.fcgi shabang (the #!/usr/bin/env ruby line) nor will you have to change the config/environment.rb file with a ENV['RAILS_ENV'] ||= 'production'.
330
331
Restart apache and you should be set.