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 1 Cyber Sprocket
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 1 Cyber Sprocket
h2. For CentOS 5
8 1 Cyber Sprocket
9 1 Cyber Sprocket
h3. Assumptions
10 1 Cyber Sprocket
11 1 Cyber Sprocket
* OS is CentOS 5
12 1 Cyber Sprocket
* Web server is Apache 2
13 1 Cyber Sprocket
** mod_cgi is enabled
14 1 Cyber Sprocket
** 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 4 Cyber Sprocket
19 4 Cyber Sprocket
* You do not need to run mod_fcgid
20 4 Cyber Sprocket
* You do not need to run mod_fastcgi
21 8 William Baum
 
22 8 William Baum
bq. -This section needs work. I can't tell if these are the myths or the corrections to the myths.
23 8 William Baum
_(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 14 Cyber Sprocket
29 1 Cyber Sprocket
h3. Basic Steps
30 1 Cyber Sprocket
31 11 Patrick OMalley
* Install Redmine per the [[RedmineInstall| installation instructions]] and get it running with webrick.
32 1 Cyber Sprocket
33 1 Cyber Sprocket
* Kill the webrick session
34 1 Cyber Sprocket
35 1 Cyber Sprocket
* Copy the public/dispatch.cgi.example to public/dispatch.cgi
36 1 Cyber Sprocket
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 18 Matt Brown
  @#!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 10 Patrick OMalley
  @require "/usr/lib/ruby/gems/1.8/gems/rails-2.1.2/lib/dispatcher.rb"@
46 19 Matt Brown
  or
47 19 Matt Brown
  @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 1 Cyber Sprocket
  @# chmod 755 public/dispatch.cgi@
51 1 Cyber Sprocket
52 1 Cyber Sprocket
* Update the config/environment.rb file to force the rails environment to production, simply uncomment this line at the start of the file:
53 1 Cyber Sprocket
  @ENV['RAILS_ENV'] ||= 'production'@
54 1 Cyber Sprocket
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 3 Cyber Sprocket
57 1 Cyber Sprocket
<pre>
58 1 Cyber Sprocket
    <VirtualHost *:80>
59 1 Cyber Sprocket
        ServerName redmine.<YOUR-DOMAIN>.com
60 1 Cyber Sprocket
        ServerAdmin webmaster@<YOUR-DOMAIN>.com
61 1 Cyber Sprocket
        DocumentRoot /live/redmine/public/
62 1 Cyber Sprocket
        ErrorLog logs/redmine_error_log
63 1 Cyber Sprocket
64 1 Cyber Sprocket
        <Directory "/live/redmine/public/">
65 1 Cyber Sprocket
                Options Indexes ExecCGI FollowSymLinks
66 1 Cyber Sprocket
                Order allow,deny
67 1 Cyber Sprocket
                Allow from all
68 1 Cyber Sprocket
                AllowOverride all
69 1 Cyber Sprocket
        </Directory>
70 1 Cyber Sprocket
    </VirtualHost>
71 1 Cyber Sprocket
</pre>
72 1 Cyber Sprocket
73 1 Cyber Sprocket
* 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 1 Cyber Sprocket
  @# chown -R apache:apache files log tmp vendor@
75 1 Cyber Sprocket
76 1 Cyber Sprocket
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 1 Cyber Sprocket
82 2 Cyber Sprocket
  * @Premature script headers@
83 2 Cyber Sprocket
    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 2 Cyber Sprocket
85 8 William Baum
h3. Helpful Commands
86 2 Cyber Sprocket
87 2 Cyber Sprocket
 * @# which ruby@
88 2 Cyber Sprocket
   tells you which ruby binary is being run when the fully-qualified-filename has not been specified.
89 2 Cyber Sprocket
90 2 Cyber Sprocket
 * @# find / -name ruby@
91 2 Cyber Sprocket
   searches your entire system for any file named ruby, warning: can take a while on large filesystems.
92 2 Cyber Sprocket
 
93 2 Cyber Sprocket
 * @# ruby -v@
94 1 Cyber Sprocket
   tell you what version of ruby you are running by default
95 1 Cyber Sprocket
96 1 Cyber Sprocket
 * @#public/dispatch.cgi@
97 1 Cyber Sprocket
   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 8 William Baum
100 8 William Baum
h2. mod_fastcgi
101 8 William Baum
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 8 William Baum
We'll start with "mod_fastcgi":http://www.fastcgi.com/.  
105 8 William Baum
106 8 William Baum
Install prerequisites:
107 8 William Baum
108 8 William Baum
<pre>
109 8 William Baum
yum install libtool httpd-devel apr-devel apr
110 8 William Baum
</pre>
111 8 William Baum
112 8 William Baum
h3. Download and Install mod_fastcgi
113 8 William Baum
114 8 William Baum
<pre>
115 8 William Baum
cd /usr/local/src/
116 8 William Baum
wget http://www.fastcgi.com/dist/mod_fastcgi-current.tar.gz
117 8 William Baum
118 8 William Baum
tar -zxvf mod_fastcgi-current.tar.gz
119 8 William Baum
cd mod_fastcgi-2.4.6/
120 8 William Baum
cp Makefile.AP2 Makefile 
121 8 William Baum
make top_dir=/usr/lib/httpd
122 8 William Baum
make install top_dir=/usr/lib/httpd
123 8 William Baum
</pre>
124 8 William Baum
125 8 William Baum
Create or edit @/etc/httpd/conf.d/mod_fastcgi.conf@
126 8 William Baum
<pre>
127 8 William Baum
LoadModule fastcgi_module modules/mod_fastcgi.so
128 8 William Baum
<IfModule mod_fastcgi.c>
129 8 William Baum
FastCgiIpcDir /tmp/fcgi_ipc/
130 8 William Baum
</IfModule>
131 8 William Baum
</pre>
132 8 William Baum
133 8 William Baum
The @/tmp/fcgi_ipc/@ directory needs to be writable to the apache user:
134 8 William Baum
<pre>
135 8 William Baum
chown -R apache.apache /tmp/fcgi_ipc/
136 8 William Baum
chmod -R 777 /tmp/fcgi_ipc/
137 8 William Baum
</pre>
138 8 William Baum
139 8 William Baum
> Note:  I had to do this more than once.. It created directories which it then didn't own.. ??
140 8 William Baum
141 8 William Baum
h3. Download and install @fcgi@ (for fcgi gem)
142 8 William Baum
143 8 William Baum
<pre>
144 8 William Baum
wget http://www.fastcgi.com/dist/fcgi-2.4.0.tar.gz
145 8 William Baum
tar -zxvf fcgi-2.4.0.tar.gz
146 8 William Baum
cd fcgi-2.4.0
147 8 William Baum
./configure
148 8 William Baum
make
149 8 William Baum
make install
150 8 William Baum
</pre>
151 8 William Baum
152 8 William Baum
h3. Install fcgi gem:
153 8 William Baum
154 8 William Baum
<pre>
155 8 William Baum
gem install fcgi
156 8 William Baum
</pre>
157 8 William Baum
158 8 William Baum
h2. Configuring redmine to use fastcgi:
159 8 William Baum
160 8 William Baum
In your redmine/public/ directory, copy @dispatch.fcgi.example@ to @dispatch.fcgi@
161 8 William Baum
> 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 8 William Baum
163 8 William Baum
@./public/.htaccess@
164 8 William Baum
<pre>
165 20 Anton Kovalenko
#RewriteRule ^(stylesheets.*|images.*|favicon.*|javascripts.*|plugin_assets.*|themes.*)$ $1 [L]
166 8 William Baum
#<IfModule mod_fastcgi.c>
167 8 William Baum
#       RewriteRule ^(.*)$ dispatch.fcgi [QSA,L]
168 8 William Baum
#</IfModule>
169 8 William Baum
#<IfModule mod_fcgid.c>
170 8 William Baum
#       RewriteRule ^(.*)$ dispatch.fcgi [QSA,L]
171 8 William Baum
#</IfModule>
172 8 William Baum
#<IfModule mod_cgi.c>
173 8 William Baum
#       RewriteRule ^(.*)$ dispatch.cgi [QSA,L]
174 8 William Baum
#</IfModule>
175 8 William Baum
RewriteRule ^(.*)$ dispatch.fcgi [QSA,L]
176 8 William Baum
</pre>
177 8 William Baum
178 8 William Baum
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 8 William Baum
180 8 William Baum
Give it a whirl:
181 8 William Baum
<pre>
182 8 William Baum
/etc/init.d/httpd configtest
183 8 William Baum
/etc/init.d/httpd restart
184 8 William Baum
</pre>
185 8 William Baum
186 8 William Baum
h2. Additional Apache Configuration
187 8 William Baum
188 8 William Baum
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 8 William Baum
190 8 William Baum
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 8 William Baum
192 8 William Baum
If you're having issues with apache virtual hosts, this can be very helpful:
193 8 William Baum
<pre>
194 8 William Baum
/usr/sbin/httpd -t -D DUMP_VHOSTS
195 8 William Baum
</pre>
196 8 William Baum
197 8 William Baum
h2. mod_fcgid
198 1 Cyber Sprocket
199 14 Cyber Sprocket
h3. fcgid from Apache
200 14 Cyber Sprocket
201 14 Cyber Sprocket
"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 14 Cyber Sprocket
203 14 Cyber Sprocket
<pre>
204 14 Cyber Sprocket
cd /usr/local/src/
205 14 Cyber Sprocket
wget http://apache.mirrors.hoobly.com/httpd/mod_fcgid/mod_fcgid-2.3.5.tar.gz
206 14 Cyber Sprocket
tar zxvf mod_fcgid.2.3.5.tgz
207 14 Cyber Sprocket
cd mod_fcgid.2.3.5
208 14 Cyber Sprocket
</pre>
209 14 Cyber Sprocket
210 14 Cyber Sprocket
Configure and Install
211 14 Cyber Sprocket
<pre>
212 14 Cyber Sprocket
./configure.apxs
213 14 Cyber Sprocket
make
214 14 Cyber Sprocket
make install
215 14 Cyber Sprocket
service httpd restart
216 14 Cyber Sprocket
</pre>
217 14 Cyber Sprocket
218 14 Cyber Sprocket
219 14 Cyber Sprocket
220 14 Cyber Sprocket
h3. fcgid from China Coremail service
221 14 Cyber Sprocket
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 13 William Baum
cd mod_fcgid.2.2
230 8 William Baum
</pre>
231 8 William Baum
232 8 William Baum
Edit Makefile
233 8 William Baum
<pre>
234 8 William Baum
#top_dir      = /usr/local/apache2
235 1 Cyber Sprocket
top_dir      = /usr/lib/httpd
236 13 William Baum
</pre>
237 13 William Baum
238 13 William Baum
Build it..
239 13 William Baum
<pre>
240 13 William Baum
make
241 13 William Baum
make install
242 8 William Baum
</pre>
243 8 William Baum
244 8 William Baum
Edit/create @/etc/httpd/conf.d/mod_fcgid.conf@
245 8 William Baum
<pre>
246 8 William Baum
LoadModule fcgid_module /usr/lib/httpd/modules/mod_fcgid.so
247 8 William Baum
248 8 William Baum
<IfModule mod_fcgid.c>
249 8 William Baum
    SocketPath /tmp/fcgid_sock/
250 8 William Baum
    AddHandler fcgid-script .fcgi
251 8 William Baum
</IfModule>
252 8 William Baum
</pre>
253 8 William Baum
254 8 William Baum
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 8 William Baum
<pre>
256 8 William Baum
cd /etc/httpd/conf.d/
257 8 William Baum
mv mod_fastcgi.conf mod_fastcgi.conf.not
258 1 Cyber Sprocket
/etc/init.d/httpd restart
259 1 Cyber Sprocket
</pre>
260 14 Cyber Sprocket
261 14 Cyber Sprocket
262 14 Cyber Sprocket
h3. Either Version, Permissions
263 14 Cyber Sprocket
264 14 Cyber Sprocket
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 14 Cyber Sprocket
266 14 Cyber Sprocket
<pre>
267 14 Cyber Sprocket
chmod 755 /var/log/httpd
268 14 Cyber Sprocket
service httpd restart
269 14 Cyber Sprocket
</pre>
270 14 Cyber Sprocket
271 8 William Baum
272 8 William Baum
h2. Installation Sources
273 8 William Baum
274 8 William Baum
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 Pa
h2. Ubuntu Server (Version ?) (This not don't work for 8.04 LTS)
277 12 Fred Eisele
278 12 Fred Eisele
Install passenger
279 12 Fred Eisele
<pre>
280 12 Fred Eisele
sudo aptitude install libapache2-mod-passenger
281 12 Fred Eisele
</pre>
282 12 Fred Eisele
This did switch the type of apache server to worker from prefork but in my case that was acceptable.
283 12 Fred Eisele
284 12 Fred Eisele
I had installed the redmine tarball into /opt/redmine as redmine-0.8.5 and made a symlink named current.
285 12 Fred Eisele
Then make a link to the redmine public directory from the apache DocumentRoot (see /etc/apache2/config.d/*).
286 12 Fred Eisele
<pre>
287 12 Fred Eisele
ln -s /opt/redmine/current/public /var/www/redmine
288 12 Fred Eisele
</pre>
289 12 Fred Eisele
290 12 Fred Eisele
Updated /etc/apache/config.d/redmine (or wherever your virtualhost is defined) with the following:
291 12 Fred Eisele
<pre>
292 12 Fred Eisele
RailsEnv production
293 12 Fred Eisele
RailsBaseURI /redmine
294 12 Fred Eisele
</pre>
295 12 Fred Eisele
296 12 Fred Eisele
Restart apache.
297 15 Martin Cyr
298 15 Martin Cyr
h2. For FreeBSD (and possibly others)
299 15 Martin Cyr
300 15 Martin Cyr
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 15 Martin Cyr
302 15 Martin Cyr
Make sure 'Apache 2.2', 'Ruby', 'fastcgi' (including the gem) are installed.
303 15 Martin Cyr
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 15 Martin Cyr
So here it is, my httpd.conf :
305 15 Martin Cyr
<pre>
306 15 Martin Cyr
LoadModule fastcgi_module     libexec/apache22/mod_fastcgi.so
307 15 Martin Cyr
308 15 Martin Cyr
DocumentRoot "/usr/local/www/redmine/public"
309 15 Martin Cyr
310 15 Martin Cyr
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 15 Martin Cyr
312 15 Martin Cyr
<Directory /usr/local/www/redmine/public>
313 15 Martin Cyr
   AddHandler fastcgi-script fcgi
314 15 Martin Cyr
   Order allow,deny
315 15 Martin Cyr
   Allow from all
316 15 Martin Cyr
   AllowOverride all
317 15 Martin Cyr
   Options +FollowSymLinks +ExecCGI
318 15 Martin Cyr
   RewriteEngine On
319 15 Martin Cyr
   RewriteCond %{REQUEST_FILENAME} !-f
320 15 Martin Cyr
   RewriteRule ^(.*)$ dispatch.fcgi
321 15 Martin Cyr
</Directory>
322 15 Martin Cyr
</pre>
323 15 Martin Cyr
324 15 Martin Cyr
Now let's explain what happens and why:
325 15 Martin Cyr
# _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 15 Martin Cyr
# _Options +FollowSymLinks +ExecCGI_: tells apache that within this directory, CGI-ish script execution is allowed
327 15 Martin Cyr
# _RewriteCond %{REQUEST_FILENAME} !-f_: only rewrite if the file doesn't exist
328 15 Martin Cyr
# _RewriteRule ^(.*)$ dispatch.fcgi_: everything goes to dispatch.fcgi
329 15 Martin Cyr
# _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 15 Martin Cyr
331 15 Martin Cyr
Restart apache and you should be set.