ikiwiki (3.20130711) unstable; urgency=low
[ikiwiki.git] / 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.
3
4 ikiwiki generates the "post-commit hook" once you've uncommented the relevant
5 section (under wrappers) in the ikiwiki.setup.
6
7 The generated wrapper is a C program that is designed to safely be made
8 suid if necessary. It's hardcoded to run ikiwiki with the settings
9 specified when you ran --wrapper, and can only be used to update and
10 compile that one checkout into the specified html directory.
11
12 Depending on your setup, the post-commit hook might end up
13 getting called by users who have write access to the repository, but not to
14 your wiki checkout and html directory. If so, you can safely make
15 the wrapper suid to a user who can write there (*not* to root!). You might
16 want to read [[Security]] first.
17
18 [[Setup]] explains setting this up from the start and see [[rcs/details]] to
19 know more.