doc/post-commit.mdwn

   1 If your wiki is kept in [[revision control|rcs]], a post-commit hook is run
   2 every time you commit a change to your repository. To make the wiki be
   3 updated each time a commit is made, it can be run from (or as) a
   4 post-commit hook.
   5
   6 The best way to run ikiwiki in a post-commit hook is using a wrapper, which
   7 ikiwiki is usually configured to generate using a setup file.
   8
   9 The generated wrapper is a C program that is designed to safely be made
  10 suid if necessary. It's hardcoded to run ikiwiki with the settings
  11 specified when you ran --wrapper, and can only be used to update and
  12 compile that one checkout into the specified html directory.
  13
  14 Depending on your setup, the post-commit hook might end up
  15 getting called by users who have write access to the repository, but not to
  16 your wiki checkout and html directory. If so, you can safely make
  17 the wrapper suid to a user who can write there (*not* to root!). You might
  18 want to read [[Security]] first.
  19
  20 [[Setup]] explains setting this up in more detail.