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

Loren Sands-Ramshaw, 2011-07-25 22:01

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 1 Felix Schäfer
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. 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.
8 1 Felix Schäfer
9 7 Felix Schäfer
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. This is a wiki page, feel free to correct or amend anything you find lacking :-) You can also "drop me a line":/users/3866.
10 7 Felix Schäfer
11 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.
12 1 Felix Schäfer
13 1 Felix Schäfer
h2. Prerequisites
14 1 Felix Schäfer
15 1 Felix Schäfer
* Apache with mod_perl (access control)
16 1 Felix Schäfer
* git (version at least 1.6.6)
17 1 Felix Schäfer
* A way to serve git-smart-http
18 1 Felix Schäfer
** 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
19 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)
20 1 Felix Schäfer
21 6 Felix Schäfer
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. 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).
22 2 Felix Schäfer
23 2 Felix Schäfer
h2. Install grack
24 1 Felix Schäfer
25 3 Felix Schäfer
h3. Get the sources
26 2 Felix Schäfer
27 2 Felix Schäfer
Fetch grack from its "github repository":http://github.com/schacon/grack, I checked out mine to @/var/www/git.myhost.com@:
28 2 Felix Schäfer
29 5 Holger Just
<pre><code class="bash">git clone http://github.com/schacon/grack.git /var/www/git.myhost.com</code></pre>
30 1 Felix Schäfer
31 3 Felix Schäfer
h3. Configuration
32 3 Felix Schäfer
33 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):
34 2 Felix Schäfer
35 2 Felix Schäfer
<pre><code class="ruby">$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/lib')
36 2 Felix Schäfer
37 2 Felix Schäfer
use Rack::ShowExceptions
38 2 Felix Schäfer
39 2 Felix Schäfer
require 'lib/git_http'
40 2 Felix Schäfer
41 2 Felix Schäfer
config = {
42 2 Felix Schäfer
  :project_root => "/var/git/git.myhost.com",
43 2 Felix Schäfer
  :git_path => '/usr/libexec/git-core/git',
44 2 Felix Schäfer
  :upload_pack => true,
45 2 Felix Schäfer
  :receive_pack => true,
46 2 Felix Schäfer
}
47 2 Felix Schäfer
48 2 Felix Schäfer
run GitHttp::App.new(config)</code></pre>
49 1 Felix Schäfer
50 3 Felix Schäfer
h3. Integrate with Apache
51 3 Felix Schäfer
52 3 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. 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. 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.
53 3 Felix Schäfer
54 2 Felix Schäfer
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. 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!
55 2 Felix Schäfer
56 2 Felix Schäfer
The last step is to configure an apache vhost to serve the application:
57 2 Felix Schäfer
58 2 Felix Schäfer
<pre><code class="apache"><VirtualHost yo.ur.i.p:80>
59 2 Felix Schäfer
    ServerName git.myhost.com
60 2 Felix Schäfer
61 2 Felix Schäfer
    ServerAdmin root@myhost.com
62 2 Felix Schäfer
    DocumentRoot "/var/www/git.myhost.com/public"
63 2 Felix Schäfer
64 2 Felix Schäfer
    <Directory "/var/www/git.myhost.com/public">
65 2 Felix Schäfer
        Options None
66 2 Felix Schäfer
        AllowOverride None
67 2 Felix Schäfer
        Order allow,deny
68 2 Felix Schäfer
        Allow from all
69 2 Felix Schäfer
    </Directory>
70 2 Felix Schäfer
</VirtualHost></code></pre>
71 2 Felix Schäfer
72 1 Felix Schäfer
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.
73 3 Felix Schäfer
74 3 Felix Schäfer
h2. Access control
75 3 Felix Schäfer
76 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.
77 3 Felix Schäfer
78 3 Felix Schäfer
h3. Applying the patch
79 3 Felix Schäfer
80 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@, if it still borks, ask for advice on #4905).
81 3 Felix Schäfer
82 8 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.
83 3 Felix Schäfer
84 3 Felix Schäfer
h3. Configuring Apache
85 3 Felix Schäfer
86 9 Loren Sands-Ramshaw
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). 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/@).
87 3 Felix Schäfer
88 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):
89 3 Felix Schäfer
90 3 Felix Schäfer
<pre><code class="apache"><VirtualHost yo.ur.i.p:80>
91 3 Felix Schäfer
    ServerName git.myhost.com
92 3 Felix Schäfer
93 3 Felix Schäfer
    ServerAdmin root@myhost.com
94 3 Felix Schäfer
    DocumentRoot "/var/www/git.myhost.com/public"
95 3 Felix Schäfer
96 3 Felix Schäfer
    PerlLoadModule Apache::Redmine
97 3 Felix Schäfer
98 3 Felix Schäfer
    <Directory "/var/www/git.myhost.com/public">
99 3 Felix Schäfer
        Options None
100 3 Felix Schäfer
        AllowOverride None
101 3 Felix Schäfer
        Order allow,deny
102 3 Felix Schäfer
        Allow from all
103 3 Felix Schäfer
    </Directory>
104 3 Felix Schäfer
105 3 Felix Schäfer
    <Location "/">
106 3 Felix Schäfer
        AuthType Basic
107 3 Felix Schäfer
        AuthName "Redmine git repositories"
108 3 Felix Schäfer
        Require valid-user
109 3 Felix Schäfer
110 3 Felix Schäfer
        PerlAccessHandler Apache::Authn::Redmine::access_handler
111 3 Felix Schäfer
        PerlAuthenHandler Apache::Authn::Redmine::authen_handler
112 3 Felix Schäfer
113 3 Felix Schäfer
        ## for mysql
114 3 Felix Schäfer
        RedmineDSN "DBI:mysql:database=databasename;host=my.db.server"
115 3 Felix Schäfer
        ## for postgres
116 3 Felix Schäfer
        # RedmineDSN "DBI:Pg:dbname=databasename;host=my.db.server"
117 3 Felix Schäfer
        ## for SQLite3
118 3 Felix Schäfer
        # RedmineDSN "DBI:SQLite:dbname=database.db"
119 3 Felix Schäfer
120 3 Felix Schäfer
        RedmineDbUser "redmine"
121 3 Felix Schäfer
        RedmineDbPass "password"
122 3 Felix Schäfer
        RedmineGitSmartHttp yes
123 3 Felix Schäfer
    </Location>
124 3 Felix Schäfer
</VirtualHost></code></pre>
125 3 Felix Schäfer
126 3 Felix Schäfer
Reload your apache, and everything should be good and well :-)
127 3 Felix Schäfer
128 3 Felix Schäfer
h2. Known issues
129 3 Felix Schäfer
130 3 Felix Schäfer
Currently none…