doc/post-commit.mdwn

   1 The best way to run ikiwiki in a [[Subversion]] post-commit hook is using
   2 a wrapper, which can be generated using `ikiwiki --wrapper`.
   3
   4 First, set up the subversion checkout that ikiwiki will update and compile
   5 into your wiki at each subversion commit. Run ikiwiki a few times by hand
   6 to get a feel for it. Now, generate the wrapper by adding "--wrapper"
   7 to whatever command line you've been using to run ikiwiki. For example:
   8
   9         ~/wiki-checkout> ikiwiki . ~/public_html/wiki
  10         ~/wiki-checkout> ikiwiki . ~/public_html/wiki --wrapper
  11         successfully generated ikiwiki-wrap
  12
  13 The generated wrapper is a C program that is designed to safely be made
  14 suid if necessary. It's hardcoded to run ikiwiki with the settings
  15 specified when you ran --wrapper, and can only be used to update and
  16 compile that one checkout into the specified html directory.
  17
  18 Now, put the wrapper somewhere convenient, and create a post-commit hook
  19 script in your subversion repository for the wiki. All the post-commit
  20 hook has to do is run the wrapper (with no parameters).
  21
  22 Depending on your Subversion setup, the post-commit hook might end up
  23 getting called by users who have write access to subversion, but not to
  24 your wiki checkout and html directory. If so, you can safely make
  25 ikiwiki-wrap suid to a user who can write there (*not* to root!). You might
  26 want to read [[Security]] first.