]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/tips/laptop_wiki_with_git.mdwn
updated branch; this is ready for review for inclusion in IkIWiki
[git.ikiwiki.info.git] / doc / tips / laptop_wiki_with_git.mdwn
index e9eee4a8a0b689b747f779832e57b68915b65ee3..9d11c2fe40978da2161b380b4cfa685b7645b1c2 100644 (file)
@@ -1,4 +1,5 @@
 [[!toc]]
+[[!meta date="2007-10-22 01:45:55 +0000"]]
 
 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
@@ -19,9 +20,6 @@ for setting up ikiwiki with git.
 Next, `git clone` the source (`$REPOSITORY`, not `$SRCDIR`)
 from the server to the laptop.
 
-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:
 
@@ -29,7 +27,7 @@ is standard, but a few special settings are needed:
   be written to the `post-commit` hook of the git clone, rather than the
   usual `post-update` hook.
   
-    git_wrapper: /home/user/foo-wiki/.git/post-commit
+    git_wrapper: /home/user/foo-wiki/.git/hooks/post-commit
 
 * 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
@@ -44,7 +42,7 @@ is standard, but a few special settings are needed:
   and configure it so that each page links to the corresponding page on the
   server.
 
-Now just run `ikiwiki -setup wiki.setup -getctime` and you should be
+Now just run `ikiwiki --setup wiki.setup --getctime` and you should be
 good to go. (You only need the slow `-getctime` option the first time you
 run setup.) If you have taken your `wiki.setup` file from an existing
 wiki, you may need to change certain parameters to adapt to the paths
@@ -54,19 +52,27 @@ on your laptop, a few examples:
     destdir: /home/user/public_html
     # optional
     url: http://foo-wiki.localhost
-    # disable CGI, unless you want to get really funky
-    cgiurl: 
-    cgi_wrapper: 
     libdir: /home/user/foo-wiki/.ikiwiki
     ENV:
         TMPDIR: /home/user/tmp
     cookiejar:
         file:
 
+Now, set up a [[web_server|dot_cgi]] on your laptop, if it doesn't
+already have one. You can also skip that step if you want only to
+render the wiki and not allow edition, in which case you'll want the
+following:
+
+    # disable CGI, unless you want to get really funky
+    cgiurl: 
+    cgi_wrapper: 
+
+You can also direct people to the main server for web edition there.
+
 Use standard git commands to handle pulling from and pushing to the server.
 
 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`.
+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.