doc/rcs/git.mdwn

   1 [[meta title="Git"]]
   2
   3 [Git][git] is a distributed revison control system originally developed for
   4 the Linux kernel. Ikiwiki supports storing a wiki in git.
   5
   6 [git]: http://git.or.cz/
   7
   8 Ikiwiki can run as a `post-update` hook to update a wiki whenever commits
   9 come in. When running as a [[cgi]] with Git, ikiwiki automatically
  10 commits edited pages, and uses the Git history to generate the
  11 [[RecentChanges]] page.
  12
  13 ## git repository setup
  14
  15 The suggested setup for git is a set of repositories setup like a
  16 shallow, single level tree, with a bare repository (meaning that it
  17 does not have a working tree checked out) at the root, and various
  18 working clones (with working directories) as leaf nodes.  The root
  19 (bare) repository is meant to be pushed to and pulled from the various
  20 working clones.
  21
  22 One of the leaf node clone repositories is special; it has working
  23 directory which is used to compile the wiki from, and is also used by the
  24 [[cgi]] to commit changes made via the web interface. It is special
  25 since the `post-commit` hook for the bare root repository is used to
  26 trigger an update of this repository, and then an ikiwiki refresh
  27 updates the published  wiki itself.
  28
  29 The other (optional) leaf node repositories are meant for you to work
  30 on, and commit to, changes should then be pushed to the bare root
  31 repository.  In theory, you could work on the same leaf node repository
  32 that ikiwiki uses to compile the wiki from, and the [[cgi]] commits
  33 to, as long as you ensure that permissions and ownership don't hinder
  34 the working of the [[cgi]]. This can be done, for example, by using
  35 ACL's, in practice, it is easier to just setup separate clones for
  36 yourself.
  37
  38 So, to reiterate, when using Git, you probably want to set up three
  39 repositories:
  40
  41 * The root repository. This should be a bare repository (meaning that it does not have a working tree checked out), which the other repositories will push to/pull from.  It is a bare repository, since there are problems pushing to a repository that has a working directory. This is called _repository_ in [[ikiwiki-makerepo]]'s  manual page. Nominally, this bare repository has a `post-commit` hook that would change directory to the ikiwiki leaf node repository below (the working directory for ikiwiki), do a _git pull_, and refresh ikiwiki to regenerate the wiki with any new content.
  42 * The second repository is a clone of the bare root repository, and has a working tree which is used as ikiwiki's srcdir for compiling the wiki. **Never** push to this repository. When running as a [[cgi]], the changes are committed to this repository, and pushed to the master repository above. This is called _srcdir_ in [[ikiwiki-makerepo]]'s manual page.
  43 * The other (third, fourth, fifth, sixth -- however many pleases you) repositories are also clones of the bare root repository above -- and these have a working directory for you to work on. Use either the `git` transport (if available), or `ssh`. These repositories may be on remote machines, your laptop, whereever you find convenient to hack on your wiki. Any new content should be pushed to the bare master repository when you are ready to publish it, and then the post-commit hook of the bare repository will ensure that the ikiwiki's source directory is updated, and the ikiwiki refreshed with the new content.
  44
  45 [[ikiwiki-makerepo]] can automate setting this up. Using three or more of repositories isn't the most obvious set up, but it works the best for typical ikiwiki use.  [[tips/Laptop_wiki_with_git]] describes a different way to set up ikiwiki and git.
  46
  47 It is **paramount** that you **never** push to the non-bare repository
  48 ([this FAQ entry explains why](http://git.or.cz/gitwiki/GitFaq#head-b96f48bc9c925074be9f95c0fce69bcece5f6e73)).
  49 Instead, clone the bare repository as mentioned above, and push **only** to the bare repository.
  50
  51 The ikiwiki `post-commit` hook should be put in the bare repository.
  52
  53 ## git repository with multiple committers
  54
  55 It can be tricky to get the permissions right to allow multiple people to
  56 commit to an ikiwiki git repository. As the [[security]] page mentions,
  57 for a secure ikiwiki installation, only one person should be able to write
  58 to ikiwiki's srcdir. When other committers make commits, their commits
  59 should go to the bare repository, which has a `post-update` hook that uses
  60 ikiwiki to pull the changes to the srcdir.
  61
  62 One setup that will work is to put all committers in a group (say,
  63 "ikiwiki"), and use permissions to allow that group to commit to the bare git
  64 repository. Make both the post-update hook and ikiwiki.cgi be setgid
  65 to the group, as well as suid to the user who admins the wiki. The
  66 `wrappergroup` [[setup_file_option|usage]] can be used to make the wrappers
  67 be setgid to the right group. Then the srcdir, including its git
  68 repository, should only be writable by the wiki's admin, and *not* by the
  69 group. Take care that ikiwiki uses a umask that does not cause files in
  70 the srcdir to become group writable. (umask 022 will work.)