2 # Configuration file for ikiwiki.
3 # Passing this to ikiwiki --setup will make ikiwiki generate wrappers and
6 # Remember to re-run ikiwiki --setup any time you edit this file.
8 # The gitrepo parameter should point to a bare git repository which is
9 # cloned from and pushed to by anyone using git to maintain the wiki.
11 # The checkout parameter should point to a clone of that repository,
12 # but this clone is owned by ikiwiki so its working-copy content
13 # should never be edited manually, nor should anybody clone from or
14 # push to this repository. To make this quite clear, I suggest hiding
15 # the checkout inside the repository as show below.
17 # To set this up, just do:
21 # GIT_DIR=. git init-db
22 # git clone $gitrepo ikiwiki-checkout
24 # And then push into $gitrepo this ikiwiki.setup file, a templates/
25 # directory, and a src/ directory with your wiki content.
27 # Also, see the destdir and url parameters below which must also be
28 # configured before things will work at all.
30 our ($gitrepo, $checkout);
33 $gitrepo = '/path/to/bare/git/repo';
34 $checkout = "$gitrepo/ikiwiki-checkout";
37 use IkiWiki::Setup::Standard {
39 # These (along with gitrepo above) must be configured
40 # correctly before anything will work
41 destdir => "/var/www/wiki",
42 url => "http://example.org/wiki",
43 cgiurl => "http://example.org/ikiwiki.cgi",
45 # And you'll likely want to customise these as well
47 #adminuser => ["yourname", ],
48 adminemail => 'me@example.org',
50 # Everything else can be customised on an as-needed basis
51 srcdir => "$checkout/src",
52 templatedir => "$checkout/templates",
54 # There's not really much point to having an underlay come
55 # from the same place as the rest of the source like this:
57 # underlaydir => "$checkout/underlay",
59 # since you might as well put such content in src/ instead of
60 # in underlay. I suppose if you have some files common to
61 # several separate wiki instances then the underlay might
62 # still be useful. But for now, we'll just leave it off.
63 underlaydir = "/dev/null",
67 #historyurl => "http://git.example.org/gitweb.cgi?p=wiki.git;a=history;f=[[file]]",
68 #diffurl => "http://git.example.org/gitweb.cgi?p=wiki.git;a=blobdiff;h=[[sha1_to]];hp=[[sha1_from]];hb=[[sha1_parent]];f=[[file]]",
69 gitorigin_branch => "origin",
70 gitmaster_branch => "master",
76 # wrapper => "/var/www/wiki/ikiwiki.cgi",
77 # wrappermode => "06755",
80 # Instead of overwriting git's post-update script
81 # we generate a new program that can be called by
82 # post-update as desired.
83 wrapper => "$gitrepo/hooks/ikiwiki-post-update",
84 wrappermode => "04755",
85 # Enable mail notifications of commits.
90 # Generate rss feeds for blogs?
92 # Generate atom feeds for blogs?
94 # Urls to ping with XML-RPC when rss feeds are updated
95 #pingurl => [qw{http://rpc.technorati.com/rpc/ping}],
96 # Include discussion links on all pages?
98 # To exclude files matching a regexp from processing. This adds to
99 # the default exclude list.
100 #exclude => qr/*\.wav/,
101 # Time format (for strftime)
103 # Locale to use. Must be a UTF-8 locale.
104 #locale => 'en_US.UTF-8',
105 # Only send cookies over SSL connections.
110 # To link to user pages in a subdirectory of the wiki.
112 # To create output files named page.html rather than page/index.html.
114 # Simple spam prevention: require an account-creation password.
115 #account_creation_password => "example",
117 # To add plugins, list them here.
118 #add_plugins => [qw{goodstuff search wikitext camelcase
119 # htmltidy fortune sidebar map rst anonok}],
120 # If you want to disable any of the default plugins, list them here.
121 #disable_plugins => [qw{inline htmlscrubber passwordauth openid}],
123 # For use with the tag plugin, make all tags be located under a
127 # For use with the search plugin if your estseek.cgi is located
129 #estseek => "/usr/lib/estraier/estseek.cgi",
131 # For use with the openid plugin, to give an url to a page users
132 # can use to signup for an OpenID.
133 #openidsignup => "http://myopenid.com/",
135 # For use with the mirrorlist plugin, a list of mirrors.
137 # mirror1 => "http://hostname1",
138 # mirror2 => "http://hostname2/mirror",