doc/todo/git-annex_support.mdwn

   1 A dear [[wishlist]] which would resolve [[this question|forum/ikiwiki_and_big_files]]: ikiwiki should support git-annex repositories.
   2
   3 I am not sure how this would work, but from my POV, it should do a `git annex get` when new commits are pushed to its bare repo. This would assume, of course, that there's another repo somewhere that ikiwiki has access to, which works for HTTP-style remotes, but could be more problematic for SSH remotes that require a key.
   4
   5 Another solution would be to make ikiwiki a remote itself and allow users to push big files to it. The only problem I see with this is those files would end up in the bare repository and not necessarily show up in the web rendering. Ideally, a big file pushed would be hardlinked between the two repos, but it seems [git-annex doesn't support that yet](http://git-annex.branchable.com/todo/wishlist:_use_hardlinks_for_local_clones). --[[anarcat]]
   6
   7 > One technical problem with this is that ikiwiki doesn't allow symlinks
   8 > for [[security]], but git-annex relies on symlinks (unless you're in
   9 > direct mode, but I'm not sure that's really desirable here).
  10 > I'd like to make symlinks possible without compromising security,
  11 > but it'll be necessary to be quite careful. --[[smcv]]
  12
  13 First implementation
  14 ====================
  15
  16 So as the [[discussion]] shows, it seems it's perfectly possible to actually do this! There's this [gallery site](http://stockholm.kalleswork.net) which uses the [[plugins/contrib/album]] plugin and git-annex to manage its files.
  17
  18 The crucial steps are:
  19
  20  1. setup a git annex remote in `$srcdir`
  21
  22  2. configure direct mode because ikiwiki ignores symlinks for [[security]] reasons:
  23
  24         cd $srcdir
  25         git annex init
  26         git annex direct
  27
  28  3. configure files to be considered by git-annex (those will be not committed into git directly):
  29
  30         git config annex.largefiles 'largerthan=100kb and not (include=*.mdwn or include=*.txt)'
  31
  32  2. make the bare repository (the remote of `$srcdir`) ignored by git-annex:
  33
  34         cd $srcdir
  35         git config remote.origin.annex-ignore true
  36         git config remote.origin.annex-sync false
  37
  38     (!) This needs to be done on *ANY* clone of the repository, which is annoying, but it's important because we don't want to see git-annex stuff in the bare repo. (why?)
  39
  40 This assumes you know what `srcdir`, `repository` and so on mean, if you forgot (like me), see this reference: [[rcs/git/]].
  41
  42 What doesn't work
  43 -----------------
  44
  45 With a recent version of git-annex: mostly everything. :) Since git-annex in `direct` mode now [sets the repository as bare](http://git-annex.branchable.com/devblog/day_48__direct_mode_guard_design/), *nothing* gets committed at all.
  46
  47 What would need to happen in ikiwiki would be to detect that `$srcdir` is running git-annex in direct mode and then do some magic. Here is a tentative incantation in shell:
  48
  49     if [ $(git config core.bare) == 'true' ] &&
  50        [ $(git config annex.direct) == 'true' ]; then
  51         git annex add --auto
  52         git -c core.bare=false commit -m'testing git-annex with ikiwiki'
  53     fi
  54
  55 This probably needs to happen around line 571 of `git.pm` or, more likely, in a new `git-annex` plugin.
  56
  57 What remains to be clarified
  58 ----------------------------
  59
  60  * how do files get pushed to the `$srcdir`? Only through the web interface?
  61  * why do we ignore the bare repository?
  62
  63 See the [[discussion]] for a followup on that. --[[anarcat]]