X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/b1e3da4f43befe2c8c0ce0419a47cd3c262e8391..9558a4ee840f3888625828d0f1b314880a630bd3:/doc/tips/laptop_wiki_with_git.mdwn diff --git a/doc/tips/laptop_wiki_with_git.mdwn b/doc/tips/laptop_wiki_with_git.mdwn index 0ab098128..9758beb80 100644 --- a/doc/tips/laptop_wiki_with_git.mdwn +++ b/doc/tips/laptop_wiki_with_git.mdwn @@ -1,4 +1,4 @@ -Using ikiwiki with the [[git]] backend, some interesting things can be done +Using ikiwiki with the [[rcs/git]] backend, some interesting things can be done with creating mirrors (or, really, branches) of a wiki. In this tip, I'll assume your wiki is located on a server, and you want to take a copy with you on your laptop. @@ -12,15 +12,18 @@ First, set up the wiki on the server, if it isn't already. Nothing special needs to be done here, just follow the regular instructions in [[setup]] for setting up ikiwiki with git. -Next, git clone the source from the server to the laptop. +Next, `git clone` the source (`$REPOSITORY`, not `$SRCDIR`) +from the server to the laptop. -Now, set up a web server on your laptop, if it doesn't already have one. +Now, set up a [[web_server|dot_cgi]] on your laptop, if it doesn't +already have one. Now you need to write a setup file for ikiwiki on the laptop. Mostly this is standard, but a few special settings are needed: * Configure a cgi wrapper as usual, but configure the git wrapper to - be written to the `post-commit` hook of the git clone. + be written to the `post-commit` hook of the git clone, rather than the + usual `post-update` hook. * By default, ikiwiki pulls and pushes from `origin`. This shouldn't be done on the laptop, because the origin may not be accessible (when the @@ -41,8 +44,8 @@ run setup.) Use standard git commands to handle pulling from and pushing to the server. -Note: Currently, after pulling changes, you will need to manually update -the wiki, with a command such as `ikiwiki -setup wiki.setup -refresh`. This -is because git 1.5.4 doesn't have a hook that is run locally after pulling -changes. Newer versions of git will have a `post-merge` hook that should -work for this purpose. +Note that if changes are pulled from the server, you will need to manually +update the wiki, with a command such as `ikiwiki -setup wiki.setup -refresh`. +If you'd like it to automatically update when changes are merged in, you +can simply make a symlink `post-merge` hook pointing at the `post-update` +hook ikiwiki created.