X-Git-Url: http://git.tremily.us/?a=blobdiff_plain;f=doc%2Fpost-commit.mdwn;h=1c5176d428da8b3e4890cf492ebd75a34e60e194;hb=277ccb431728edc6dcb3762510182b0eb3345da1;hp=84375dad03155bf209f540912b3dc8426f11c590;hpb=f7f3b0bb7d91c74f67023e970cee71ad2ea260da;p=ikiwiki.git diff --git a/doc/post-commit.mdwn b/doc/post-commit.mdwn index 84375dad0..1c5176d42 100644 --- a/doc/post-commit.mdwn +++ b/doc/post-commit.mdwn @@ -1,9 +1,8 @@ -A post-commit hook is run every time you commit a change to your -[[subversion]] (or [[git]] or [[mercurial]]) repository. To make the wiki be updated each -time a commit is made, it can be run from (or as) a post-commit hook. +If your wiki is kept in [[revision_control|rcs]], a post-commit hook is run +every time you commit a change to your repository. -The best way to run ikiwiki in a post-commit hook is using a wrapper, which -ikiwiki is usually configured to generate using a setup file. +ikiwiki generates the "post-commit hook" once you've uncommented the relevant +section (under wrappers) in the ikiwiki.setup. The generated wrapper is a C program that is designed to safely be made suid if necessary. It's hardcoded to run ikiwiki with the settings @@ -16,4 +15,5 @@ your wiki checkout and html directory. If so, you can safely make the wrapper suid to a user who can write there (*not* to root!). You might want to read [[Security]] first. -[[Setup]] explains setting this up in more detail. +[[Setup]] explains setting this up from the start and see [[rcs/details]] to +know more.