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 for people who are already
   5 comfortable with git to start using ikiwiki with git. If you're not
   6 already comfortable with git, then you're probably much better off
   7 learning to use ikiwiki from its standard instructions:
   8
   9         http://ikiwiki.info/setup/
  10
  11 Features
  12 ========
  13 Here are some of the key features of what I've got set up, (and that
  14 are different than following the standard instruction for integrating
  15 ikiwiki with git).
  16
  17 1. Self-contained.
  18
  19         The ikiwiki configuration file, the templates, and source
  20         files are all together in one repository.
  21
  22 2. Minimal
  23
  24         The default ikiwiki setup instructions would pull in a bunch
  25         of "stock" wiki pages and some underlay content. This setup
  26         saves you the hassle of having to prune any of that out.
  27
  28 3. Pre-configured for git
  29
  30         Most of the git-specific settings you need are already set up
  31         in ikiwiki.setup. One that is not is that the generated
  32         wrapper is placed into ikiwiki-post-update rather than going
  33         directly into git's post-update---so you will have to manually
  34         edit post-update to call ikiwiki-post-update, (perhaps in
  35         addition to anything else you want to do in post-update). See
  36         below.
  37
  38 Usage
  39 =====
  40 To start, choose where the bare git repository will exist on your web
  41 server and where you'd like the HTML results to be published to. Edit
  42 ikiwiki.setup and fill these in for gitrepo and destdir.
  43
  44 Then use the following commands to set up everything you'll need on the
  45 server:
  46
  47         mkdir -p $gitrepo
  48         cd $gitrepo
  49         GIT_DIR=. git init-db
  50
  51 Then, push the contents of this repository out to $gitrepo and
  52 continue with the following commands (still with $gitrepo as the
  53 current working directory):
  54
  55         git clone $gitrepo ikiwiki-checkout
  56         cd ikiwiki-checkout
  57         ikiwiki --setup ikiwiki.setup
  58
  59 [And yes, if you're paying attention there, we just cloned from the
  60 bare repository into a directory that is also inside that same
  61 repository. I found this a neat place to hide away the
  62 clone-with-working-tree that ikiwiki needs to edit but that you
  63 shouldn't touch. If you think this is too creepy, you could put it
  64 anywhere else, and configure ikiwiki.setup to point to it there.]
  65
  66 And finally, edit $gitrepo/hooks/post-update to call the new
  67 $gitrepo/hooks/ikiwiki-post-update program and also don't forget to
  68 actually enable the hook with:
  69
  70         chmod a+x $gitrepo/hooks/post-update .
  71
  72 Now, you're finally ready to go, and you should be able to just start
  73 adding content under the src directory and use "git push" to publish
  74 them. To preview things locally, just run "ikiwiki --setup
  75 ikiwiki.setup", (and ensure the destination paths exist on the local
  76 machine as well).
  77
  78 Let me know if you have any problems or questions,
  79
  80 Carl Worth <cworth@cworth.org>