git.cworth.org Git - ikiwiki-bootstrap/blob - README

   1 This is a simple set of files for bootstrapping a git-backed instance
   2 of ikiwiki.
   3
   4 I put this together to make it easier to get started with ikiwiki than
   5 following the standad instructions:
   6
   7         http://ikiwiki.info/setup/
   8
   9 Features
  10 ========
  11 Here are some of the key features of what I've got setup:
  12
  13 1. Self-contained.
  14
  15         The ikiwiki configuration file, the templates, and source
  16         files are all together in one repository.
  17
  18 2. Minimal
  19
  20         The default ikiwiki setup instructions would pull in a bunch
  21         of "stock" wiki pages and some underlay content. This setup
  22         saves you the hassle of having to prune any of that out.
  23
  24 3. Pre-configured for git
  25
  26         Most of the git-specific settings you need are already setup
  27         in ikiwiki.setup. One that is not is that the generated
  28         wrapper is placed into ikiwiki-post-update rather than going
  29         directly into git's post-update---so you will have to manually
  30         edit post-update to call ikiwiki-post-update, (perhaps in
  31         addition to anything else you want to do in post-update). See
  32         below.
  33
  34 Usage
  35 =====
  36 To start choose where the bare git repository will exist on your web
  37 server and where you'd like the HTML results to be published to. Edit
  38 ikiwiki.setup and fill these in for gitrepo and destdir.
  39
  40 Next, follow these steps to setup gitrepo along with a nested checkout
  41 inside of it that ikiwiki will use:
  42
  43         mkdir -p $gitrepo
  44         cd $gitrepo
  45         GIT_DIR=. git init-db
  46
  47 Then, push the contents of this repository out to $gitrepo and
  48 continue with the following commands (still with $gitrepo as the
  49 current working directory):
  50
  51         git clone $gitrepo ikiwiki-checkout
  52         cd ikiwiki-checkout
  53         ikiwiki --setup ikiwiki.setup
  54
  55 And finally, edit $gitrepo/hooks/post-update to call the new
  56 $gitrepo/hooks/ikiwiki-post-update program and also don't forget to
  57 actually enable the hook with:
  58
  59         chmod a+x $gitrepo/hooks/post-update .
  60
  61 Now, you're finally ready to go, and you should be able to just start
  62 adding content under the src directory and use "git push" to publish
  63 them. To preview things locally, just run "ikiwiki --setup
  64 ikiwiki.setup", (and ensure the destination paths exist on the local
  65 machine as well).
  66
  67 Let me know if you have any problems or questions,
  68
  69 Carl Worth <cworth@cworth.org>