# but this clone is owned by ikiwiki so its working-copy content
# should never be edited manually, nor should anybody clone from or
# push to this repository. To make this quite clear, I suggest hiding
-# the checkout inside the repository as show below.
+# the checkout inside the repository as shown below.
#
# To set this up, just do:
#
# git clone $gitrepo ikiwiki-checkout
#
# And then push into $gitrepo this ikiwiki.setup file, a templates/
-# directory, and a src/ directory with your wiki content.
+# directory, and a src/ directory with your wiki content. See README
+# for more details.
#
# Also, see the destdir and url parameters below which must also be
# configured before things will work at all.
our ($gitrepo, $checkout);
BEGIN {
- $gitrepo = '/path/to/bare/git/repo';
+ $gitrepo = "/path/to/bare/git/repo";
$checkout = "$gitrepo/ikiwiki-checkout";
}
# Everything else can be customised on an as-needed basis
srcdir => "$checkout/src",
templatedir => "$checkout/templates",
- underlaydir => "$checkout/underlay",
+
+ # There's not really much point to having an underlay come
+ # from the same place as the rest of the source like this:
+ #
+ # underlaydir => "$checkout/underlay",
+ #
+ # since you might as well put such content in src/ instead of
+ # in underlay. I suppose if you have some files common to
+ # several separate wiki instances then the underlay might
+ # still be useful. But for now, we'll just leave it off.
+ underlaydir = "/dev/null",
# Git stuff.
rcs => "git",
# Only send cookies over SSL connections.
#sslcookie => 1,
# Logging settings:
- verbose => 0,
+
+ # It's stupid to set verbose to 0 here since it's the default
+ # anyway, and it has the side effect of making --verbose on
+ # the command-line not work.
+ # verbose => 0,
+
syslog => 0,
# To link to user pages in a subdirectory of the wiki.
#userdir => "users",