Project

General

Profile

HowTo Install Redmine in Ubuntu » History » Version 21

Graham King, 2011-01-24 19:42
Grammar police, extremely minor edits

1 6 Roger Lipscombe
h1. Ubuntu 10.4 LTS using mod_cgi
2 3 Sam Wilson
3 7 Mischa The Evil
{{>toc}}
4
5 14 allen yeh
As of 10.04, Redmine is available through Ubuntu's package manager, and installation is simple:
6 3 Sam Wilson
7 14 allen yeh
> $ sudo apt-get install redmine redmine-mysql subversion
8 3 Sam Wilson
9
The second package, _redmine-mysql_, can be replaced by either _redmine-pgsql_ or _redmine-sqlite_ if you want to use either of those databases.
10
11
Redmine will now be installed in @/usr/share/redmine@ and @/etc/redmine@
12
13
h2. Configuration
14
15 17 Tim M
> 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 if mod_cgi does not work for you.
16
17 3 Sam Wilson
Symlink @/usr/share/redmine/public@ to your desired web-accessible location.  E.g.:
18
19 19 Peter Hobor
> $ sudo ln -s /usr/share/redmine/public /var/www/redmine
20 3 Sam Wilson
21
The other files that you need to modify/create are as follows:
22
23 13 allen yeh
@/etc/redmine/default/database.yml@:
24 3 Sam Wilson
25
<pre>
26
production:
27
  adapter: mysql
28
  database: redmine
29
  host: localhost
30
  username: redmine
31
  password: pa55w0rd
32
  encoding: utf8
33
</pre>
34
35 12 Rolf Wojtech
@/usr/share/redmine/public/dispatch.cgi@:
36 3 Sam Wilson
37
<pre>
38
#!/usr/bin/ruby
39
40
require File.dirname(__FILE__) + "/../config/environment" unless defined?(RAILS_ROOT)
41
42
require "dispatcher"
43
44
ADDITIONAL_LOAD_PATHS.reverse.each { |dir| $:.unshift(dir) if File.directory?(dir) } if defined?(Apache::RubyRun)
45
Dispatcher.dispatch
46
</pre>
47
48 4 Sam Wilson
@/usr/share/redmine/public/.htaccess@:
49 3 Sam Wilson
50
<pre>
51
RewriteEngine On
52
RewriteBase /redmine
53
RewriteRule ^$ index.html [QSA]
54
RewriteRule ^([^.]+)$ $1.html [QSA]
55
RewriteCond %{REQUEST_FILENAME} !-f
56
RewriteRule ^(.*)$ dispatch.cgi [QSA,L]
57
</pre>
58
59
And that's it!  If these instructions didn't work for you, please expand them to include whatever is needed.
60 1 Umit Uzun
61 14 allen yeh
h1. Ubuntu 10.04 using Passenger
62 6 Roger Lipscombe
63
If you can't get it working with mod_cgi, you might want to try mod_passenger (it's also quicker):
64 5 Roger Lipscombe
65 14 allen yeh
> $ sudo apt-get install redmine redmine-mysql subversion
66 5 Roger Lipscombe
67
The second package, _redmine-mysql_, can be replaced by either _redmine-pgsql_ or _redmine-sqlite_ if you want to use either of those databases.
68
69
Ubuntu should prompt you for all the interesting details.
70
71
Redmine will now be installed in @/usr/share/redmine@ and @/etc/redmine@
72
73
h2. Configuration
74
75
Symlink @/usr/share/redmine/public@ to your desired web-accessible location.  E.g.:
76
77 20 Peter Hobor
> $ sudo ln -s /usr/share/redmine/public /var/www/redmine
78 5 Roger Lipscombe
79
By default, passenger runs as 'nobody', so you'll need to fix that. In @/etc/apache2/mods-available/passenger.conf@, add a @PassengerDefaultUser www-data@ directive.
80
81
You'll also need to configure the @/var/www/redmine@ location in @/etc/apache2/sites-available/default@:
82
83
<pre><Directory /var/www/redmine>
84
    RailsBaseURI /redmine
85 15 Spenser Gilliland
    PassengerResolveSymlinksInDocumentRoot on
86 5 Roger Lipscombe
</Directory>
87
</pre>
88
89
> $ sudo a2enmod passenger
90
91
Restart apache2 and you should be good to go.
92 17 Tim M
93
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.
94
95
> $ sudo chmod a+x /usr/share/redmine/public
96 5 Roger Lipscombe
97 14 allen yeh
h1. Redmine Installation on Virtual or Normal Ubuntu < 10.04
98 1 Umit Uzun
99 21 Graham King
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.
100 1 Umit Uzun
101 2 Sam Wilson
h2. Step 1: Install Ubuntu
102 1 Umit Uzun
103 2 Sam Wilson
If you are installing on a non-virtual Ubuntu instance, please skip this section.
104 1 Umit Uzun
105 2 Sam Wilson
*Installing VirtualBox:*
106
107 21 Graham King
1.Download the latest version of Sun VirtualBox (version 3.0.10 or newer).
108
2.Install VirtualBox by following the instructions.
109 1 Umit Uzun
110
*Installing Ubuntu on VirtualBox:*
111
112 21 Graham King
1.Download the latest version of Ubuntu (version 9.10 or newer).
113
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.
114 1 Umit Uzun
115 21 Graham King
3.While installing Ubuntu you should enter the following configuration:
116
(This suggested configuration is optional, you can enter any names you want.)
117 1 Umit Uzun
Q: What is your name? A: Redmine Server
118
Q: What name do you want to use to login? A: redmine
119
Q: Choose to password to keep your account safe? A: redmine
120
Q: What is the name of this computer? A: redmine-server
121
Choose “Log in automatically.” radio button.
122
123 21 Graham King
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:
124 1 Umit Uzun
> sudo apt-get update
125
> sudo apt-get upgrade
126
127
*Configuring VirtualBox:*
128
129 21 Graham King
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.
130 1 Umit Uzun
131 21 Graham King
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.
132 1 Umit Uzun
133 2 Sam Wilson
h2. Step 2: Install Redmine
134 1 Umit Uzun
135 2 Sam Wilson
Once you have a functioning Ubuntu operating system up and running, you can continue with installing Redmine.
136 1 Umit Uzun
137 2 Sam Wilson
h3. Install dependencies
138
139
The following packages are required to install and run Redmine.  Please install them by running @apt-get@ as root:
140
141
>sudo apt-get package-name
142
143
where @package-name@ is each of:
144
* apache2 
145
* apache2-threaded-dev 
146
* build-essential
147
* libapache-dbi-perl 
148
* libapache2-mod-perl2 
149
* libapache2-svn
150
* libdigest-sha1-perl 
151
* libgemplugin-ruby 
152
* libgemplugin-ruby1.8 
153
* libruby-extras 
154
* libruby1.8-extras 
155
* mongrel 
156
* mysql-server
157
* rails
158
* rake 
159
* ruby
160
* rubygems
161
* rubygems1.8
162 1 Umit Uzun
* ruby1.8-dev
163 2 Sam Wilson
* subversion
164 1 Umit Uzun
165
_(Could someone please clean up this list?)_
166 2 Sam Wilson
167
h3. Package Installation and Setup
168 16 Ian Epperson
169 1 Umit Uzun
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: 
170
> sudo apt-get install 
171 2 Sam Wilson
> sudo apt-get install 
172 21 Graham King
(_Surely some missing package names above?_)
173 1 Umit Uzun
174
The packages we’re installing above are MySQL, phpMyAdmin, Rails, Ruby Gems, Mongrel and Ruby Dev environment.
175 21 Graham King
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”.
176 1 Umit Uzun
177 21 Graham King
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:
178 1 Umit Uzun
> sudo mkdir /opt/redmine
179
> sudo cd /opt/redmine
180
> sudo wget http://rubyforge.org/frs/download.php/66633/redmine-0.8.6.tar.gz
181
> tar -xvf redmine-0.8.6.tar.gz
182
183 16 Ian Epperson
h3. Database Setup
184 1 Umit Uzun
185
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.
186
Type in “root” and the MySQL “password” you created when installing MySQL.
187
188 21 Graham King
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”.
189 1 Umit Uzun
190
3.Now, go back to the home screen and click on:
191
“Privileges”
192
“Add a new User” 
193
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.
194
In the “Database for user” section, check “Create database with same name and grant all privileges” and click on the “Go” button.
195
196
4.Log out of phpMyAdmin.
197
198 16 Ian Epperson
h3. Redmine Database Connection Configuration
199 1 Umit Uzun
200
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:
201
> sudo cd /opt/redmine/redmine-0.8.6/config
202
203
2.So now, assuming you’re in the “/opt/redmine/redmine-0.8.6/config” directory, issue:
204
> sudo cp database.yml.example database.yml 
205
206
3.Then, open the “database.yml” file, issue:
207
> sudo gedit database.yml
208
… and edit it as in the example for a MySQL database below:
209
210
production:
211
adapter: mysql
212
socket: /var/run/mysqld/mysqld.sock
213
database: redmine
214
host: localhost
215
username: redmine
216
password: [password]
217
218 21 Graham King
Then save the “database.yml” file and exit to the command prompt.
219 1 Umit Uzun
On Ubuntu the “mysql.sock” is located in /var/run/mysqld/mysqld.sock, as noted in the “config” above. 
220
(The standard Redmine installation assumes the socket is located in “/opt/redmine/redmine-0.8.6/tmp/mysqld.sock”.)
221
222 21 Graham King
4.Create the database structure, by running the following command under the application root directory (I mean “/opt/redmine/redmine-0.8.6”):
223 1 Umit Uzun
> sudo rake db:migrate RAILS_ENV="production" 
224 21 Graham King
It will create the necessary tables in the redmine database you created earlier and an administrator account.
225 1 Umit Uzun
226 21 Graham King
5.Insert the default configuration data in to the database, by issuing:
227 1 Umit Uzun
> sudo rake redmine:load_default_data RAILS_ENV="production" 
228 21 Graham King
(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.) 
229 1 Umit Uzun
230 16 Ian Epperson
h3.  Setting up Permissions
231 1 Umit Uzun
232
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:
233
> sudo mkdir /opt/redmine/redmine-0.8.6
234
235
2.If you haven’t created a Redmine user, do it now by issuing:
236
> sudo useradd redmine
237
238
3.Now, assuming you run Redmine with a redmine user, from your /opt/redmine/redmine-0.8.6 directory issue:
239
> sudo chown -R redmine:redmine files log tmp
240
> sudo chmod -R 755 files log tmp
241
242 16 Ian Epperson
h3.  Testing the Installation
243 1 Umit Uzun
244
1.It should all be working now. Test the installation by running the WEBrick web server issue:
245
> sudo cd /opt/redmine/redmine-0.8.6
246
> sudo ruby script/server -e production
247
	
248 21 Graham King
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. 
249 1 Umit Uzun
250
*Log in:*
251
252
1.Use default administrator account to log in:
253
Login : admin
254
Password : admin
255
256
2.You can go to Admin & Settings to modify application settings.
257
258 16 Ian Epperson
h3.  Setting Up Static IP
259 1 Umit Uzun
260 21 Graham King
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. 
261 1 Umit Uzun
262 21 Graham King
2.Or you should determine the configuration parameters given below, and then you can configure your system to have a static IP address:
263 1 Umit Uzun
The desired IP address
264
Network mask and broadcast address
265
Gateway address
266
Your local DNS server address(es)
267
268 16 Ian Epperson
h3.  Assigning Host Name and Domain for VirtualBox OS
269 1 Umit Uzun
270 21 Graham King
1.An easier method for adding your IP address - Host name pair configuration to your DNS server . Consult your network administrator.
271 1 Umit Uzun
272 2 Sam Wilson
h2. Configuring the Passenger Apache module
273 1 Umit Uzun
274 21 Graham King
Passenger is a module for apache2 that allows Apache to run Ruby on Rails applications.  Install it thus:
275 2 Sam Wilson
276
>$ sudo gem install passenger
277
278
Then go to the passenger apache2 module installation directory and run @passenger-install-apache2-module@
279
280
> $ cd /var/lib/gems/1.X/gems/passenger-X.X.X/
281
282
> $ sudo bin/passenger-install-apache2-module
283
284
Next, configure Apache:
285
286
In /etc/apache2/mods-available/passenger.load we will add next line
287
288
> LoadModule passenger_module /var/lib/gems/1.X/gems/passenger-X.X.X/ext/apache2/mod_passenger.so
289
290
We have to edit the conf of the passenger apache2 module in /etc/apache2/mods-available/passenger.conf
291
292
> PassengerRoot /var/lib/gems/1.X/gems/passenger-X.X.X
293
> PassengerRuby /usr/bin/ruby1.X
294
295 21 Graham King
And now we activate the module
296 2 Sam Wilson
297
> $ sudo a2enmod passenger
298
299
Apache virtualhost for redmine web app
300
301
<pre>
302
    <VirtualHost *:80>
303
        ServerName redmine.server.com
304
305
        DocumentRoot /var/www/redmine/public
306
307
        ServerAdmin user@server.com
308
        LogLevel warn
309
        ErrorLog /var/log/apache2/redmine_error
310
        CustomLog /var/log/apache2/redmine_access combined
311
312
        <Directory /var/www/redmine/public>
313
            Options Indexes FollowSymLinks MultiViews
314
            AllowOverride None
315
            Order allow,deny
316
            allow from all
317
        </Directory>
318
    </VirtualHost>
319
</pre>
320
321 1 Umit Uzun
subversion server config in apache
322
323 2 Sam Wilson
<pre>
324
    <VirtualHost *:80>
325
	ServerName svn.server.com
326
	ServerAdmin user@server.com
327
	ErrorLog /var/log/apache2/svn_error
328
       	CustomLog /var/log/apache2/svn_access combined
329
        <Location /project>
330
           DAV svn
331
           SVNPath /var/lib/svn/project
332
333
           AuthType Basic
334
           AuthName "Trac system for Server projects"
335
           AuthUserFile "/var/lib/svn/.htpasswd"
336
           Require valid-user 
337
	   <LimitExcept GET PROPFIND OPTIONS REPORT>
338
               Require valid-user
339
           </LimitExcept>
340
       </Location>
341
    </Virtualhost>
342
</pre>
343
344 16 Ian Epperson
h2. Sendmail Server Configuration
345 2 Sam Wilson
346 21 Graham King
1.Before configuring email support for Redmine, we should download the sendmail application for Ubuntu, issue:
347 1 Umit Uzun
> sudo apt-get install sendmail
348 21 Graham King
> sudo sendmailconfig (Answer Yes to all questions which you will be asked)
349 1 Umit Uzun
350
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:
351
> sudo cd /opt/redmine/redmine-0.8.6/config
352
353
3.So now, assuming you’re in the “/config” directory, issue:
354
> sudo cp email.yml.example email.yml 
355
356
4.Then, open the “email.yml” file, issue:
357
> sudo gedit email.yml
358
… and edit it as in the example for sendmail configuration below:
359
360
production:
361
delivery_method: :sendmail
362
sendmail_settings:
363
location: /usr/sbin/sendmail
364
arguments: -i -t
365
address: smtp.example.net
366
port: 25
367
domain: example.net
368
authentication: :none
369
user_name: redmine@example.net
370
password: redmine
371
372
Then save “email.yml” file and exit to the command prompt.
373
374
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”.
375
376
h2.  Subversion Installation and Configuration
377
378 21 Graham King
1.Before configuring Subversion support for Redmine, we should download the Subversion application for Ubuntu, issue:
379 1 Umit Uzun
> sudo apt-get install subversion
380
381
2.If your Redmine can't find the “subversion” command you can help to find by issuing:
382
· > sudo cd /opt/redmine/redmine-0.8.6/config
383
· > sudo gedit environment.rb
384
· Add ENV['PATH'] = "#{ENV['PATH']}:/subversion/path" line in it.
385
· Save and close the “environment.rb”
386
387 16 Ian Epperson
h2.  Start Application at Boot Time
388 1 Umit Uzun
389
1.To automatically start the application on booting your server you need to modify your “crontab”, issue:
390
> export EDITOR=gedit
391
> crontab -e
392
393
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):
394
@reboot cd /opt/redmine/redmine-0.8.6 ; rm -f log/mongrel.pid ; mongrel_rails start -e production -p 3000 -d
395
396 16 Ian Epperson
h2.  Backup
397 1 Umit Uzun
398
1.Running backups is always a good idea. Redmine backups should include:
399 16 Ian Epperson
* data (stored in your redmine database) 
400 1 Umit Uzun
/usr/bin/mysqldump -u -p | gzip > /path/to/redmine/backup/db/redmine_`date +%y_%m_%d`.gz
401 16 Ian Epperson
* attachments (stored in the files directory of your Redmine install)
402 1 Umit Uzun
rsync -a /path/to/redmine/files /path/to/redmine/backup/files
403
404 21 Graham King
2.Or you can use the bash shell to automate this kind of operation, issue:
405 1 Umit Uzun
> sudo cd /opt/redmine/redmine-0.8.6
406
> sudo mkdir backup
407
> sudo mkdir backup/db
408
> sudo mkdir backup/files
409
> sudo gedit backup/runRedmineBackup.bash
410
411 21 Graham King
And after open “runRedmineBackup.bash” with gedit, write all commands below:
412 16 Ian Epperson
<pre>
413 1 Umit Uzun
#!/bin/bash
414
data=`date -I`
415
mysqldump --user=root --password="redmine" --all-databases | gzip > db/backup-$data.sql.gz
416
cd db
417
ftp -i -n << EOF
418
open ftpserver.example.net
419
user username password
420
bin
421
mput backup-$data.sql.gz
422
bye
423
EOF
424 16 Ian Epperson
</pre>
425 21 Graham King
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:
426 1 Umit Uzun
427
> export EDITOR=gedit
428
> crontab -e
429
Add 0 0 * * 0 cd /opt/redmine/redmine-0.8.6/backup ; sh runRedmineBackup.bash commands to crontab to backup database weekly.
430
	
431 21 Graham King
For this to work without any permission problems you have to change the permissions of the files to maximum, issue:
432 1 Umit Uzun
433
> sudo chmod -R 777 backup
434
> sudo chown -R redmine:redmine backup
435
436 21 Graham King
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..!
437 1 Umit Uzun
438
h2. Sources & contributors.
439 2 Sam Wilson
440
* Ümit Uzun 06/11/2009.
441
* 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.
442
* Sam Wilson 2010-05-26, formatting changes.
443 14 allen yeh
* 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.*+
444 18 Glenn Gould
445
h2. Additional Sources
446
447
* http://www.techrecipes.net/web/redmine/install-in-ubuntu