HowToInstallRedmineOnUbuntuServer » History » Version 15

Dimitry Profus, 2011-11-05 02:38

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