HowTo configure Redmine for advanced git integration » History » Version 19

Mr. DTTH, 2013-08-08 04:44

1 1 Felix Schäfer
h1. HowTo configure Redmine for advanced git integration
2 1 Felix Schäfer
3 3 Felix Schäfer
{{>TOC}}
4 3 Felix Schäfer
5 1 Felix Schäfer
h2. Scope
6 1 Felix Schäfer
7 17 Mr. DTTH
This HowTo explains how to serve git repositories on apache through the http-based "git-smart-http protocol":http://progit.org/2010/03/04/smart-http.html introduced in git 1.6.6. 
8 1 Felix Schäfer
9 17 Mr. DTTH
The git-smart-http offers various advantages over ssh or git-based access: you can use redmine access control as-is, no need for extra ssh keys or whatnot, you can secure it through SSL as needed, and there's generally less problems with firewalls and https/https ports than exist with ssh and git ports. git-smart-http also doesn't have some of the drawbacks of its "dumb" predecessor, as it doesn't require any complex DAV setup.
10 1 Felix Schäfer
11 17 Mr. DTTH
This HowTo is mainly written from memory and was conducted on a setup which was already serving [[Repositories_access_control_with_apache_mod_dav_svn_and_mod_perl|svn repositories integrated with redmine]], so it might be possible that I forgot some things or take them for granted. 
12 17 Mr. DTTH
13 17 Mr. DTTH
This is a wiki page, feel free to correct or amend anything you find lacking :-) You can also "drop me a line":/users/3866.
14 17 Mr. DTTH
15 7 Felix Schäfer
Another option to integrate grack with redmine is the "modified grack+redmine plugin":http://github.com/friflaj/redmine_grack or "any other grack modified for redmine":http://github.com/search?q=grack&type=Everything&repo=&langOverride=&start_value=1, though those ones lack documentation and I haven't tried them, so I can't say much about those.
16 1 Felix Schäfer
17 1 Felix Schäfer
h2. Prerequisites
18 1 Felix Schäfer
19 1 Felix Schäfer
* Apache with mod_perl (access control)
20 1 Felix Schäfer
* git (version at least 1.6.6)
21 1 Felix Schäfer
* A way to serve git-smart-http
22 10 Hallison Vasconcelos Batista
** mod_cgi (or mod_cgid) if you want to use the stock "git-http-backend":http://www.kernel.org/pub/software/scm/git/docs/git-http-backend.html
23 1 Felix Schäfer
** a rack server if you want to use "grack":http://github.com/schacon/grack (basically a rack wrapper around the right git commands) or
24 10 Hallison Vasconcelos Batista
"git-webby":http://git.io/BU7twg (another implementation based on grack but written in Sinatra).
25 1 Felix Schäfer
26 17 Mr. DTTH
You should already have a rack server to run redmine, and that's why I chose grack as the backend and which I will describe in this tutorial. 
27 1 Felix Schäfer
28 17 Mr. DTTH
Using the stock git-http-backend should be quite straightforward though (skip the [[HowTo_configure_Redmine_for_advanced_git_integration#Install-grack|grack installation]] part and get your install with the git-http-backend going (the "git-http-backend manpage":http://www.kernel.org/pub/software/scm/git/docs/git-http-backend.html has some examples), when that's done go on with the [[HowTo_configure_Redmine_for_advanced_git_integration#Access-control|access control]] part).
29 17 Mr. DTTH
30 2 Felix Schäfer
h2. Install grack
31 1 Felix Schäfer
32 3 Felix Schäfer
h3. Get the sources
33 2 Felix Schäfer
34 19 Mr. DTTH
Fetch grack from its "github repository":http://github.com/schacon/grack, I checked out mine to @/var/www/grack@
35 1 Felix Schäfer
36 19 Mr. DTTH
<pre><code class="bash">
37 19 Mr. DTTH
cd /var/www
38 19 Mr. DTTH
git clone http://github.com/schacon/grack.git
39 19 Mr. DTTH
</code></pre>
40 1 Felix Schäfer
41 18 Mr. DTTH
And create a directory for repositories :
42 18 Mr. DTTH
43 18 Mr. DTTH
<pre><code class="bash">
44 18 Mr. DTTH
mkdir /opt/repositories
45 18 Mr. DTTH
mkfir /opt/repositories/git
46 18 Mr. DTTH
chown -R apache:apache /opt/repositories/git
47 18 Mr. DTTH
</code></pre>
48 18 Mr. DTTH
49 2 Felix Schäfer
h3. Configuration
50 2 Felix Schäfer
51 2 Felix Schäfer
Edit the @config.ru@ file and adapt it to your local configuration. @project_root@ must contain the path to the directory containing your git repositories, @git_path@ must obviously contain the path to the git, mine looks like this (on gentoo):
52 2 Felix Schäfer
53 2 Felix Schäfer
<pre><code class="ruby">$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/lib')
54 1 Felix Schäfer
55 2 Felix Schäfer
use Rack::ShowExceptions
56 1 Felix Schäfer
57 18 Mr. DTTH
require 'grack'
58 1 Felix Schäfer
59 18 Mr. DTTH
require 'git_adapter'
60 18 Mr. DTTH
61 2 Felix Schäfer
config = {
62 18 Mr. DTTH
  :project_root => "/opt/repositories/git",
63 18 Mr. DTTH
  :git_path => '/usr/bin/git',
64 2 Felix Schäfer
  :upload_pack => true,
65 2 Felix Schäfer
  :receive_pack => true,
66 1 Felix Schäfer
}
67 1 Felix Schäfer
68 1 Felix Schäfer
run GitHttp::App.new(config)</code></pre>
69 3 Felix Schäfer
70 1 Felix Schäfer
h3. Integrate with Apache
71 17 Mr. DTTH
72 1 Felix Schäfer
You could obviously use any rack server you like at this point, but the access control mechanism @Redmine.pm@ is written for apache with mod_perl, so you will at least need to reverse proxy your rack server through apache. 
73 17 Mr. DTTH
74 1 Felix Schäfer
My rack server of choice is "passenger":http://modrails.com/ (solid performance, apache module, mostly simple configuration) and it is already configured on my system. 
75 17 Mr. DTTH
76 17 Mr. DTTH
As passenger installation and configuration is not within the scope of this HowTo, please refer to the "passenger documentation":http://modrails.com/documentation.html or to the passenger installation guide from your distribution.
77 17 Mr. DTTH
78 17 Mr. DTTH
There's a little more work to do here to get passenger to work with this, you will need to create the directories @public@ and @tmp@ in the grack directory. 
79 17 Mr. DTTH
80 17 Mr. DTTH
Please also be aware that in the standard configuration, passenger will run the grack application with the same user and group owning the @config.ru@ file. This user must have read- and write-access as needed to the git repositories!
81 2 Felix Schäfer
82 2 Felix Schäfer
The last step is to configure an apache vhost to serve the application:
83 2 Felix Schäfer
84 2 Felix Schäfer
<pre><code class="apache"><VirtualHost yo.ur.i.p:80>
85 2 Felix Schäfer
    ServerName git.myhost.com
86 2 Felix Schäfer
87 2 Felix Schäfer
    ServerAdmin root@myhost.com
88 2 Felix Schäfer
    DocumentRoot "/var/www/git.myhost.com/public"
89 2 Felix Schäfer
90 2 Felix Schäfer
    <Directory "/var/www/git.myhost.com/public">
91 2 Felix Schäfer
        Options None
92 2 Felix Schäfer
        AllowOverride None
93 2 Felix Schäfer
        Order allow,deny
94 2 Felix Schäfer
        Allow from all
95 2 Felix Schäfer
    </Directory>
96 2 Felix Schäfer
</VirtualHost></code></pre>
97 1 Felix Schäfer
98 10 Hallison Vasconcelos Batista
At this point, if you have a repository in @/var/git/git.myhost.com/myrepo@, you should be able to access it through @http://git.myhost.com/myrepo@, for example @git ls-remote http://git.myhost.com/myrepo@ should show you some information about the repository.
99 10 Hallison Vasconcelos Batista
100 10 Hallison Vasconcelos Batista
h2. Install git-webby
101 3 Felix Schäfer
102 3 Felix Schäfer
Follow the instructions available in "repository page":http://git.io/BU7twg that use basically the same instructions described above.
103 3 Felix Schäfer
104 3 Felix Schäfer
h2. Access control
105 3 Felix Schäfer
106 3 Felix Schäfer
You now have a working git server, albeit with no access control. Currently, the shipped perl module for access control @Redmine.pm@ (in @extra/svn/@ in your redmine directory) does not support access control for the git-smart-http protocol, the patch in #4905 aims to implement that.
107 3 Felix Schäfer
108 11 Gregory Bartholomew
h3. Applying the patch
109 1 Felix Schäfer
110 3 Felix Schäfer
Download the latest (or better: correct) version of the patch from #4905 to your redmine directory. In the redmine directory, apply the patch: @patch -p1 < the-patch-file.patch@ should work (if it tells you stuff about being unable to apply a hunk, the patch is incompatible with your @Redmine.pm@ version, if it says other stuff, try @patch -p0 < the-patch-file.patch@ or @patch Redmine.pm < the-patch-file.patch@, if it still borks, ask for advice on #4905).
111 1 Felix Schäfer
112 1 Felix Schäfer
-You will possibly still need to edit the file from here, because the current version of the patch only works for repositories served from @http://git.myhost.com/git/myrepo@ though the above example uses @http://git.myhost.com/myrepo@.- This step isn't needed anymore, the patch has been updated to take the information from the @Location@ block from apache into account.
113 8 Felix Schäfer
114 3 Felix Schäfer
h3. Configuring Apache
115 17 Mr. DTTH
116 3 Felix Schäfer
You now have to make Apache aware of your new authentication module (if you already had done this step for subversion integration, you can go to the @Location@ directives directly). 
117 17 Mr. DTTH
118 17 Mr. DTTH
Copy or link @Redmine.pm@ (from your @extra/svn/@ directory) to @/usr/lib/perl5/Apache/Redmine.pm@ (ubuntu) or wherever your distribution puts its apache perl modules (e.g. gentoo puts them in @/usr/lib64/perl5/vendor_perl/5.8.8/Apache/@, fedora puts them in @/usr/lib64/perl5/vendor_perl/Apache/@).
119 3 Felix Schäfer
120 3 Felix Schäfer
Having done that, reload apache to make sure everything in the patching phase went well (if not, remove the link or the file create in the step just before and restart apache to get apache back up, try to find the error in your Redmine.pm file). Now edit your vhost configuration to look somewhat like (same as above but with more stuff):
121 3 Felix Schäfer
122 3 Felix Schäfer
<pre><code class="apache"><VirtualHost yo.ur.i.p:80>
123 3 Felix Schäfer
    ServerName git.myhost.com
124 3 Felix Schäfer
125 3 Felix Schäfer
    ServerAdmin root@myhost.com
126 3 Felix Schäfer
    DocumentRoot "/var/www/git.myhost.com/public"
127 3 Felix Schäfer
128 3 Felix Schäfer
    PerlLoadModule Apache::Redmine
129 3 Felix Schäfer
130 3 Felix Schäfer
    <Directory "/var/www/git.myhost.com/public">
131 3 Felix Schäfer
        Options None
132 3 Felix Schäfer
        AllowOverride None
133 3 Felix Schäfer
        Order allow,deny
134 3 Felix Schäfer
        Allow from all
135 3 Felix Schäfer
    </Directory>
136 3 Felix Schäfer
137 3 Felix Schäfer
    <Location "/">
138 3 Felix Schäfer
        AuthType Basic
139 3 Felix Schäfer
        AuthName "Redmine git repositories"
140 3 Felix Schäfer
        Require valid-user
141 3 Felix Schäfer
142 3 Felix Schäfer
        PerlAccessHandler Apache::Authn::Redmine::access_handler
143 3 Felix Schäfer
        PerlAuthenHandler Apache::Authn::Redmine::authen_handler
144 3 Felix Schäfer
145 3 Felix Schäfer
        ## for mysql
146 3 Felix Schäfer
        RedmineDSN "DBI:mysql:database=databasename;host=my.db.server"
147 3 Felix Schäfer
        ## for postgres
148 3 Felix Schäfer
        # RedmineDSN "DBI:Pg:dbname=databasename;host=my.db.server"
149 3 Felix Schäfer
        ## for SQLite3
150 3 Felix Schäfer
        # RedmineDSN "DBI:SQLite:dbname=database.db"
151 3 Felix Schäfer
152 3 Felix Schäfer
        RedmineDbUser "redmine"
153 3 Felix Schäfer
        RedmineDbPass "password"
154 1 Felix Schäfer
        RedmineGitSmartHttp yes
155 3 Felix Schäfer
    </Location>
156 1 Felix Schäfer
</VirtualHost></code></pre>
157 1 Felix Schäfer
158 3 Felix Schäfer
Reload your apache, and everything should be good and well :-)
159 3 Felix Schäfer
160 3 Felix Schäfer
h2. Known issues
161 17 Mr. DTTH
162 1 Felix Schäfer
If you are using the stock git-http-backend directly under apache and you are finding errors like "Request not supported: '/git/your-git-repo'" in your apache error log, you may need to add "SetEnv REMOTE_USER=$REDIRECT_REMOTE_USER" to the to the list of environment variables that you are setting in your apache configuration.  
163 17 Mr. DTTH
164 17 Mr. DTTH
Unfortionately, this setting may cause redmine to borke.  If so, you will need to set the variable for only the requests that are passed through git-http-backend.  One way to accomplish this is with mod_rewrite.  Below is a sample apache configuration from a Fedora 17 system that uses git-http-backend and mod_rewrite.
165 13 Gregory Bartholomew
166 13 Gregory Bartholomew
In httpd.conf:
167 13 Gregory Bartholomew
168 13 Gregory Bartholomew
<pre><code class="apache">Listen xxx.xxx.xxx.xxx:80
169 13 Gregory Bartholomew
<VirtualHost xxx.xxx.xxx.xxx:80>
170 13 Gregory Bartholomew
   DocumentRoot /var/www/redmine/public
171 13 Gregory Bartholomew
   ServerName servername.domain:80
172 13 Gregory Bartholomew
   Include conf/servername.conf
173 13 Gregory Bartholomew
</VirtualHost>
174 13 Gregory Bartholomew
175 13 Gregory Bartholomew
Listen xxx.xxx.xxx.xxx:443
176 13 Gregory Bartholomew
<VirtualHost xxx.xxx.xxx.xxx:443>
177 13 Gregory Bartholomew
   DocumentRoot /var/www/redmine/public
178 13 Gregory Bartholomew
   ServerName servername.domain:443
179 13 Gregory Bartholomew
   Include conf/servername.conf
180 13 Gregory Bartholomew
   Include conf/ssl.conf
181 13 Gregory Bartholomew
</VirtualHost></code></pre>
182 13 Gregory Bartholomew
183 13 Gregory Bartholomew
In servername.conf:
184 13 Gregory Bartholomew
185 13 Gregory Bartholomew
<pre><code class="apache">PerlLoadModule Apache::Authn::Redmine
186 13 Gregory Bartholomew
187 13 Gregory Bartholomew
SetEnv GIT_PROJECT_ROOT /git-1/repositories
188 13 Gregory Bartholomew
SetEnv GIT_HTTP_EXPORT_ALL
189 13 Gregory Bartholomew
190 13 Gregory Bartholomew
<IfModule mod_rewrite.c>
191 13 Gregory Bartholomew
   RewriteEngine On
192 13 Gregory Bartholomew
193 13 Gregory Bartholomew
   RewriteCond %{HTTPS} ^off$
194 13 Gregory Bartholomew
   RewriteCond %{REQUEST_URI} !^/git-private/
195 13 Gregory Bartholomew
   RewriteRule ^.*$ https://servername.domain$0 [R=301,L]
196 13 Gregory Bartholomew
   RewriteRule ^/git/(.*/objects/[0-9a-f]{2}/[0-9a-f]{38})$ /git-1/repositories/$1 [L]
197 13 Gregory Bartholomew
   RewriteRule ^/git/(.*/objects/pack/pack-[0-9a-f]{40}.(pack|idx))$ /git-1/repositories/$1 [L]
198 13 Gregory Bartholomew
   RewriteRule ^/git/(.*)$ /usr/libexec/git-core/git-http-backend/$1 [E=REMOTE_USER:$REDIRECT_REMOTE_USER,H=cgi-script,L]
199 13 Gregory Bartholomew
</IfModule>
200 13 Gregory Bartholomew
201 15 Gregory Bartholomew
<Directory /usr/libexec/git-core>
202 15 Gregory Bartholomew
   <Files "git-http-backend">
203 15 Gregory Bartholomew
      Options +ExecCGI
204 13 Gregory Bartholomew
   </Files>
205 13 Gregory Bartholomew
</Directory>
206 13 Gregory Bartholomew
207 13 Gregory Bartholomew
<Location /git>
208 13 Gregory Bartholomew
   AuthType Basic
209 13 Gregory Bartholomew
   AuthName "CAMPUS"
210 13 Gregory Bartholomew
   AuthBasicProvider external
211 13 Gregory Bartholomew
   AuthExternal pwauth
212 13 Gregory Bartholomew
   Require valid-user
213 13 Gregory Bartholomew
214 13 Gregory Bartholomew
   PerlAccessHandler Apache::Authn::Redmine::access_handler
215 13 Gregory Bartholomew
   PerlAuthenHandler Apache::Authn::Redmine::authen_handler
216 13 Gregory Bartholomew
 
217 13 Gregory Bartholomew
   RedmineDSN "DBI:mysql:database=redmine;host=localhost" 
218 14 Gregory Bartholomew
   RedmineDbUser "redmine" 
219 13 Gregory Bartholomew
   # RedmineDbPass "password"
220 13 Gregory Bartholomew
   RedmineGitSmartHttp yes
221 13 Gregory Bartholomew
</Location>
222 13 Gregory Bartholomew
223 13 Gregory Bartholomew
Alias /git-private /git-1/repositories
224 13 Gregory Bartholomew
225 13 Gregory Bartholomew
<Location /git-private>
226 13 Gregory Bartholomew
   Order deny,allow
227 13 Gregory Bartholomew
   Deny from all
228 13 Gregory Bartholomew
   <Limit GET PROPFIND OPTIONS REPORT>
229 13 Gregory Bartholomew
      Options Indexes FollowSymLinks MultiViews
230 13 Gregory Bartholomew
      Allow from 127.0.0.1
231 13 Gregory Bartholomew
      Allow from localhost
232 13 Gregory Bartholomew
   </Limit>
233 13 Gregory Bartholomew
</Location>
234 13 Gregory Bartholomew
235 13 Gregory Bartholomew
<Directory "/var/www/redmine/public">
236 13 Gregory Bartholomew
   RailsEnv production
237 13 Gregory Bartholomew
   RailsBaseURI /
238 13 Gregory Bartholomew
239 13 Gregory Bartholomew
   Options -MultiViews
240 13 Gregory Bartholomew
   AllowOverride All
241 13 Gregory Bartholomew
</Directory></code></pre>
242 13 Gregory Bartholomew
243 13 Gregory Bartholomew
In conf/ssl.conf:
244 13 Gregory Bartholomew
245 13 Gregory Bartholomew
<pre><code class="apache">LogLevel warn
246 13 Gregory Bartholomew
SSLEngine on
247 13 Gregory Bartholomew
SSLProtocol all -SSLv2
248 13 Gregory Bartholomew
SSLCipherSuite RC4-SHA:AES128-SHA:ALL:!ADH:!EXP:!LOW:!MD5:!SSLV2:!NULL
249 13 Gregory Bartholomew
SSLCertificateFile /etc/pki/tls/certs/your-server.crt
250 13 Gregory Bartholomew
SSLCertificateKeyFile /etc/pki/tls/private/your-server.key
251 13 Gregory Bartholomew
SSLCertificateChainFile /etc/pki/tls/certs/server-chain.crt
252 13 Gregory Bartholomew
SSLCACertificateFile /etc/pki/tls/certs/ca-bundle.crt
253 13 Gregory Bartholomew
254 13 Gregory Bartholomew
<Files ~ "\.(cgi|shtml|phtml|php3?)$">
255 13 Gregory Bartholomew
    SSLOptions +StdEnvVars
256 13 Gregory Bartholomew
</Files>
257 13 Gregory Bartholomew
<Directory "/var/www/cgi-bin">
258 13 Gregory Bartholomew
    SSLOptions +StdEnvVars
259 13 Gregory Bartholomew
</Directory>
260 13 Gregory Bartholomew
261 13 Gregory Bartholomew
SetEnvIf User-Agent ".*MSIE.*" \
262 13 Gregory Bartholomew
         nokeepalive ssl-unclean-shutdown \
263 13 Gregory Bartholomew
         downgrade-1.0 force-response-1.0
264 13 Gregory Bartholomew
</code></pre>
265 13 Gregory Bartholomew
266 13 Gregory Bartholomew
In conf.d/ssl.conf:
267 13 Gregory Bartholomew
268 13 Gregory Bartholomew
<pre><code class="apache">LoadModule ssl_module modules/mod_ssl.so
269 1 Felix Schäfer
SSLPassPhraseDialog exec:/usr/libexec/httpd-ssl-pass-dialog
270 1 Felix Schäfer
SSLSessionCache         shmcb:/var/cache/mod_ssl/scache(512000)
271 1 Felix Schäfer
SSLSessionCacheTimeout  300
272 13 Gregory Bartholomew
SSLMutex default
273 13 Gregory Bartholomew
SSLRandomSeed startup file:/dev/urandom  256
274 13 Gregory Bartholomew
SSLRandomSeed connect builtin
275 13 Gregory Bartholomew
SSLCryptoDevice builtin
276 13 Gregory Bartholomew
</code></pre>
277 17 Mr. DTTH
278 17 Mr. DTTH
You will also need to have the perl modules Net::LDAP, Authen::Simple, and Authen::Simple::LDAP installed.  The first two are available in Fedora's default package repositories.  
279 17 Mr. DTTH
280 13 Gregory Bartholomew
The third must be installed after the other two and it must be obtained directly from cpan.  Below are the commands that I used to install these packages on Fedora 17.
281 15 Gregory Bartholomew
282 13 Gregory Bartholomew
yum -y install gcc make perl-LDAP perl-Authen-Simple
283 13 Gregory Bartholomew
cpan
284 1 Felix Schäfer
cpan> install Authen::Simple::LDAP