Project

General

Profile

Redmine 203 with Subversion and LDAP Authentication (for Redmine and Subversion through Redmine) on Centos 6 i386 - detailed » History » Version 17

Hung Nguyen Vu, 2012-08-30 11:31
Type and subtle fixes

1 7 Hung Nguyen Vu
h1. Redmine 2.0.3 on Centos 6.3
2 2 Sven Nosse
3
{{>toc}}
4
5
h2. Introduction
6
7 6 Hung Nguyen Vu
Our company was using the BITNAMI stack with Redmine and Subversion for our production environment. So the goal was about changing the server and migrating the data from Redmine 1.4 to Redmine 2.0.3 including getting all repositories and permissions preserved. 
8 1 Sven Nosse
9 6 Hung Nguyen Vu
I've tried to avoid webrick but rather use the fastCGI Module for Apache2. 
10
11
12
Second was converting the built-in accounts from the database to LDAP (ActiveDirectory). This is the result of 2 days of work and googling is this little tutorial for setting up a mentioned box doing exactly this stuff. We are using CentOS 6 (i386) for that task. 
13
14
# Please excuse my bad english for I am not used anymore to post long instruction manuals. Feel free to edit whatever you want. 
15
16
First of all, I tend to use vi so if you cannot operate vi I'd recommend to use any editor you like. If my instruction tells you to edit a file, you can find the sequence "..." which means, there is something above or below that line of text, that needs to be edited. Do not include those dots... 
17
18 1 Sven Nosse
h2. Assumptions
19
20 2 Sven Nosse
* You have a CentOS 6.3 installation (minimum install) working and SSH access to your box
21 6 Hung Nguyen Vu
* You can access the Internet
22
* You are logged in as root
23 1 Sven Nosse
24 6 Hung Nguyen Vu
h2. Redmine Installation Instruction
25 2 Sven Nosse
26
My personal flavour is to use as less self compiled packages as necessary to get the package up and runnning. So I try to use as many repository packages as possible.
27
28 6 Hung Nguyen Vu
h3. Turn off SE-Linux
29 3 Sven Nosse
30 6 Hung Nguyen Vu
I spent a lot of time to find out, that selinux can be a real party pooper. So I strongly recommend to disable that first before installing anything else. You can find a tutorial inside the howto section describing how to enable SELinux for your installation.
31 2 Sven Nosse
<pre>
32
vi /etc/selinux/config
33
</pre>
34
35 1 Sven Nosse
find the line with SELINUX and set it to
36 2 Sven Nosse
<pre>
37
...
38
SELINUX=disabled
39
...
40
</pre>
41
Do a reboot *NOW*
42
43 6 Hung Nguyen Vu
h3. Install basic services (Apache, mySQL, and several tools...)
44 2 Sven Nosse
45 9 Hung Nguyen Vu
Now we are good to go to install some tools that might be useful during our installation... 
46
47
First of all, update your system, make sure it is up to date,
48 1 Sven Nosse
<pre>
49
yum update
50 9 Hung Nguyen Vu
</pre>
51
52
and then install some prerequisite packages to the setup,
53
<pre>
54
yum -y install wget vim \\
55
       system-config-network system-config-firewall vim openssh-clients
56
</pre>
57
58
anhd some packages needed for Redmine
59
<pre>
60 2 Sven Nosse
yum -y install httpd mysql mysql-server 
61 1 Sven Nosse
</pre>
62 2 Sven Nosse
After that continue and install all packages that might be necessary during the ruby and redmine installation.
63
<pre>
64
yum -y install ruby rubygems 
65 6 Hung Nguyen Vu
yum -y install zlib-devel curl-devel openssl-devel httpd-devel apr-devel apr-util-devel mysql-devel gcc ruby-devel \\
66
      gcc-c++ make postgresql-devel ImageMagick-devel sqlite-devel perl-LDAP mod_perl perl-Digest-SHA
67 2 Sven Nosse
</pre>
68
69
h3. Configure basic services
70
71 6 Hung Nguyen Vu
Let's configure the basic services, first of all, make mySQL and Apache to start at boot
72 2 Sven Nosse
<pre>
73
chkconfig httpd on --level 2345
74
chkconfig mysqld on --level 2345
75
</pre>
76
After configuring these, start them up
77
<pre>
78
service httpd start
79
service mysqld start
80
</pre>
81
Now configure your new mySQL Installation and follow the instructions. Please note the mysql administrator password.
82
<pre>
83
/usr/bin/mysql_secure_installation
84
</pre>
85
86
h3. Configure passenger for Apache
87
88
You need to install passenger for Apache using gem. Do the following on the command line
89
<pre>
90
gem install passenger
91
passenger-install-apache2-module
92
</pre>
93
Please notice the installation messages! The next .conf file might use another path or version! 
94
After this you need to generate a conf file with the displayed content
95
<pre>
96
vi /etc/httpd/conf.d/ruby.conf
97
</pre>
98
During my installation the following content was displayed and needs to be entered in that file:
99
<pre>
100
   LoadModule passenger_module /usr/lib/ruby/gems/1.8/gems/passenger-3.0.15/ext/apache2/mod_passenger.so
101
   PassengerRoot /usr/lib/ruby/gems/1.8/gems/passenger-3.0.15
102
   PassengerRuby /usr/bin/ruby
103
</pre>
104
Restart your apache with
105
<pre>
106
service httpd restart
107
</pre>
108
109 1 Sven Nosse
h3. Get Redmine and install it
110
111
change to your home directory and download the latest version, expand it and copy it to the right place.
112
<pre>
113
cd
114
wget http://rubyforge.org/frs/download.php/76259/redmine-2.0.3.tar.gz
115
tar xvfz redmine-2.0.3.tar.gz
116 11 Hung Nguyen Vu
mkdir -p /var/www/redmine
117 12 Hung Nguyen Vu
cp redmine-2.0.3/* /var/www/redmine
118 1 Sven Nosse
</pre>
119 6 Hung Nguyen Vu
120
or you can do
121
122
<pre>
123
cd /var/www
124
wget http://rubyforge.org/frs/download.php/76259/redmine-2.0.3.tar.gz
125
tar xvfz redmine-2.0.3.tar.gz
126
ln -s redmine-2.0 redmine
127
</pre>
128
129 1 Sven Nosse
Next is to install bundler and let it install the production environment (with automatic resolve)
130
Now change to this directory - *this is your new Redmine application directory!*
131 2 Sven Nosse
<pre>
132
cd /var/www/redmine
133
gem install bundler
134
bundle install --without development test
135 1 Sven Nosse
</pre>
136 10 Hung Nguyen Vu
fetch some coffee... this might take some time...
137 2 Sven Nosse
138
h3. Create Redmine database
139
140 6 Hung Nguyen Vu
Next to generate a new database for redmine
141 14 Sven Nosse
Log on to your database with the following command. If prompted for a password, enter it.
142 2 Sven Nosse
<pre>
143
mysql -u root -p
144
</pre>
145
I tend to create a local only user for that database, change the password 'very_secret' to a better one :)
146
<pre>
147
create database redmine character set utf8;
148
create user 'redmine'@'localhost' identified by 'very_secret';
149
grant all privileges on redmine.* to 'redmine'@'localhost'; 
150
quit;
151
</pre>
152
153
h3. Configure Redmine
154
155
First of all, copy the example config to a productive one and edit the config for your needs
156
<pre>
157
cd /var/www/redmine/config
158
cp database.yml.example database.yml
159
vi /var/www/redmine/config/database.yml
160
</pre>
161
Now find the production section inside this file and edit it like that
162
<pre>
163
...
164
production:
165 13 Hung Nguyen Vu
# adapter = mysql2 is newer and proven to be more better than mysql
166
# adapter: mysql2
167 2 Sven Nosse
  adapter: mysql
168
  database: redmine
169
  host: localhost
170
  username: redmine
171
  password: very_secret
172
  encoding: utf8
173
...
174
</pre>
175
Head back to your application directory and generate a secret token
176
<pre>
177
cd /var/www/redmine/
178
rake generate_secret_token
179
</pre>
180 1 Sven Nosse
Now it is about time to generate the database structure (application directory!)
181
<pre>
182 2 Sven Nosse
cd /var/www/redmine/
183
RAILS_ENV=production rake db:migrate
184
</pre>
185
fill the database with default values...
186 1 Sven Nosse
<pre>
187 2 Sven Nosse
cd /var/www/redmine/
188
RAILS_ENV=production rake redmine:load_default_data
189
</pre>
190
follow the instructions to select your language.
191
192 6 Hung Nguyen Vu
h3. Mind the firewall!
193 2 Sven Nosse
194 6 Hung Nguyen Vu
Be aware that the firewall is enabled by default (which is good!). So if you know which ports to open, do it now or disable the firewall (just for testing purposes). I'd really recommend disabling the firewall during installation and enable it (opening ports) after you are sure that everything works.
195 1 Sven Nosse
<pre>
196 2 Sven Nosse
system-config-firewall
197
</pre>
198
use the onscreen menu to disable it or adjust the values.
199
200 8 Hung Nguyen Vu
or simply disable iptables during Redmine's setup
201
<pre>
202
service iptables stop
203
</pre>
204
205 6 Hung Nguyen Vu
h3. Do a testdrive!
206 2 Sven Nosse
207
I mentioned that I wanted not to use webrick, but for a testdrive, it'll work. This helps finding bugs and errors that might have occured before.
208
<pre>
209
cd /var/www/redmine/
210
ruby script/rails server webrick -e production
211
</pre>
212
Open up a browser and point it to: http://yoursystemname.yourdomain.com:3000 - the default username and password is 'admin'.
213
If everything is working, you are good to go! Kill webrick by hitting Ctrl+C.
214
215 6 Hung Nguyen Vu
h3. Activate FCGI and generate plugin directory
216 2 Sven Nosse
217
To activate the fcgi module you need to copy the example file and edit the very first line. During this step it is recommended to generate the default .htaccess config as well.
218
<pre>
219
cd /var/www/redmine/public
220
mkdir plugin_assets
221
cp dispatch.fcgi.example dispatch.fcgi
222
cp htaccess.fcgi.example .htaccess
223 1 Sven Nosse
vi /var/www/redmine/public/dispatch.fcgi
224
</pre>
225 2 Sven Nosse
now edit dispatch.fcgi and change it like this...
226
<pre>
227
#!/usr/bin/ruby
228
...
229
</pre>
230
231
h3. Apache permissions!
232
233
this one is important, so don't miss that one... 
234 1 Sven Nosse
<pre>
235 2 Sven Nosse
chown -R apache:apache /var/www/redmine/
236 1 Sven Nosse
</pre>
237 2 Sven Nosse
238 6 Hung Nguyen Vu
Note: "apache" is the user that runs httpd (apache) service, as defined in /etc/password and /etc/httpd/conf/httpd.conf 
239
240 2 Sven Nosse
h3. Getting Apache to work with FastCGI
241
242
Unfortunately the default Repo from CentOS cannot deliver the fcgid module so it is important to include a replo, that can deliver this package. I use the Fedora Repo so it is time to activate this... Again - this can change so please take care which repository to use.
243
<pre>
244
rpm --import https://fedoraproject.org/static/0608B895.txt
245
wget http://dl.fedoraproject.org/pub/epel/6/x86_64/epel-release-6-7.noarch.rpm
246
rpm -ivh epel-release-6-7.noarch.rpm
247
yum -y install mod_fcgid
248
</pre>
249
250 6 Hung Nguyen Vu
h3. Set the file path for Redmine
251 2 Sven Nosse
252
I wanted to move the files to another location, so I decided to move them to /opt/redmine
253
<pre>
254 6 Hung Nguyen Vu
mkdir -p /opt/redmine/files
255 2 Sven Nosse
chown -R apache:apache /opt/redmine
256
</pre>
257
now edit the configuration
258
<pre>
259
cd /var/www/redmine/config
260
cp configuration.yml.example configuration.yml
261
vi /var/www/redmine/config/configuration.yml
262
</pre>
263
edit the path settings inside this file...
264
<pre>
265
...
266
  attachments_storage_path: /opt/redmine/files
267
...
268
</pre>
269
270
h3. Telling Apache to serve REDMINE
271
272
The final step is to tell apache, where to find Redmine and what to do with it. Generate a new conf file for your virtual host to serve redmine...
273
<pre>
274
vi /etc/httpd/conf.d/redmine.conf
275
</pre>
276
and enter the following config (adjust to your needs ;) )
277
<pre>
278
<VirtualHost *:80>
279
        ServerName yoursystemname.yourdomain.com
280
        ServerAdmin yourmail@yourdomain.com
281
        DocumentRoot /var/www/redmine/public/
282
        ErrorLog logs/redmine_error_log
283
284
        MaxRequestLen 20971520
285
286
        <Directory "/var/www/redmine/public/">
287
288
                Options Indexes ExecCGI FollowSymLinks
289
                Order allow,deny
290
                Allow from all
291
                AllowOverride all
292
        </Directory>
293
</VirtualHost>
294
</pre>
295
Restart Apache and cross your fingers, wheter you can access http://yoursystemname.yourdomain.com - redmine should be available right now...
296
<pre>
297
service httpd restart
298
</pre>
299
300
h3. Additional Config: E-Mail System
301
302 1 Sven Nosse
in order to get emails sent to your clients, edit the configuration.yml and enter your server settings...
303
<pre>
304
vi /var/www/redmine/config/configuration.yml
305
</pre>
306
now find the settings for your server... the following settings describe an anonymous relay on an internal server. You need to remove the username and password line if you use anonymous sign on.
307
<pre>
308
...
309
default:
310
  # Outgoing emails configuration (see examples above)
311
  email_delivery:
312
    delivery_method: :smtp
313
    smtp_settings:
314
      address: mailserver.yourdomain.com
315
      port: 25
316
      domain: yourdomain.com
317
...
318
</pre>
319
320 6 Hung Nguyen Vu
Here is the configration if you use Google's SMTP server
321
322
<pre>
323
production:
324
  email_delivery:
325
    delivery_method: :smtp
326
    smtp_settings:
327
#      tls: true
328
      enable_starttls_auto: true
329
      address: "smtp.gmail.com"
330
      port: '587'
331
      domain: "smtp.gmail.com"
332
      authentication: :plain
333
      user_name: "google-account-name@domain-name.domain-extension"
334
      password: "password"
335
</pre>
336
337 1 Sven Nosse
h2. Getting Subversion working
338 2 Sven Nosse
339
After getting Redmine working, it is time to get Subversion working... The goal is to integrate the repositories inside Redmine and host them on the same server...
340
341
h3. Installing Packages for Subversion
342
343
Install the following packages
344 1 Sven Nosse
<pre>
345 2 Sven Nosse
yum -y install mod_dav_svn subversion subversion-ruby
346
</pre>
347
348
h3. Linking authentication for Redmine
349
350
Redmine provides a perl module to handle Apache authentication on SVN DAV repositories. First step is to link that module into the search path
351
<pre>
352
mkdir /usr/lib/perl5/vendor_perl/Apache
353
ln -s /var/www/redmine/extra/svn/Redmine.pm /usr/lib/perl5/vendor_perl/Apache/Redmine.pm
354
</pre>
355
356 16 Sven Nosse
h3. Creating a path for subversion repositories
357 2 Sven Nosse
358
create a path and set permissions for your SVN repo...
359
<pre>
360
mkdir /opt/subversion
361
chown -R apache:apache /opt/subversion
362
</pre>
363
364 6 Hung Nguyen Vu
h3. Edit virtual host for apache to serve SVN with redmine
365 2 Sven Nosse
366
to get Apache working with subversion, you need to adjust (create) the virtual host file
367
<pre>
368
vi /etc/httpd/conf.d/subversion.conf
369
</pre>
370
now enter/edit the following
371
<pre>
372
PerlLoadModule Apache::Redmine
373
<Location /svn>
374
        DAV svn
375
        SVNParentPath "/opt/subversion"
376
        SVNListParentPath on
377
        Order deny,allow
378
        Deny from all
379
        Satisfy any
380
        LimitXMLRequestBody 0
381
        SVNPathAuthz off
382
383
        PerlAccessHandler Apache::Authn::Redmine::access_handler
384
        PerlAuthenHandler Apache::Authn::Redmine::authen_handler
385
        AuthType Basic
386
        AuthName "Redmine SVN Repository"
387
388
        Require valid-user
389
        RedmineDSN "DBI:mysql:database=redmine;host=localhost:3306"
390
        RedmineDbUser "redmine"
391 15 Sven Nosse
        RedmineDbPass "very_secret"
392 2 Sven Nosse
393
        # cache max. 50 passwords
394 1 Sven Nosse
        RedmineCacheCredsMax 50
395
</Location>
396 14 Sven Nosse
</pre>
397
398 17 Hung Nguyen Vu
h3. Achievements
399 14 Sven Nosse
400 17 Hung Nguyen Vu
What we've done at this point:
401
* A running Redmine v2.0.3 installation using Apache Passenger
402
* Working authentication with Redmine's builtin database
403
* Working Subversion with Apache's WebDav
404
* Subversion authentication against redmine's builtin database
405 14 Sven Nosse
406
h2. Authentication against Active Directory
407
408
The last step requires some knowledge how to authenticate against your Active directory. First of all, open up Redmine in a web interface and enter the Administration dialogue. Select LDAP-Authentication adn create a new authentication entry.
409
410
* Name: Enter a NAME for your entry, this can be anything... 
411
* Host: Enter the IP address of a domain controler unless you are really sure, that DNS is working correctly
412
* Port: 389
413
* Account: This one is kind of a pitfall. Enter the DN of the user object that can authenticate against the Active Directory.
414
??EXAMPLE??: Assume that you have a domain that is called: mynetwork.local and an organizational unit that is named: myUsers. The DN of this organizational unit is: @OU=myUsers, DC=mynetwork, DC=local@ If you create a user, which Display name is like ??ldap authentication user?? then the Account you need to enter is: @CN=ldap authentication user, OU=myUsers, DC=mynetwork, DC=local@. I'd recommend using a tool like Sysinternals ADExplorer if you are unsure about the distinguished name of your authentication user.
415
* Base DN: This is the entry point, where Redmine tries to find users. In the example above you want to enter: @OU=myUsers, DC=mynetwork, DC=local@
416
* LDAP Filter: You can enter any filter you like here, a valid filter for finding users is: @(&(objectClass=user)(objectCategory=person))@. 
417
* On-the-fly Usercreation: I tend to check this.. This allows the initial creation of a new user when the user logs on redmine.
418
419
Attributes: _(I am not sure, whether the fields below are correctly tranlsated... please correct if necessary)_
420
* member name: sAMAccountName
421
* first name: givenname
422
* surname: sn
423
* E-Mail: mail
424
425
Save it, try it :)
426
427
You should be able to log on with your windows logon name and your windows passwort. If you've never logged on a new account should have been created within the redmine built in database.
428
429
h2. Last step - authenticate Subversion against active directory (by using the built in database from redmine!)
430
431
This one is tricky, you want the authentication data from Active Directory but you also want the group permissions from redmine. So you need to tell the logon mechanism to authenticate against AD and check inside the database, whether the user is SVN editor or not. Finally most of the work is done here with the redmine.pm script (remember, we've linked that already). But unfortunatelly the CentOS Perl implementation includes no module for Simple::LDAP. So we need to do some compiler work... 
432
433
First of all, fetch the packages needed for building the necessary perl module(s).
434
<pre>
435
yum -y install perl-CPAN perl-YAML
436
</pre>
437
438
There are a lot of dependencies when trying to build the module, so I recommend to turn on automatic dependency handling inside the CPAN shell....
439
Start up the shell:
440
<pre>
441
perl -MCPAN -e shell
442
</pre>
443
and then run the following two commands:
444
<pre>
445
o conf prerequisites_policy follow
446
o conf commit
447
</pre>
448
Now it is time, to install the module, still inside the shell. Enter
449
<pre>
450
install Authen::Simple::LDAP
451
</pre>
452
This takes some time... If queried for any dependencies or defaults, just acknowledge them with their default values - this should work.
453
Close the shell after everything is done by entering
454
<pre>
455
exit
456
</pre>
457
458
Now we need to tell Apache where to find the authentication data, this is simple by editing the subversion.conf
459
<pre>
460
vi /etc/httpd/conf.d/subversion.conf
461
</pre>
462
just add the Simple::LDAP Perl module by editing it this way:
463
<pre>
464
   ...
465
   PerlLoadModule Apache::Redmine
466
   PerlLoadModule  Authen::Simple::LDAP
467
   <Location /svn>
468
     DAV svn
469
     ...
470
</pre>
471
472
Restart Apache and LDAP Authentication should work now
473
<pre>
474
service httpd restart
475 2 Sven Nosse
</pre>