Project

General

Profile

HowTo Install Redmine in Ubuntu » History » Version 40

Mohd Shakir Zakaria, 2012-11-13 10:27

1 36 Anonymous
h1. Ubuntu 10.04 or 12.04 using Passenger
2
3
The installation assumes that the web server and database are already in place, so you probably want to install the LAMP stack first if you don't already have it:
4
5
> $ sudo tasksel install lamp-server
6
7
You will also need to install the Passenger apache module.
8
9
> $ sudo apt-get install libapache2-mod-passenger
10
11
Also, the default AppArmor configuration can get in the way, so you may need to set the mysqld profile to complain:
12
13
> $ sudo aa-complain /usr/sbin/mysqld
14
15
h2. Installing Redmine 0.9.3 (Ubuntu 10.04) or Redmine 1.3.2 (Ubuntu 12.04)
16
17
As of 10.04 and 12.04, Redmine is available through Ubuntu's package manager, and installation is simple:
18
19 38 Yu Kobayashi
> $ sudo apt-get install redmine redmine-mysql
20 36 Anonymous
21
The second package, _redmine-mysql_, can be replaced by either _redmine-pgsql_ or _redmine-sqlite_ if you want to use either of those databases.
22
23
The installation process should prompt you for all the interesting details.
24
25
Redmine will now be installed in @/usr/share/redmine@ and @/etc/redmine@
26
27
h2. Installing the latest Redmine
28
29
The package with Ubuntu 10.04 is stuck in the 0.9.x branch and Ubuntu 12.04 is stuck in the 1.3.x branch. A PPA exists that has the latest branch here: https://launchpad.net/~ondrej/+archive/redmine
30
31
To install redmine using the PPA:
32
33 38 Yu Kobayashi
> $ sudo add-apt-repository ppa:ondrej/redmine
34
> $ sudo apt-get update
35
> $ sudo apt-get install redmine redmine-mysql
36 36 Anonymous
37
Note: If your server is behind a firewall, you will need to export your firewall settings before running @add-apt-repository@. Otherwise, the command will hang.
38
Run the following <pre>export http_proxy="http://proxy.your.server:port" and export https_proxy="http:proxy.your.server:port".</pre>
39
40
h2. Configuration
41
42
Symlink @/usr/share/redmine/public@ to your desired web-accessible location. E.g.:
43
44
> $ sudo ln -s /usr/share/redmine/public /var/www/redmine
45
46
By default, passenger runs as 'nobody', so you'll need to fix that. In @/etc/apache2/mods-available/passenger.conf@, add:
47
48 38 Yu Kobayashi
<pre>PassengerDefaultUser www-data</pre>
49 36 Anonymous
50
You'll also need to configure the @/var/www/redmine@ location in @/etc/apache2/sites-available/default@ by adding:
51
52
<pre><Directory /var/www/redmine>
53
RailsBaseURI /redmine
54
PassengerResolveSymlinksInDocumentRoot on
55
</Directory>
56
</pre>
57
58
If you set your AppArmor mysqld profile to complain you ought to set it back to enforce:
59
60
> $ sudo aa-enforce /usr/sbin/mysqld
61
62
Enable passenger:
63
64
> $ sudo a2enmod passenger
65
66
Restart apache2
67
68
> $ sudo service apache2 restart
69
70
and you should be able to access Redmine at: http://redmine.server.ip.address/redmine
71
72
If you receive a "403: Forbidden" error after setting up Redmine, the Redmine 'public' folder may have incorrect permissions set. The executable bit on the public folder must be enabled or you will receive a "403: Forbidden" error when attempting to access Redmine.
73
74
> $ sudo chmod a+x /usr/share/redmine/public
75
76
h1. Ubuntu 10.04 or 12.04 using WEBrick
77
78
Using Passenger is recommended for the heavy load server. But WEBrick uses less memory.
79
80 39 Yu Kobayashi
Install Redmine: (See also _Installing the latest Redmine_ above)
81 38 Yu Kobayashi
82
> $ sudo apt-get install redmine redmine-mysql
83 36 Anonymous
84
Then, create this for /etc/init/redmine.conf
85
86
<pre>
87
# Redmine
88
89
description "Redmine"
90
91
start on runlevel [2345]
92
stop on runlevel [!2345]
93
94
expect daemon
95
exec ruby /usr/share/redmine/script/server webrick -e production -b 0.0.0.0 -d
96
</pre>
97
98
You can start Redmine by this. You can access by http://example.com:3000/
99
100
> $ sudo service redmine start
101
102
You can stop by this.
103
104
> $ sudo service redmine stop
105
106
h1. Ubuntu 10.04 using mod_cgi
107
108
The installation assumes that the web server and database are already in place, so you probably want to install the LAMP stack first if you don't already have it:
109
110
> $ sudo tasksel install lamp-server
111
112
Also, the default AppArmor configuration can get in the way, so you may need to set the mysqld profile to complain:
113
114
> $ sudo aa-complain /usr/sbin/mysqld
115
116
As of 10.04, Redmine is available through Ubuntu's package manager, and installation is simple:
117
118
> $ sudo apt-get install redmine redmine-mysql subversion
119
120
The second package, _redmine-mysql_, can be replaced by either _redmine-pgsql_ or _redmine-sqlite_ if you want to use either of those databases.
121
122
The installation process should prompt you for all the interesting details.
123
124
Redmine will now be installed in @/usr/share/redmine@ and @/etc/redmine@
125
126
If you set your AppArmor mysqld profile to complain you ought to set it back to enforce:
127
128
> $ sudo aa-enforce /usr/sbin/mysqld
129
130
h2. Configuration
131
132
> *Using Ubuntu Server 10.04.1, configuring Redmine via mod_cgi as described in this section does not seem to work. If you can successfully make this work, please update these instructions! Otherwise follow the instructions in the next section for installing on Ubuntu 10.04 using Passenger or WEBrick if mod_cgi does not work for you.*
133
134
Symlink @/usr/share/redmine/public@ to your desired web-accessible location. E.g.:
135
136
> $ sudo ln -s /usr/share/redmine/public /var/www/redmine
137
138
The other files that you need to modify/create are as follows:
139
140
@/etc/redmine/default/database.yml@:
141
142
<pre>
143
production:
144
adapter: mysql
145
database: redmine
146
host: localhost
147
username: redmine
148
password: pa55w0rd
149
encoding: utf8
150
</pre>
151
152
@/usr/share/redmine/public/dispatch.cgi@:
153
154
<pre>
155
#!/usr/bin/ruby
156
157
require File.dirname(__FILE__) + "/../config/environment" unless defined?(RAILS_ROOT)
158
159
require "dispatcher"
160
161
ADDITIONAL_LOAD_PATHS.reverse.each { |dir| $:.unshift(dir) if File.directory?(dir) } if defined?(Apache::RubyRun)
162
Dispatcher.dispatch
163
</pre>
164
165
@/usr/share/redmine/public/.htaccess@:
166
167
<pre>
168
RewriteEngine On
169
RewriteBase /redmine
170
RewriteRule ^$ index.html [QSA]
171
RewriteRule ^([^.]+)$ $1.html [QSA]
172
RewriteCond %{REQUEST_FILENAME} !-f
173
RewriteRule ^(.*)$ dispatch.cgi [QSA,L]
174
</pre>
175
176
And that's it! If these instructions didn't work for you, please expand them to include whatever is needed.
177
178
h1. Redmine Installation on Virtual or Normal Ubuntu < 10.04
179
180
This page is a guide to installing Redmine on either a virtual or actual installation of the Ubuntu operating system. If you follow all instructions correctly you will have installed your Redmine server successfully in almost an hour.
181
182
h2. Step 1: Install Ubuntu
183
184
If you are installing on a non-virtual Ubuntu instance, please skip this section.
185
186
*Installing VirtualBox:*
187
188
1.Download the latest version of Sun VirtualBox (version 3.0.10 or newer).
189
2.Install VirtualBox by following the instructions.
190
191
*Installing Ubuntu on VirtualBox:*
192
193
1.Download the latest version of Ubuntu (version 9.10 or newer).
194
2.After installing VirtualBox you will create a new virtual operating which will be Linux type and Ubuntu subtype. If you don't know anything about VirtualBox and/or its usage please refer to Google.
195
196
3.While installing Ubuntu you should enter the following configuration:
197
(This suggested configuration is optional, you can enter any names you want.)
198
Q: What is your name? A: Redmine Server
199
Q: What name do you want to use to login? A: redmine
200
Q: Choose to password to keep your account safe? A: redmine
201
Q: What is the name of this computer? A: redmine-server
202
Choose “Log in automatically.” radio button.
203
204
4.When you've finished the installation, open up your new VirtualBox Ubuntu OS and open up a terminal (console) screen and issue these commands:
205
> sudo apt-get update
206
> sudo apt-get upgrade
207
208
*Configuring VirtualBox:*
209
210
1.If you want to reach your VirtualBox Ubuntu OS from a different machine, you have to configure VirtualBox Ubuntu OS's network settings to Bridged Adapter. So you can reach your VirtualBox Ubuntu from an internal IP address easily. Because it get's the same IP block as you from DHCP easily. I mean your guest and host computer is same IP block as different network client.
211
212
2.If you had assigned a static IP to your Network Consult by giving your static ethernet MAC address, you have to assign the unique MAC address your VirtualBox Ubuntu OS by Setting->Network->MAC address initialization box. By this MAC address, you can get a static IP easily or you can configure your Ubuntu system to not use DHCP, instead of that you can assign a static IP manually.
213
214
h2. Step 2: Install Redmine
215
216
Once you have a functioning Ubuntu operating system up and running, you can continue with installing Redmine.
217
218
h3. Install dependencies
219
220
The following packages are required to install and run Redmine. Please install them by running @apt-get@ as root:
221
222
>sudo apt-get install package-name
223
224
where @package-name@ is each of:
225
* apache2
226
* apache2-threaded-dev
227
* build-essential
228
* libapache-dbi-perl
229
* libapache2-mod-perl2
230
* libapache2-svn
231
* libdigest-sha1-perl
232
* libgemplugin-ruby
233
* libgemplugin-ruby1.8
234
* libruby-extras
235
* libruby1.8-extras
236
* mongrel
237
* mysql-server
238
* rails
239
* rake
240
* ruby
241
* rubygems
242
* rubygems1.8
243
* ruby1.8-dev
244
* subversion
245
246
_(Could someone please clean up this list?)_
247
248
h3. Package Installation and Setup
249
250
1.Once you’ve installed the VirtualBox Ubuntu OS and updated it, you need to install a bunch of packages that we will prepare the server for the Redmine installation. So, as root, install the following packages by issuing:
251
> sudo apt-get install
252
> sudo apt-get install
253
(_Surely some missing package names above?_)
254
255
The packages we’re installing above are MySQL, phpMyAdmin, Rails, Ruby Gems, Mongrel and Ruby Dev environment.
256
During the installation of the packages, when MySQL is installed, it will prompt you to create a password. Make sure you remember it. You will need it later to log in to phpMyAdmin. To make things simple you can set all passwords to “redmine”.
257
258
2.Create a new directory for Redmine. I put mine in /opt/redmine. And download the latest version of Redmine in to it with the wget command line downloader and extract it by issuing:
259
> sudo mkdir /opt/redmine
260
> sudo cd /opt/redmine
261
> sudo wget http://rubyforge.org/frs/download.php/66633/redmine-0.8.6.tar.gz
262
> tar -xvf redmine-0.8.6.tar.gz
263
264
h3. Database Setup
265
266
1.Now it’s time to create an empty database for Redmine. As you may have noticed, we installed phpMyAdmin earlier. phpMyAdmin will come in handy now. Head over to http://localhost/phpmyadmin. You should be presented with the phpMyAdmin login screen.
267
Type in “root” and the MySQL “password” you created when installing MySQL.
268
269
2.First, click on “Databases” then, at the bottom of the screen, in the “Create new database” text box create a new database called “redmine” and set “Collation” to “utf8_general_ci”.
270
271
3.Now, go back to the home screen and click on:
272
“Privileges”
273
“Add a new User”
274
Fill out the “Login Information” boxes. Call your user “redmine”. Make sure you remember password you create here. It will be used when you set up the database connection details in Redmine.
275
In the “Database for user” section, check “Create database with same name and grant all privileges” and click on the “Go” button.
276
277
4.Log out of phpMyAdmin.
278
279
h3. Redmine Database Connection Configuration
280
281
1.It’s time to configure the database connection. If you installed Redmine as I did above, then copy “config/database.yml.example” to “config/database.yml” and edit this file in order to configure your database settings for “production” environment. You’ll find the “database.yml.example” issuing:
282
> sudo cd /opt/redmine/redmine-0.8.6/config
283
284
2.So now, assuming you’re in the “/opt/redmine/redmine-0.8.6/config” directory, issue:
285
> sudo cp database.yml.example database.yml
286
287
3.Then, open the “database.yml” file, issue:
288
> sudo gedit database.yml
289
… and edit it as in the example for a MySQL database below:
290
291
production:
292
adapter: mysql
293
socket: /var/run/mysqld/mysqld.sock
294
database: redmine
295
host: localhost
296
username: redmine
297
password: [password]
298
299
Then save the “database.yml” file and exit to the command prompt.
300
On Ubuntu the “mysql.sock” is located in /var/run/mysqld/mysqld.sock, as noted in the “config” above.
301
(The standard Redmine installation assumes the socket is located in “/opt/redmine/redmine-0.8.6/tmp/mysqld.sock”.)
302
303
4.Create the database structure, by running the following command under the application root directory (I mean “/opt/redmine/redmine-0.8.6”):
304
> sudo rake db:migrate RAILS_ENV="production"
305
It will create the necessary tables in the redmine database you created earlier and an administrator account.
306
307
5.Insert the default configuration data in to the database, by issuing:
308
> sudo rake redmine:load_default_data RAILS_ENV="production"
309
(This step is optional but highly recommended, as you can define your own configuration from scratch. It will load default roles, trackers, statuses, work flows and enumerations. While loading default data command prompt wants to given language selection by you.)
310
311
h3. Setting up Permissions
312
313
1.The user who runs Redmine must have write permission on the following sub directories: “files”, “log”, “tmp” (create the last one if not present). You probably already have a “tmp” directory in /opt/redmine/redmine-0.8.6, but if you don’t, create one now by issuing:
314
> sudo mkdir /opt/redmine/redmine-0.8.6
315
316
2.If you haven’t created a Redmine user, do it now by issuing:
317
> sudo useradd redmine
318
319
3.Now, assuming you run Redmine with a redmine user, from your /opt/redmine/redmine-0.8.6 directory issue:
320
> sudo chown -R redmine:redmine files log tmp
321
> sudo chmod -R 755 files log tmp
322
323
h3. Testing the Installation
324
325
1.It should all be working now. Test the installation by running the WEBrick web server issue:
326
> sudo cd /opt/redmine/redmine-0.8.6
327
> sudo ruby script/server -e production
328
329
Once WEBrick has started, point your browser to http://localhost:3000/. Or, if you are using a browser on a computer other than the one you installed Redmine on, point your browser to http://192.168.1.10:3000/ (if that’s the IP address you gave your Redmine server). You should now see the application welcome page.
330
331
*Log in:*
332
333
1.Use default administrator account to log in:
334
Login : admin
335
Password : admin
336
337
2.You can go to Admin & Settings to modify application settings.
338
339
h3. Setting Up Static IP
340
341
1.An easier method for configuring a static IP address is to use your local DHCP server to assign a permanent IP to the VirtualBox OS mac address. That way you will not have to do anything inside VBS. Consult your network administrator.
342
343
2.Or you should determine the configuration parameters given below, and then you can configure your system to have a static IP address:
344
The desired IP address
345
Network mask and broadcast address
346
Gateway address
347
Your local DNS server address(es)
348
349
h3. Assigning Host Name and Domain for VirtualBox OS
350
351
1.An easier method for adding your IP address - Host name pair configuration to your DNS server . Consult your network administrator.
352
353
h2. Configuring the Passenger Apache module
354
355
Passenger is a module for apache2 that allows Apache to run Ruby on Rails applications. Install it thus:
356
357
>$ sudo gem install passenger
358
359
Then go to the passenger apache2 module installation directory and run @passenger-install-apache2-module@
360
361
> $ cd /var/lib/gems/1.X/gems/passenger-X.X.X/
362
363
> $ sudo bin/passenger-install-apache2-module
364
365
Next, configure Apache:
366
367
In /etc/apache2/mods-available/passenger.load we will add next line
368
369
> LoadModule passenger_module /var/lib/gems/1.X/gems/passenger-X.X.X/ext/apache2/mod_passenger.so
370
371
We have to edit the conf of the passenger apache2 module in /etc/apache2/mods-available/passenger.conf
372
373
> PassengerRoot /var/lib/gems/1.X/gems/passenger-X.X.X
374
> PassengerRuby /usr/bin/ruby1.X
375
376
And now we activate the module
377
378
> $ sudo a2enmod passenger
379
380
Apache virtualhost for redmine web app
381
382
<pre>
383
<VirtualHost *:80>
384
ServerName redmine.server.com
385
386
DocumentRoot /var/www/redmine/public
387
388
ServerAdmin user@server.com
389
LogLevel warn
390
ErrorLog /var/log/apache2/redmine_error
391
CustomLog /var/log/apache2/redmine_access combined
392
393
<Directory /var/www/redmine/public>
394
Options Indexes FollowSymLinks MultiViews
395
AllowOverride None
396
Order allow,deny
397
allow from all
398
</Directory>
399
</VirtualHost>
400
</pre>
401
402
subversion server config in apache
403
404
<pre>
405
<VirtualHost *:80>
406
ServerName svn.server.com
407
ServerAdmin user@server.com
408
ErrorLog /var/log/apache2/svn_error
409
CustomLog /var/log/apache2/svn_access combined
410
<Location /project>
411
DAV svn
412
SVNPath /var/lib/svn/project
413
414
AuthType Basic
415
AuthName "Trac system for Server projects"
416
AuthUserFile "/var/lib/svn/.htpasswd"
417
Require valid-user
418
<LimitExcept GET PROPFIND OPTIONS REPORT>
419
Require valid-user
420
</LimitExcept>
421
</Location>
422
</Virtualhost>
423
</pre>
424
425
h2. Sendmail Server Configuration
426
427
1.Before configuring email support for Redmine, we should download the sendmail application for Ubuntu, issue:
428
429
> sudo apt-get install sendmail
430
431
> sudo sendmailconfig
432
433
(Answer Yes to all questions which you will be asked)
434
435
2.It’s time to configure the server connection. Copy “config/email.yml.example” to “config/email.yml” and edit this file in order to configure your database settings for “production” environment. You’ll find the “email.yml.example” issue:
436
> sudo cd /opt/redmine/redmine-0.8.6/config
437
438 37 João Lencart e Silva
439
440 36 Anonymous
3.So now, assuming you’re in the “/config” directory, issue:
441
> sudo cp email.yml.example email.yml
442
443
4.Then, open the “email.yml” file, issue:
444
> sudo gedit email.yml
445
… and edit it as in the example for sendmail configuration below:
446
447
production:
448
delivery_method: :sendmail
449
sendmail_settings:
450
location: /usr/sbin/sendmail
451
arguments: -i -t
452
address: smtp.example.net
453
port: 25
454
domain: example.net
455
authentication: :none
456
user_name: redmine@example.net
457
password: redmine
458
459
Then save “email.yml” file and exit to the command prompt.
460
461
5.It’s time to configure the “environmet.rb” configuration. Open up the “environment.rb” and change “config.action_mailer.perform_deliveries = false” to “config.action_mailer.perform_deliveries = true” then save and close the “environment.rb”.
462 37 João Lencart e Silva
463
h2. Email configuration for Ubuntu 12.04 with redmine >v1.4.3
464
465
1. Instead of creating an email.yml, edit config/configuration.yml and add a section
466
<pre>
467
production:
468
   email_delivery:
469
     delivery_method: :smtp
470
...</pre>
471
472
or
473
474
<pre>production:
475
   email_delivery:
476
     delivery_method: :sendmail
477
...</pre>
478
479
Please see http://www.redmine.org/projects/redmine/wiki/EmailConfiguration for the correct format of the full email block.
480
481
2. **DO NOT CHANGE** environment.rb config.action_mailer.perform_deliveries. The correct way is changing configuration.yml and leaving the default config.action_mailer.perform_deliveries setting to false:
482
@config.action_mailer.perform_deliveries = false@
483
484
485
486
487 36 Anonymous
488
h2. Subversion Installation and Configuration
489
490
1.Before configuring Subversion support for Redmine, we should download the Subversion application for Ubuntu, issue:
491
> sudo apt-get install subversion
492
493
2.If your Redmine can't find the “subversion” command you can help to find by issuing:
494
· > sudo cd /opt/redmine/redmine-0.8.6/config
495
· > sudo gedit environment.rb
496
· Add ENV['PATH'] = "#{ENV['PATH']}:/subversion/path" line in it.
497
· Save and close the “environment.rb”
498
499
h2. Start Application at Boot Time
500
501
1.To automatically start the application on booting your server you need to modify your “crontab”, issue:
502
> export EDITOR=gedit
503
> crontab -e
504
505
2.Your “crontab” file will be presented. This is the list of programs that start at certain times or at boot. Add the following to the “crontab” (all on one line):
506
@reboot cd /opt/redmine/redmine-0.8.6 ; rm -f log/mongrel.pid ; mongrel_rails start -e production -p 3000 -d
507
508
h2. Backup
509
510
1.Running backups is always a good idea. Redmine backups should include:
511
* data (stored in your redmine database)
512
/usr/bin/mysqldump -u -p | gzip > /path/to/redmine/backup/db/redmine_`date +%y_%m_%d`.gz
513
* attachments (stored in the files directory of your Redmine install)
514
rsync -a /path/to/redmine/files /path/to/redmine/backup/files
515
516
2.Or you can use the bash shell to automate this kind of operation, issue:
517
> sudo cd /opt/redmine/redmine-0.8.6
518
> sudo mkdir backup
519
> sudo mkdir backup/db
520
> sudo mkdir backup/files
521
> sudo gedit backup/runRedmineBackup.bash
522
523
And after open “runRedmineBackup.bash” with gedit, write all commands below:
524
<pre>
525
#!/bin/bash
526
data=`date -I`
527
mysqldump --user=root --password="redmine" --all-databases | gzip > db/backup-$data.sql.gz
528
cd db
529
ftp -i -n << EOF
530
open ftpserver.example.net
531
user username password
532
bin
533
mput backup-$data.sql.gz
534
bye
535
EOF
536
</pre>
537
Then save the “runRedmineBackup.bash” file and exit to the command prompt. After creation of runRedmineBackup.bash you can add this bash script to run continually between specified periods. Issue:
538
539
> export EDITOR=gedit
540
> crontab -e
541
Add 0 0 * * 0 cd /opt/redmine/redmine-0.8.6/backup ; sh runRedmineBackup.bash commands to crontab to backup database weekly.
542
543
For this to work without any permission problems you have to change the permissions of the files to maximum, issue:
544
545
> sudo chmod -R 777 backup
546
> sudo chown -R redmine:redmine backup
547
548
That's all. Now we have completely installed Redmine on our virtual Ubuntu OS and can reach it from any machine in our network easily. Congratulations..!
549
550
h2. Sources & contributors.
551
552
* Ümit Uzun 06/11/2009.
553
* Some of the above material comes from Macada's wiki, licenced under the GNU Free Documentation License 1.2. See "Redmine in Ubuntu Jaunty 9.04":http://wiki.ousli.org/index.php/Redmine_in_Ubuntu_Jaunty_9.04 by David 'macada', last modified 2010-02-08, accessed 2010-05-26.
554
* Sam Wilson 2010-05-26, formatting changes.
555
* Allen Yeh 2010-09-08, Added apt-get install subversion into instructions for 10.04 otherwise once redmine is setup an error like this will result this error -> +*The entry or revision was not found in the repository.*+
556
557
h2. Additional Sources
558
559 40 Mohd Shakir Zakaria
* http://docs.oseems.com/general/web/redmine/install-in-ubuntu