Gitolite is a git repository
manager. Here's how to add git-annex support to gitolite, so you can
git annex copy
files to a gitolite repository, and git annex get
files from it.
Warning : The method described here works with gitolite version g2, avaible in the g2 branch on github. There is an experimental support for g3 in the git-annex branch, if you tested it please add some feedback.
A nice feature of using gitolite with git-annex is that users can be given
read-only access to a repository, and this allows them to git annex get
file contents, but not change anything.
First, you need new enough versions:
- gitolite 2.2 is needed -- this version contains a git-annex-shell ADC and supports "ua" ADCs.
- git-annex 3.20111016 or newer needs to be installed on the gitolite server. Don't install an older version, it wouldn't be secure!
And here's how to set it up. The examples are for gitolite as installed on Debian with apt-get, but the changes described can be made to any gitolite installation, just with different paths.
Set $GL_ADC_PATH
in .gitolite.rc
, if you have not already done so.
echo '$GL_ADC_PATH = "/usr/local/lib/gitolite/adc/";' >>~gitolite/.gitolite.rc
Make the ADC directory, and a "ua" subdirectory.
mkdir -p /usr/local/lib/gitolite/adc/ua
Install the git-annex-shell ADC into the "ua" subdirectory from the gitolie repository.
cd /usr/local/lib/gitolite/adc/ua/ cp gitolite/contrib/adc/git-annex-shell .
Now all gitolite repositories can be used with git-annex just as any ssh remote normally would be used. For example:
# git clone gitolite@localhost:testing Cloning into testing... Receiving objects: 100% (18/18), done. # cd testing # git annex init init ok # cp /etc/passwd my-cool-big-file # git annex add my-cool-big-file add my-cool-big-file ok (Recording state in git...) # git commit -m added [master d36c8b4] added 1 files changed, 1 insertions(+), 0 deletions(-) create mode 120000 my-cool-big-file # git push --all Counting objects: 17, done. Delta compression using up to 2 threads. Compressing objects: 100% (12/12), done. Writing objects: 100% (14/14), 1.39 KiB, done. Total 14 (delta 0), reused 1 (delta 0) To gitolite@localhost:testing c552a38..db4653e git-annex -> git-annex 29cd204..d36c8b4 master -> master # git annex copy --to origin copy my-cool-big-file (checking origin...) (to origin...) WORM-s2502-m1318875140--my-cool-big-file 2502 100% 0.00kB/s 0:00:00 (xfer#1, to-check=0/1) sent 2606 bytes received 31 bytes 1758.00 bytes/sec total size is 2502 speedup is 0.95 ok
Troubleshooting
I got an error like this when setting up gitolite after setting up a local git repo and git annex:
git-annex-shell: First run: git-annex init Command ssh ["git@git.example.com","git-annex-shell 'configlist' '/~/myrepo.git'"] failed; exit code 1
because I forgot to "git push --all" after adding the new gitolite remote.
Looks like you are missing a closing double quote on the line:
echo '$GL_ADC_PATH = "/usr/local/lib/gitolite/adc/;' >>~gitolite/.gitolite.rc
right after /;
I got this working by the way - great stuff.
Well a repo url like
gitolite@localhost:testing
puts it in the gitolite user's /~/testingThis worked when I added the gitolite stuff, anyway.. Let's see if it still does:
Still seems right, the ADC's regexp will match this the git-annex shell command.
I guess there is some path rewriting going in in gitolite proper because if try a url of the form ssh://git@localhost/testing, then it still works with gitolite, but fails with the ADC because the repo is passed as /testing:
What I have to ask Sitaram and or find in the docs is if this is a bug or a feature in gitolite. I can see how the leading slash would get swallowed up by this line
in gl-auth-command, but I guess that isn't the whole story.
I confirmed with Sitaram that this is intentional, if probably under-documented. Since the ADC strips the leading /~/ in assigning $start anyway, I guess something like the following will work
That patch seems ok, it doesn't seem to allow through any repo locations that were blocked before.
So, it has my blessing.. but the ADC is in gitolite and will need to be patched there.
After some debugging printing, here is my current understanding.
urls of the form git@host:~repo or ssh://git@host
urls of the form git@host:/repo or ssh://git@host/repo
urls of the form git@host:repo
So the weird case is the last one where git and git-annex are sending different things over the wire. I don't know if you have other motivations for doing the url normalization on the client side, but it isn't needed for gitolite, and in some sense complicates things a little. On the other hand, now that I see what is going on, it isn't a big deal to just strip the leading /~ off in the adc. It does lead to the odd situation of some URLs working for git-annex but not git.
/~/
comes from. I don't anticipate this changing on the git-annex side.Hi,
I noticed using the git-annex branch of gitolite v3 that the same URL with ".git" at the end would not work in git-annex. For example my test repository was
git@git2.mildred.fr:u/mildred/Annex.git
but it didn't work until I converted it togit@git2.mildred.fr:u/mildred/Annex
On the server, the repository is in
repositories/u/mildred/Annex.git
If I try a copy with git-annex for example, I would get:
(test is the name of my remote and titi is my file)
Note, in my gitolite conf, I have:
The steps to activate git-annex integration have changed/simplified for v3.
1) during install, be sure to use the 'git-annex' branch, rather than master[fn:1].
2) to enable git-annex-shell, open ~/.gitolite.rc and insert 'git-annex-shell' => 'ua' into the hash list in the COMMANDS array.[fn:2]
'git-annex-shell' => 'ua',
[fn:1] We'd like to have this feature-branch merged to master, so please send Sitaram feedback, positive and negative, based on your experiences. [fn:2] There is no GL_ADC_PATH and no "ua" subdirectory here, and nothing to "install"; the command now comes with gitolite.