HowToInstallRedmineOnUbuntuServer » History » Version 21

Peter Pan, 2012-07-08 16:56

1 19 Jan from Planio www.plan.io
h1. HowTo Install Redmine 1.3.x with Mercurial and Subversion on Ubuntu Server 10.04
2 1 Dimitry Profus
3 1 Dimitry Profus
{{toc}}
4 1 Dimitry Profus
5 2 Dimitry Profus
h2. Pre-install
6 2 Dimitry Profus
7 2 Dimitry Profus
# Set the timezone
8 2 Dimitry Profus
<pre>
9 2 Dimitry Profus
$ dpkg-reconfigure tzdata
10 2 Dimitry Profus
11 11 Dimitry Profus
Select your timezone and exit.
12 2 Dimitry Profus
</pre>
13 2 Dimitry Profus
# Set your hostname
14 2 Dimitry Profus
<pre>
15 15 Dimitry Profus
$ sudo nano /etc/hostname
16 2 Dimitry Profus
17 5 Dimitry Profus
Enter your server name and save.
18 3 Dimitry Profus
19 3 Dimitry Profus
eg.
20 3 Dimitry Profus
21 3 Dimitry Profus
redmine
22 2 Dimitry Profus
</pre>
23 2 Dimitry Profus
# Map your fully qualified domain name (FQDN) to localhost
24 2 Dimitry Profus
<pre>
25 2 Dimitry Profus
$ sudo nano /etc/hosts
26 2 Dimitry Profus
27 2 Dimitry Profus
Add a line mapping local host to your FQDN and hostname and save. 
28 2 Dimitry Profus
29 2 Dimitry Profus
eg. 
30 2 Dimitry Profus
31 2 Dimitry Profus
127.0.0.1 redmine.domain.com redmine
32 2 Dimitry Profus
</pre>
33 2 Dimitry Profus
34 1 Dimitry Profus
h2. Redmine Installation
35 1 Dimitry Profus
36 1 Dimitry Profus
# Install the LAMP stack
37 1 Dimitry Profus
<pre>
38 1 Dimitry Profus
$ sudo tasksel install lamp-server
39 1 Dimitry Profus
</pre>
40 1 Dimitry Profus
# Install the required packages
41 1 Dimitry Profus
<pre>
42 20 Peter Pan
$ sudo apt-get install build-essential subversion libmysqlclient-dev libdigest-sha1-perl libgemplugin-ruby libgemplugin-ruby1.8 libruby-extras libruby1.8-extras rails rake ruby rubygems rubygems1.8 ruby1.8-dev libopenssl-ruby1.8 
43 1 Dimitry Profus
</pre>
44 21 Peter Pan
-->Update rubygems
45 21 Peter Pan
In some cases the your system will still be using rubygems 1.5, but you will need a later version. Check which version is installed by typing:
46 21 Peter Pan
<pre>
47 21 Peter Pan
$ gem --version
48 21 Peter Pan
</pre>
49 21 Peter Pan
If the version is 1.5: update rubygems
50 21 Peter Pan
<pre>
51 21 Peter Pan
gem install rubygems-update
52 21 Peter Pan
cd /var/lib/gems/1.8/bin
53 21 Peter Pan
sudo ./update_rubygems
54 21 Peter Pan
</pre>
55 21 Peter Pan
-->Install necessary gems
56 1 Dimitry Profus
<pre>
57 19 Jan from Planio www.plan.io
$ sudo gem install rails -v=2.3.14 --no-ri --no-rdoc
58 1 Dimitry Profus
$ sudo gem install rake -v=0.8.7 --no-ri --no-rdoc
59 18 Jan from Planio www.plan.io
$ sudo gem uninstall rake -v=0.9.2.2 
60 1 Dimitry Profus
$ sudo gem install i18n -v=0.4.2 --no-ri --no-rdoc
61 1 Dimitry Profus
$ sudo gem install mysql --no-ri --no-rdoc
62 1 Dimitry Profus
</pre> 
63 1 Dimitry Profus
# Download Redmine into /user/share/redmine directory
64 1 Dimitry Profus
<pre>
65 19 Jan from Planio www.plan.io
$ sudo svn co http://redmine.rubyforge.org/svn/branches/1.3-stable /usr/share/redmine
66 1 Dimitry Profus
</pre>
67 1 Dimitry Profus
# Create an empty MySQL database and accompanying user named redmine for example.
68 1 Dimitry Profus
<pre>
69 1 Dimitry Profus
$ mysql -u root -p
70 1 Dimitry Profus
(enter the mysql root user password)
71 1 Dimitry Profus
> create database redmine character set utf8;
72 1 Dimitry Profus
> create user 'redmine'@'localhost' identified by '[password]';
73 1 Dimitry Profus
> grant all privileges on redmine.* to 'redmine'@'localhost' identified by '[password]';
74 1 Dimitry Profus
> exit
75 1 Dimitry Profus
</pre>
76 1 Dimitry Profus
# Copy config/database.yml.example to config/database.yml and edit this file in order to configure your database settings for "production" environment.
77 1 Dimitry Profus
<pre>
78 1 Dimitry Profus
$ sudo cp /usr/share/redmine/config/database.yml.example /usr/share/redmine/config/database.yml
79 1 Dimitry Profus
80 1 Dimitry Profus
$ sudo nano /usr/share/redmine/config/database.yml
81 1 Dimitry Profus
82 1 Dimitry Profus
Modify to the following and save (ctrl+x)
83 1 Dimitry Profus
84 1 Dimitry Profus
production:
85 1 Dimitry Profus
  adapter: mysql
86 1 Dimitry Profus
  socket: /var/run/mysqld/mysqld.sock
87 1 Dimitry Profus
  database: redmine
88 1 Dimitry Profus
  host: localhost
89 1 Dimitry Profus
  username: redmine
90 1 Dimitry Profus
  password: [password]
91 1 Dimitry Profus
  encoding: utf8
92 1 Dimitry Profus
</pre>
93 1 Dimitry Profus
# Generate a session store secret.
94 1 Dimitry Profus
<pre>
95 1 Dimitry Profus
$ cd /usr/share/redmine
96 1 Dimitry Profus
97 1 Dimitry Profus
$ sudo rake generate_session_store
98 1 Dimitry Profus
</pre>
99 1 Dimitry Profus
# Create the database structure, by running the following command under the application root directory:
100 1 Dimitry Profus
<pre>
101 1 Dimitry Profus
$ cd /usr/share/redmine
102 1 Dimitry Profus
103 1 Dimitry Profus
$ sudo rake db:migrate RAILS_ENV="production" 
104 1 Dimitry Profus
</pre>
105 1 Dimitry Profus
# Insert default configuration data in database, by running the following command:
106 1 Dimitry Profus
<pre>
107 1 Dimitry Profus
$ sudo RAILS_ENV=production rake redmine:load_default_data
108 1 Dimitry Profus
</pre>
109 1 Dimitry Profus
# Setting up permissions
110 1 Dimitry Profus
<pre>
111 1 Dimitry Profus
$ cd /usr/share/redmine
112 8 Dimitry Profus
$ sudo chown -R www-data:www-data files log tmp public/plugin_assets
113 1 Dimitry Profus
</pre>
114 1 Dimitry Profus
# Test using the webrick web server
115 1 Dimitry Profus
<pre>
116 1 Dimitry Profus
$ cd /usr/share/redmine
117 1 Dimitry Profus
118 1 Dimitry Profus
$ ruby script/server webrick -e production
119 1 Dimitry Profus
120 1 Dimitry Profus
Point your web browser at http://[my server ip]:3000
121 1 Dimitry Profus
122 1 Dimitry Profus
You should now see the application welcome page.
123 1 Dimitry Profus
</pre>
124 1 Dimitry Profus
125 1 Dimitry Profus
126 1 Dimitry Profus
h2. Apache Integration
127 1 Dimitry Profus
128 1 Dimitry Profus
# Install the required packages
129 1 Dimitry Profus
<pre>
130 1 Dimitry Profus
$ sudo apt-get install libapache2-mod-passenger
131 1 Dimitry Profus
</pre>
132 1 Dimitry Profus
# Add a symbolic link to the public redmine web directory
133 1 Dimitry Profus
<pre>
134 1 Dimitry Profus
$ sudo ln -s /usr/share/redmine/public /var/www/redmine
135 1 Dimitry Profus
</pre>
136 1 Dimitry Profus
# Configure Passanger to run as www-data
137 1 Dimitry Profus
<pre>
138 1 Dimitry Profus
$ sudo nano /etc/apache2/mods-available/passenger.conf
139 1 Dimitry Profus
140 1 Dimitry Profus
Add the follow line and save (ctrl+x)
141 1 Dimitry Profus
142 1 Dimitry Profus
PassengerDefaultUser www-data
143 1 Dimitry Profus
</pre>
144 1 Dimitry Profus
# Create a new Apache site file
145 1 Dimitry Profus
<pre> 
146 1 Dimitry Profus
$ sudo nano /etc/apache2/sites-available/redmine 
147 1 Dimitry Profus
</pre>
148 1 Dimitry Profus
Add the following lines and save (ctrl+x)
149 1 Dimitry Profus
<pre>
150 1 Dimitry Profus
<VirtualHost *:80>
151 1 Dimitry Profus
        ServerAdmin webmaster@localhost
152 1 Dimitry Profus
        DocumentRoot /var/www
153 1 Dimitry Profus
        ServerName myservername
154 1 Dimitry Profus
        
155 1 Dimitry Profus
        RewriteEngine on
156 1 Dimitry Profus
        RewriteRule   ^/$  /redmine  [R]
157 1 Dimitry Profus
158 1 Dimitry Profus
        <Directory /var/www/redmine>
159 1 Dimitry Profus
                RailsBaseURI /redmine
160 1 Dimitry Profus
                PassengerResolveSymlinksInDocumentRoot on
161 1 Dimitry Profus
        </Directory>
162 1 Dimitry Profus
163 1 Dimitry Profus
        ErrorLog /var/log/apache2/error.log
164 1 Dimitry Profus
165 1 Dimitry Profus
        # Possible values include: debug, info, notice, warn, error, crit,
166 1 Dimitry Profus
        # alert, emerg.
167 1 Dimitry Profus
        LogLevel warn
168 1 Dimitry Profus
169 1 Dimitry Profus
        CustomLog /var/log/apache2/access.log combined
170 1 Dimitry Profus
</VirtualHost>
171 1 Dimitry Profus
</pre>
172 1 Dimitry Profus
For SSL add the following text instead
173 1 Dimitry Profus
<pre>
174 1 Dimitry Profus
<VirtualHost *:443>
175 1 Dimitry Profus
        ServerAdmin webmaster@localhost
176 1 Dimitry Profus
        DocumentRoot /var/www
177 1 Dimitry Profus
        ServerName myservername
178 1 Dimitry Profus
179 1 Dimitry Profus
        SSLEngine On
180 1 Dimitry Profus
        SSLCertificateFile /etc/apache2/ssl/redmine.pem
181 1 Dimitry Profus
182 1 Dimitry Profus
        RewriteEngine on
183 1 Dimitry Profus
        RewriteRule   ^/$  /redmine  [R]
184 1 Dimitry Profus
185 1 Dimitry Profus
        <Directory /var/www/redmine>
186 1 Dimitry Profus
                RailsBaseURI /redmine
187 1 Dimitry Profus
                PassengerResolveSymlinksInDocumentRoot on
188 1 Dimitry Profus
        </Directory>
189 1 Dimitry Profus
190 1 Dimitry Profus
        ErrorLog /var/log/apache2/error.log
191 1 Dimitry Profus
192 1 Dimitry Profus
        # Possible values include: debug, info, notice, warn, error, crit,
193 1 Dimitry Profus
        # alert, emerg.
194 1 Dimitry Profus
        LogLevel warn
195 1 Dimitry Profus
196 1 Dimitry Profus
        CustomLog /var/log/apache2/access.log combined
197 1 Dimitry Profus
</VirtualHost>
198 1 Dimitry Profus
</pre>
199 1 Dimitry Profus
# Enable the Redmine website
200 1 Dimitry Profus
<pre>
201 1 Dimitry Profus
$ sudo a2dissite default
202 1 Dimitry Profus
$ sudo a2ensite redmine
203 1 Dimitry Profus
</pre> 
204 1 Dimitry Profus
# Enable the Passenger and Rewite modules and restart Apache
205 1 Dimitry Profus
<pre>
206 1 Dimitry Profus
$ sudo a2enmod passenger
207 1 Dimitry Profus
$ sudo a2enmod rewrite
208 1 Dimitry Profus
$ sudo /etc/init.d/apache2 restart
209 1 Dimitry Profus
</pre> 
210 1 Dimitry Profus
# Test the setup
211 1 Dimitry Profus
<pre>
212 1 Dimitry Profus
Open up your favorite web browser and goto
213 1 Dimitry Profus
214 1 Dimitry Profus
http://[my site or ip]/redmine
215 1 Dimitry Profus
</pre>
216 1 Dimitry Profus
217 1 Dimitry Profus
h2. Mercurial Integration
218 1 Dimitry Profus
219 1 Dimitry Profus
# Install the latest Mercurial release 
220 1 Dimitry Profus
<pre>
221 1 Dimitry Profus
$ sudo apt-get install python-software-properties
222 1 Dimitry Profus
$ sudo add-apt-repository ppa:mercurial-ppa/releases
223 1 Dimitry Profus
$ sudo apt-get update
224 1 Dimitry Profus
$ sudo apt-get install mercurial libapache-dbi-perl libapache2-mod-perl2
225 1 Dimitry Profus
</pre>
226 1 Dimitry Profus
# Create the hg web directory
227 1 Dimitry Profus
<pre>
228 1 Dimitry Profus
$ sudo mkdir -p /var/hg/repos
229 1 Dimitry Profus
</pre>
230 1 Dimitry Profus
# Create the web cgi script file
231 1 Dimitry Profus
<pre>
232 1 Dimitry Profus
$ sudo nano /var/hg/hgwebdir.cgi
233 1 Dimitry Profus
234 1 Dimitry Profus
Add the following and save
235 1 Dimitry Profus
236 1 Dimitry Profus
#!/usr/bin/env python
237 1 Dimitry Profus
#
238 1 Dimitry Profus
from mercurial import demandimport; demandimport.enable()
239 1 Dimitry Profus
from mercurial.hgweb.hgwebdir_mod import hgwebdir
240 1 Dimitry Profus
import mercurial.hgweb.wsgicgi as wsgicgi
241 1 Dimitry Profus
application = hgwebdir('hgweb.config')
242 1 Dimitry Profus
wsgicgi.launch(application)
243 1 Dimitry Profus
</pre>
244 1 Dimitry Profus
# Create the cgi web config file 
245 1 Dimitry Profus
<pre>
246 1 Dimitry Profus
$ sudo nano /var/hg/hgweb.config
247 1 Dimitry Profus
248 1 Dimitry Profus
Add the following and save
249 1 Dimitry Profus
250 1 Dimitry Profus
[paths]
251 1 Dimitry Profus
/=/var/hg/repos/**
252 1 Dimitry Profus
253 1 Dimitry Profus
[web]
254 1 Dimitry Profus
allow_push = *
255 1 Dimitry Profus
push_ssl = false
256 1 Dimitry Profus
allowbz2 = yes
257 1 Dimitry Profus
allowgz = yes
258 1 Dimitry Profus
allowzip = yes
259 1 Dimitry Profus
</pre>
260 1 Dimitry Profus
# Setup permissions
261 1 Dimitry Profus
<pre>
262 1 Dimitry Profus
$ sudo chown -R www-data:www-data /var/hg
263 1 Dimitry Profus
$ sudo chmod gu+x /var/hg/hgwebdir.cgi
264 1 Dimitry Profus
</pre>
265 1 Dimitry Profus
# Create a Apache config file
266 1 Dimitry Profus
<pre>
267 1 Dimitry Profus
$ sudo nano /etc/apache2/conf.d/hg.config
268 1 Dimitry Profus
269 1 Dimitry Profus
Add the following and save
270 1 Dimitry Profus
 
271 1 Dimitry Profus
PerlLoadModule Apache::Redmine
272 1 Dimitry Profus
ScriptAlias /hg  "/var/hg/hgwebdir.cgi"
273 1 Dimitry Profus
<Location /hg  >
274 1 Dimitry Profus
	AuthType Basic
275 1 Dimitry Profus
	AuthName "Redmine Mercurial Repository" 
276 1 Dimitry Profus
	Require valid-user
277 1 Dimitry Profus
278 1 Dimitry Profus
	#Redmine auth
279 1 Dimitry Profus
	PerlAccessHandler Apache::Authn::Redmine::access_handler
280 1 Dimitry Profus
	PerlAuthenHandler Apache::Authn::Redmine::authen_handler
281 1 Dimitry Profus
	RedmineDSN "DBI:mysql:database=redmine;host=localhost" 
282 1 Dimitry Profus
	RedmineDbUser "redmine" 
283 1 Dimitry Profus
	RedmineDbPass "password" 
284 1 Dimitry Profus
</Location>
285 1 Dimitry Profus
</pre>
286 1 Dimitry Profus
# Add a symbolic link to Redmine.pm
287 1 Dimitry Profus
<pre>
288 1 Dimitry Profus
$ sudo ln -s /usr/share/redmine/extra/svn/Redmine.pm /usr/lib/perl5/Apache/Redmine.pm
289 1 Dimitry Profus
$ sudo ln -s /usr/share/redmine/extra/svn/Redmine.pm /usr/lib/perl5/Apache2/Redmine.pm  
290 1 Dimitry Profus
</pre>
291 1 Dimitry Profus
# Enable the required Apache modules and restart Apache
292 1 Dimitry Profus
<pre>
293 1 Dimitry Profus
$ sudo /etc/init.d/apache2 restart
294 1 Dimitry Profus
</pre>
295 1 Dimitry Profus
# Create a new test repository and project in Redmine
296 1 Dimitry Profus
<pre>
297 1 Dimitry Profus
$ sudo hg init /var/hg/repos/test
298 1 Dimitry Profus
$ sudo chown -R www-data:www-data /var/hg/repos/test
299 1 Dimitry Profus
300 1 Dimitry Profus
Create a new project with and identifier 'test'
301 1 Dimitry Profus
302 1 Dimitry Profus
In the project Settings > Repository set
303 1 Dimitry Profus
SCM: Mercurial
304 1 Dimitry Profus
Path to repository: /var/hg/repos/test
305 1 Dimitry Profus
Press the 'Create' button
306 1 Dimitry Profus
307 1 Dimitry Profus
Goto to the Repository tab of the test project
308 1 Dimitry Profus
</pre>
309 1 Dimitry Profus
# View the test repository in the web browser 
310 1 Dimitry Profus
<pre>
311 1 Dimitry Profus
> http://[my site name]/hg/test
312 1 Dimitry Profus
</pre>
313 1 Dimitry Profus
314 1 Dimitry Profus
h2. Subversion Integration
315 1 Dimitry Profus
316 1 Dimitry Profus
# Install the latest Mercurial release 
317 1 Dimitry Profus
<pre>
318 1 Dimitry Profus
$ sudo apt-get install subversion libapache2-svn libapache-dbi-perl libapache2-mod-perl2
319 1 Dimitry Profus
</pre>
320 1 Dimitry Profus
# Create the svn repository directory
321 1 Dimitry Profus
<pre>
322 1 Dimitry Profus
$ sudo mkdir /var/svn
323 1 Dimitry Profus
</pre>
324 1 Dimitry Profus
# Setup permissions
325 1 Dimitry Profus
<pre>
326 1 Dimitry Profus
$ sudo chown -R www-data:www-data /var/svn
327 1 Dimitry Profus
</pre>
328 1 Dimitry Profus
# Add a symbolic link to Redmine.pm
329 1 Dimitry Profus
<pre>
330 1 Dimitry Profus
$ sudo ln -s /usr/share/redmine/extra/svn/Redmine.pm /usr/lib/perl5/Apache/Redmine.pm
331 1 Dimitry Profus
$ sudo ln -s /usr/share/redmine/extra/svn/Redmine.pm /usr/lib/perl5/Apache2/Redmine.pm  
332 1 Dimitry Profus
</pre>
333 1 Dimitry Profus
# Create a Apache config file
334 1 Dimitry Profus
<pre>
335 1 Dimitry Profus
$ sudo nano /etc/apache2/conf.d/svn.config
336 1 Dimitry Profus
</pre>
337 1 Dimitry Profus
Add the following and save
338 1 Dimitry Profus
<pre>
339 1 Dimitry Profus
PerlLoadModule Apache::Redmine
340 1 Dimitry Profus
<Location /svn>
341 1 Dimitry Profus
	DAV svn
342 1 Dimitry Profus
	SVNParentPath "/var/svn" 
343 1 Dimitry Profus
	Order deny,allow
344 1 Dimitry Profus
	Deny from all
345 1 Dimitry Profus
	Satisfy any
346 1 Dimitry Profus
347 1 Dimitry Profus
	PerlAccessHandler Apache::Authn::Redmine::access_handler
348 1 Dimitry Profus
	PerlAuthenHandler Apache::Authn::Redmine::authen_handler
349 1 Dimitry Profus
	AuthType Basic
350 1 Dimitry Profus
	AuthName "Redmine Subversion Repository" 
351 1 Dimitry Profus
352 1 Dimitry Profus
	#read-only access    
353 1 Dimitry Profus
	<Limit GET PROPFIND OPTIONS REPORT>
354 1 Dimitry Profus
		Require valid-user
355 1 Dimitry Profus
		Allow from [my server ip]
356 1 Dimitry Profus
		# Allow from another-ip
357 1 Dimitry Profus
		 Satisfy any
358 1 Dimitry Profus
	</Limit>
359 1 Dimitry Profus
		# write access
360 1 Dimitry Profus
		<LimitExcept GET PROPFIND OPTIONS REPORT>
361 1 Dimitry Profus
		Require valid-user
362 1 Dimitry Profus
	</LimitExcept>
363 1 Dimitry Profus
364 1 Dimitry Profus
	## for mysql
365 1 Dimitry Profus
	RedmineDSN "DBI:mysql:database=redmine;host=localhost" 
366 1 Dimitry Profus
	RedmineDbUser "redmine" 
367 1 Dimitry Profus
	RedmineDbPass "password" 
368 1 Dimitry Profus
</Location>
369 1 Dimitry Profus
</pre>
370 1 Dimitry Profus
# Enable the required Apache modules and restart Apache
371 1 Dimitry Profus
<pre>
372 1 Dimitry Profus
$ sudo a2enmod dav_svn
373 1 Dimitry Profus
$ sudo /etc/init.d/apache2 restart
374 1 Dimitry Profus
</pre>
375 1 Dimitry Profus
# Create a new test repository
376 1 Dimitry Profus
<pre>
377 1 Dimitry Profus
$ sudo svnadmin create /var/svn/test
378 1 Dimitry Profus
$ sudo chown -R www-data:www-data /var/svn/test
379 1 Dimitry Profus
</pre>
380 1 Dimitry Profus
381 1 Dimitry Profus
h2. Automate Repository Creation
382 1 Dimitry Profus
383 1 Dimitry Profus
# Enable WS for repository management and generate and API key
384 1 Dimitry Profus
<pre>
385 1 Dimitry Profus
* From the Redmine Administration menu select Settings
386 1 Dimitry Profus
* Click on the Repositories tab
387 1 Dimitry Profus
* Enable the 'Enable WS for repository management' checkbox
388 1 Dimitry Profus
* Click the 'Generate a key' link 
389 1 Dimitry Profus
* Press the 'Save' button
390 1 Dimitry Profus
</pre>
391 1 Dimitry Profus
# Modify reposman.rb
392 1 Dimitry Profus
<pre>
393 16 Dimitry Profus
$ sudo nano /usr/share/redmine/extra/svn/reposman.rb
394 1 Dimitry Profus
395 1 Dimitry Profus
Add the following to module SCM and save  
396 1 Dimitry Profus
397 1 Dimitry Profus
  module Mercurial
398 1 Dimitry Profus
    def self.create(path)
399 1 Dimitry Profus
      Dir.mkdir path
400 1 Dimitry Profus
      Dir.chdir(path) do
401 1 Dimitry Profus
        system_or_raise "hg init"
402 1 Dimitry Profus
      end
403 1 Dimitry Profus
    end
404 1 Dimitry Profus
  end
405 1 Dimitry Profus
</pre>
406 1 Dimitry Profus
# Schedule the reposman.rb script to run every minute
407 1 Dimitry Profus
<pre>
408 1 Dimitry Profus
$ sudo nano /etc/cron.d/redmine
409 1 Dimitry Profus
</pre>
410 1 Dimitry Profus
Add one of the following lines (not both) and save.
411 1 Dimitry Profus
(Note: you will need to replace [my API key]  with the API key you generated in step 1) 
412 1 Dimitry Profus
.
413 1 Dimitry Profus
To create subversion repositories add:
414 1 Dimitry Profus
<pre>
415 17 Dimitry Profus
* * * * * root ruby /usr/share/redmine/extra/svn/reposman.rb --redmine localhost/redmine --scm Subversion --svn-dir /var/svn --owner www-data --url file:///var/svn --key=[my API key] >> /var/log/reposman.log
416 1 Dimitry Profus
</pre>
417 1 Dimitry Profus
OR to create Mecurial repositories add:
418 1 Dimitry Profus
<pre>
419 1 Dimitry Profus
* * * * * root ruby /usr/share/redmine/extra/svn/reposman.rb --redmine localhost/redmine --scm Mercurial --svn-dir /var/hg/repos --owner www-data --url /var/hg/repos --key=[my API key] >> /var/log/reposman.log
420 1 Dimitry Profus
</pre>
421 1 Dimitry Profus
422 1 Dimitry Profus
h2. Automatic refresh of repositories in Redmine
423 1 Dimitry Profus
424 1 Dimitry Profus
# Schedule the fetch_changesets script to run every 15 minutes
425 1 Dimitry Profus
<pre>
426 16 Dimitry Profus
$ sudo nano /etc/cron.d/redmine
427 1 Dimitry Profus
428 1 Dimitry Profus
Add the following line and save
429 1 Dimitry Profus
430 1 Dimitry Profus
*/15 * * * * root ruby /usr/share/redmine/script/runner "Repository.fetch_changesets" -e production > /dev/null 2>&1
431 1 Dimitry Profus
</pre>
432 1 Dimitry Profus
# Setup a changegroup script on the Mercurial server to run fetch_changesets after each push to a Mercurial repository 
433 1 Dimitry Profus
<pre>
434 1 Dimitry Profus
$ sudo nano /var/hg/changegroup-hook
435 1 Dimitry Profus
</pre>
436 1 Dimitry Profus
Add the following text and save
437 1 Dimitry Profus
(Note: you will need to replace [your API key] the API key you generated in Redmine
438 1 Dimitry Profus
<pre>
439 1 Dimitry Profus
#!/bin/sh
440 1 Dimitry Profus
curl "http://localhost/redmine/sys/fetch_changesets?key=[your API key]"  > /dev/null 2>&1
441 1 Dimitry Profus
</pre>
442 1 Dimitry Profus
Setup permissions
443 1 Dimitry Profus
<pre>
444 1 Dimitry Profus
$ sudo chown www-data:www-data /var/hg/changegroup-hook
445 1 Dimitry Profus
$ sudo chmod ug+x /var/hg/changegroup-hook
446 1 Dimitry Profus
</pre>
447 1 Dimitry Profus
Modify the hgweb.config file
448 1 Dimitry Profus
<pre>
449 1 Dimitry Profus
$ sudo nano /var/hg/hgweb.config
450 1 Dimitry Profus
</pre>
451 1 Dimitry Profus
Add the following section and save
452 1 Dimitry Profus
<pre>
453 1 Dimitry Profus
[hooks]
454 1 Dimitry Profus
changegroup = /var/hg/changegroup-hook
455 1 Dimitry Profus
</pre>
456 1 Dimitry Profus
457 1 Dimitry Profus
h2. Email Integration
458 1 Dimitry Profus
459 1 Dimitry Profus
# Install and configure Sendmail
460 1 Dimitry Profus
<pre>
461 1 Dimitry Profus
$ sudo apt-get install sendmail
462 1 Dimitry Profus
$ sudo sendmailconfig
463 1 Dimitry Profus
464 1 Dimitry Profus
(Answer Yes to all questions which you will be asked)
465 1 Dimitry Profus
</pre>
466 1 Dimitry Profus
# Update the Redmine configuration file
467 1 Dimitry Profus
<pre>
468 1 Dimitry Profus
$ sudo nano /usr/share/redmine/config/configuration.yml
469 1 Dimitry Profus
470 1 Dimitry Profus
Add the following text and save
471 1 Dimitry Profus
472 1 Dimitry Profus
 production:
473 1 Dimitry Profus
   email_delivery:
474 1 Dimitry Profus
     delivery_method: :sendmail
475 1 Dimitry Profus
</pre>
476 1 Dimitry Profus
477 1 Dimitry Profus
h2. Backup to Amazon S3 cloud storage
478 1 Dimitry Profus
479 1 Dimitry Profus
# Create an account at http://aws.amazon.com/ 
480 1 Dimitry Profus
# Create a S3 bucket using the aws management console https://console.aws.amazon.com/ec2/home
481 1 Dimitry Profus
# View your Access Keys at https://aws-portal.amazon.com/gp/aws/developer/account/index.html?action=access-key
482 1 Dimitry Profus
# Build and install fuse to 2.8.4
483 1 Dimitry Profus
<pre>
484 1 Dimitry Profus
$ sudo wget https://launchpad.net/ubuntu/+archive/primary/+files/fuse_2.8.4.orig.tar.gz
485 1 Dimitry Profus
$ cd fuse-2.8.4/
486 1 Dimitry Profus
$ tar xzf fuse_2.8.4.orig.tar.gz 
487 1 Dimitry Profus
$ sudo ./configure 
488 1 Dimitry Profus
$ sudo make
489 1 Dimitry Profus
$ sudo make install
490 1 Dimitry Profus
</pre>
491 1 Dimitry Profus
# Build and install s3fs 1.61 
492 1 Dimitry Profus
<pre>
493 1 Dimitry Profus
$ sudo apt-get install libxml2-dev
494 1 Dimitry Profus
$ wget http://s3fs.googlecode.com/files/s3fs-1.61.tar.gz
495 1 Dimitry Profus
$ tar xzf s3fs-1.61.tar.gz 
496 1 Dimitry Profus
$ cd s3fs-1.61/
497 1 Dimitry Profus
$ sudo ./configure 
498 1 Dimitry Profus
$ sudo make
499 1 Dimitry Profus
$ sudo make install
500 1 Dimitry Profus
</pre>
501 1 Dimitry Profus
# Create a s3fs password file
502 1 Dimitry Profus
<pre>
503 1 Dimitry Profus
$ sudo nano /etc/passwd-s3fs
504 1 Dimitry Profus
</pre>
505 1 Dimitry Profus
Added your 'Access Key ID' and 'Secret Access Key' separated by a colon
506 1 Dimitry Profus
<pre>
507 1 Dimitry Profus
[accessKeyId]:[secretAccessKey]
508 1 Dimitry Profus
</pre>
509 1 Dimitry Profus
Setup permissions
510 1 Dimitry Profus
<pre>
511 6 Dimitry Profus
sudo chmod 640 /etc/passwd-s3fs
512 1 Dimitry Profus
</pre> 
513 1 Dimitry Profus
# Create mounting point
514 1 Dimitry Profus
<pre>
515 1 Dimitry Profus
$ sudo mkdir /mnt/s3
516 1 Dimitry Profus
</pre>
517 1 Dimitry Profus
# Mount your S3 bucket
518 1 Dimitry Profus
<pre>
519 1 Dimitry Profus
$ sudo s3fs [your-s3-bucket-name] /mnt/s3 -ouse_cache=/tmp -o allow_other
520 1 Dimitry Profus
</pre>
521 1 Dimitry Profus
# Test it worked and unmount
522 1 Dimitry Profus
<pre>
523 1 Dimitry Profus
$ echo hello > /mnt/s3/welcome.txt
524 1 Dimitry Profus
$ ls /mnt/s3
525 1 Dimitry Profus
$ sudo umount /mnt/s3
526 1 Dimitry Profus
</pre>
527 1 Dimitry Profus
# Create upstart job to mount the s3 file system start up
528 1 Dimitry Profus
<pre>
529 1 Dimitry Profus
$ sudo nano /etc/init/s3.conf
530 1 Dimitry Profus
</pre>
531 1 Dimitry Profus
Add the following text and save.
532 1 Dimitry Profus
<pre>
533 1 Dimitry Profus
description "Mount Amazon S3 file system on system start"
534 1 Dimitry Profus
535 1 Dimitry Profus
start on (local-filesystems and net-device-up IFACE!=lo)
536 1 Dimitry Profus
stop on runlevel [016]
537 1 Dimitry Profus
538 1 Dimitry Profus
respawn
539 1 Dimitry Profus
540 1 Dimitry Profus
exec s3fs -f [your-s3-bucket-name] /mnt/s3 -ouse_cache=/tmp -o allow_other
541 1 Dimitry Profus
</pre>
542 1 Dimitry Profus
# Start the s3 job
543 1 Dimitry Profus
<pre>
544 1 Dimitry Profus
sudo start s3
545 1 Dimitry Profus
</pre>
546 1 Dimitry Profus
# Test it worked
547 1 Dimitry Profus
<pre>
548 1 Dimitry Profus
$ echo hello > /mnt/s3/welcome2.txt
549 1 Dimitry Profus
$ ls /mnt/s3
550 1 Dimitry Profus
</pre>
551 1 Dimitry Profus
# Create the backup script file
552 1 Dimitry Profus
<pre>
553 1 Dimitry Profus
$ sudo apt-get install mailutils
554 1 Dimitry Profus
$ sudo nano /usr/local/bin/backup-redmine.sh
555 1 Dimitry Profus
</pre>
556 1 Dimitry Profus
Add the following text and save.
557 1 Dimitry Profus
<pre>
558 13 Dimitry Profus
#!/bin/bash
559 1 Dimitry Profus
# Script to backup Redmine files to a mounted storage device
560 1 Dimitry Profus
# with daily, weekly, monthly backup rotation
561 1 Dimitry Profus
562 12 Dimitry Profus
# Sysadmin email address
563 12 Dimitry Profus
sysadmin_email="admin@domain.com"
564 1 Dimitry Profus
565 1 Dimitry Profus
# What to backup
566 12 Dimitry Profus
db_dump_file="/usr/share/redmine/db/redmine-database-dump.sql"
567 1 Dimitry Profus
568 13 Dimitry Profus
backup_files="$db_dump_file /usr/share/redmine/files /var/hg /var/svn /etc/apache2/conf.d/hg.conf"
569 12 Dimitry Profus
backup_files="$backup_files /etc/apache2/sites-available/redmine /etc/init/s3.conf /etc/cron.d/redmine"
570 12 Dimitry Profus
backup_files="$backup_files /usr/local/bin/backup-redmine.sh"
571 12 Dimitry Profus
572 1 Dimitry Profus
# Where to backup to
573 12 Dimitry Profus
backup_dir="/mnt/s3"
574 1 Dimitry Profus
575 1 Dimitry Profus
# Set database access
576 12 Dimitry Profus
redmine_db_name="redmine"
577 12 Dimitry Profus
redmine_db_user="redmine"
578 12 Dimitry Profus
redmine_db_password="password"
579 1 Dimitry Profus
580 1 Dimitry Profus
# Encryption
581 12 Dimitry Profus
encrypt="true"
582 13 Dimitry Profus
secret_passphrase="password"
583 1 Dimitry Profus
584 12 Dimitry Profus
# Set rotation schedule in units of days ( 0 = disabled )
585 1 Dimitry Profus
daily_remove_older_than=6
586 12 Dimitry Profus
weekly_remove_older_than=31
587 1 Dimitry Profus
monthly_remove_older_than=62
588 1 Dimitry Profus
589 1 Dimitry Profus
# Redirect stderr to a log file
590 12 Dimitry Profus
error_log="/tmp/backup-redmine.log"
591 1 Dimitry Profus
exec 6>&2
592 1 Dimitry Profus
exec 2>$error_log
593 1 Dimitry Profus
594 1 Dimitry Profus
on_exit() {
595 1 Dimitry Profus
    # Restore IO output
596 1 Dimitry Profus
    exec 2>&6  6>$-
597 1 Dimitry Profus
598 1 Dimitry Profus
    # Check for errors
599 1 Dimitry Profus
    if [ -s "$error_log" ]; then
600 12 Dimitry Profus
        logger -t "$0" -s "#### Backup Failed ####"
601 12 Dimitry Profus
        logger -t "$0" -s -f "$error_log"
602 12 Dimitry Profus
        cat "$error_log" | mail -s "Backup failed!"  $sysadmin_email
603 1 Dimitry Profus
     else
604 12 Dimitry Profus
        logger -t "$0" -s "Backup Complete"
605 1 Dimitry Profus
    fi
606 1 Dimitry Profus
607 1 Dimitry Profus
    # Clean up
608 1 Dimitry Profus
    rm -f $error_log
609 1 Dimitry Profus
}
610 1 Dimitry Profus
611 1 Dimitry Profus
trap on_exit EXIT SIGHUP SIGINT SIGQUIT SIGTERM
612 1 Dimitry Profus
613 1 Dimitry Profus
# Setup variables for the archive filename.
614 1 Dimitry Profus
hostname=$(hostname -s)
615 1 Dimitry Profus
date_stamp=`date +%Y-%m-%d`                    # Date p e.g 2011-12-31
616 1 Dimitry Profus
date_day_of_week=`date +%A`                    # Day of the week e.g. Monday
617 1 Dimitry Profus
date_day_of_month=`date +%e`                   # Date of the Month e.g. 27
618 1 Dimitry Profus
619 1 Dimitry Profus
# Is the  backup directory mounted?
620 1 Dimitry Profus
mount | grep -sq "$backup_dir"
621 1 Dimitry Profus
if  [ $? != 0 ]; then
622 1 Dimitry Profus
   echo "backup destination ${backup_dir} is not mounted" >&2
623 1 Dimitry Profus
  exit 1
624 12 Dimitry Profus
fi
625 1 Dimitry Profus
626 12 Dimitry Profus
# Delete old archives
627 13 Dimitry Profus
find "${backup_dir}" -mtime +"$monthly_remove_older_than" -type f -name "${hostname}_fullbackup_monthly*" -exec rm {} \;
628 13 Dimitry Profus
find "${backup_dir}" -mtime +"$weekly_remove_older_than" -type f -name "${hostname}_fullbackup_weekly*" -exec rm {} \;
629 13 Dimitry Profus
find "${backup_dir}" -mtime +"$daily_remove_older_than" -type f -name "${hostname}_fullbackup_daily*" -exec rm {} \;
630 1 Dimitry Profus
631 12 Dimitry Profus
# Determine the backup schedule
632 1 Dimitry Profus
if [[ $monthly_remove_older_than -gt "0" && $date_day_of_month == "1" ]]; then
633 12 Dimitry Profus
    schedule="monthly"
634 12 Dimitry Profus
elif [[ $weekly_remove_older_than -gt "0" && $date_day_of_week == "Saturday" ]]; then
635 12 Dimitry Profus
    schedule="weekly"
636 12 Dimitry Profus
elif [[ $daily_remove_older_than -gt "0" ]]; then
637 12 Dimitry Profus
    schedule="daily"
638 12 Dimitry Profus
else
639 1 Dimitry Profus
    echo "Invalid backup rotation schedule" >&2
640 12 Dimitry Profus
    exit 1
641 1 Dimitry Profus
fi
642 12 Dimitry Profus
643 13 Dimitry Profus
archive_file="${backup_dir}/${hostname}_fullbackup_${schedule}_${date_stamp}.tgz"
644 12 Dimitry Profus
645 1 Dimitry Profus
# Dump the redmine database
646 12 Dimitry Profus
rm -f "${db_dump_file}"
647 1 Dimitry Profus
mysqldump --user="${redmine_db_name}" --password="${redmine_db_password}" "${redmine_db_name}" > $db_dump_file
648 1 Dimitry Profus
649 1 Dimitry Profus
# Write the archive file to the backup directory
650 1 Dimitry Profus
if [ $encrypt == "true" ]; then
651 13 Dimitry Profus
    tar czP ${backup_files} | gpg -c -z 0 --yes --no-use-agent --passphrase="${secret_passphrase}" -o "${archive_file}.gpg"
652 1 Dimitry Profus
else
653 13 Dimitry Profus
    tar czfP "${archive_file}" ${backup_files}
654 1 Dimitry Profus
fi
655 1 Dimitry Profus
656 1 Dimitry Profus
if [ -s "$error_log" ]; then
657 1 Dimitry Profus
    exit 1
658 1 Dimitry Profus
else
659 1 Dimitry Profus
    exit 0
660 1 Dimitry Profus
fi
661 1 Dimitry Profus
</pre>
662 1 Dimitry Profus
# Setup permissions 
663 1 Dimitry Profus
<pre>
664 6 Dimitry Profus
sudo chmod 770 /usr/local/bin/backup-redmine.sh
665 1 Dimitry Profus
</pre>
666 1 Dimitry Profus
# Schedule the backup to run once a day at 12am
667 1 Dimitry Profus
<pre>
668 1 Dimitry Profus
$ sudo nano /etc/cron.d/redmine
669 1 Dimitry Profus
670 1 Dimitry Profus
Add the following line and save
671 1 Dimitry Profus
672 1 Dimitry Profus
0 0 * * * root /usr/local/bin/backup-redmine.sh
673 1 Dimitry Profus
</pre>
674 1 Dimitry Profus
# Test the script
675 1 Dimitry Profus
<pre>
676 1 Dimitry Profus
$ sudo backup-redmine.sh
677 1 Dimitry Profus
$ ls -R /mnt/s3
678 1 Dimitry Profus
</pre>