aboutsummaryrefslogtreecommitdiff
path: root/doc/post-commit.mdwn
diff options
context:
space:
mode:
authorjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2006-06-02 05:32:20 +0000
committerjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2006-06-02 05:32:20 +0000
commit30afedcfe2799bb6cc4bf329bd273ad9d8dd6da3 (patch)
tree900d3e110a304973171b47d40977b29db24d5e7c /doc/post-commit.mdwn
parentc0f8126143852a2b1e47e2b8a7310ef6bd43bf18 (diff)
downloadikiwiki-30afedcfe2799bb6cc4bf329bd273ad9d8dd6da3.tar
ikiwiki-30afedcfe2799bb6cc4bf329bd273ad9d8dd6da3.tar.gz
* Add support for using git instead of subversion as the RCS backend,
tremendous thanks to Recai Oktaş for this. * Doc updates for git.
Diffstat (limited to 'doc/post-commit.mdwn')
-rw-r--r--doc/post-commit.mdwn29
1 files changed, 8 insertions, 21 deletions
diff --git a/doc/post-commit.mdwn b/doc/post-commit.mdwn
index 93d851959..1ce271487 100644
--- a/doc/post-commit.mdwn
+++ b/doc/post-commit.mdwn
@@ -1,32 +1,19 @@
-A post-commit hook is run every time you commit a change to your subversion
-repository. To make the wiki be updated each time a commit is made, it can
-be run from (or as) a post-commit hook.
+A post-commit hook is run every time you commit a change to your
+[[subversion]] (or [[git]]) repository. To make the wiki be updated each
+time a commit is made, it can be run from (or as) a post-commit hook.
-The best way to run ikiwiki in a [[Subversion]] post-commit hook is using
-a wrapper, which can be generated using `ikiwiki --wrapper`.
-
-First, set up the subversion checkout that ikiwiki will update and compile
-into your wiki at each subversion commit. Run ikiwiki a few times by hand
-to get a feel for it. Now, generate the wrapper by adding "--wrapper"
-to whatever command line you've been using to run ikiwiki. For example:
-
- ~/wiki-checkout> ikiwiki . ~/public_html/wiki
- ~/wiki-checkout> ikiwiki . ~/public_html/wiki --wrapper
- successfully generated ikiwiki-wrap
+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.
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
specified when you ran --wrapper, and can only be used to update and
compile that one checkout into the specified html directory.
-Now, put the wrapper somewhere convenient, and create a post-commit hook
-script in your subversion repository for the wiki. All the post-commit
-hook has to do is run the wrapper (with no parameters).
-
-Depending on your Subversion setup, the post-commit hook might end up
-getting called by users who have write access to subversion, but not to
+Depending on your setup, the post-commit hook might end up
+getting called by users who have write access to the repository, but not to
your wiki checkout and html directory. If so, you can safely make
-ikiwiki-wrap suid to a user who can write there (*not* to root!). You might
+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.