Redmine

{{>TOC}}

h1. Repositories

Redmine natively supports integration with different SCM: "Subversion":http://subversion.tigris.org/, "CVS":http://www.nongnu.org/cvs/, "Mercurial":http://www.selenic.com/mercurial/, "Darcs":http://darcs.net/, "Git":http://git.or.cz (as of r1236), and "Bazaar":http://bazaar-vcs.org/ (as of r950).

Note that you need to install the appropriate binaries on your Redmine host:

|*SCM*|*Tested with*|*Comments*|

|Subversion|1.3 & 1.4|1.3 or higher required|

|CVS|1.12.12|1.12 required, won't work with CVSNT|

|Mercurial|0.9.3| |

|Bazaar|1.0.0.candidate.1| |

|Darcs|1.0.7| |

|Git|1.5.4.2|As of r1236, slated for release with Redmine 0.7|

For exemple, if you want to access Subversion repositories in Redmine, you'll have to install the svn binaries on the Redmine host.

h2. Attaching an existing repository to a project

In the project settings, make sure that the 'Repository' module is enabled and go to the 'Repository' tab.

Select the SCM that corresponds to your repository and enter the path or URL of your repository.

*Important*: When you first browse the repository, Redmine retrieves the description of all of the existing commits and stores them in the database.

This is done only once per repository but can very long (or even time out) if your repository has hundreds of commits.

To avoid this, you can do it offline.

After having your repository declared in Redmine, run the following command:

  ruby script/runner "Repository.fetch_changesets" -e production

All commits will be retrieved in the Redmine database.

h3. Subversion repository

Usual protocols are supported (eg. @http:@, @svn:@, @file:@), just enter the URL of the repository.

Exemple:

<pre>

http://host/path/to/the/repository

</pre>

You can specify a username and password if the repository requires authentication.

Note: if you want to access the repository using @svn+ssh://@, you'll have to configure svn+ssh to be non-interactive.

This requires to setup a public/private key pair for ssh authentication.

h3. CVS repository

Enter:

* the URL of the repository (it can be either a path or a connection string, eg. @:pserver@).

* the module name

Exemple:

  :pserver:login:password@host:/path/to/the/repository

h4. Git repository

Redmine request a *bare* and *local* repository to enable browsering.

Image you want to browse the to-do list manager project Donebox: its clone URL is git://github.com/ook/donebox.git

On the server where you're running redmine, create a directory accessible by the user running your redmine server:

<pre>

$ sudo mkdir -p /var/redmine/git_repositories

$ sudo chown rails:rails /var/redmine/git_repositories

$ cd /var/redmine/git_repositories

</pre>

Note the second line: it change the owner of the newly created directory to user rails, group rails. Of course, you have to replace it according to your server settings (it can be www-data or for very bad sysadmin: root). Keep in mind this user have to be able to run the _git_ command.

Now it is time to create our bare repository:

<pre>

$ pwd

/var/redmine/git_repositories

$ git clone --bare git://github.com/ook/donebox.git

Initialized empty Git repository in /var/redmine/git_repositories/donebox/

remote: Counting objects: 401, done.

remote: Compressing objects: 100% (246/246), done.

remote: Total 401 (delta 134), reused 401 (delta 134)

Receiving objects: 100% (401/401), 179.55 KiB | 185 KiB/s, done.

Resolving deltas: 100% (134/134), done.

</pre>

You're done! Just go to your redmine project setting tab, under the repositories choose git, then put in the "Path to .git directory" */var/redmine/git_repositories/donebox/*. Save. Have a look to your repository tab: you can browse it.

Note: of course, this git repository won't update by itself. You'll have to git pull it regulary by hand or set up a cron job which will do it for you.