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 shown 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. See README
28 # Also, see the destdir and url parameters below which must also be
29 # configured before things will work at all.
31 our ($gitrepo, $checkout);
34 $gitrepo = "/path/to/bare/git/repo";
35 $checkout = "$gitrepo/ikiwiki-checkout";
38 use IkiWiki::Setup::Standard {
40 # These (along with gitrepo above) must be configured
41 # correctly before anything will work
42 destdir => "/var/www/wiki",
43 url => "http://example.org/wiki",
44 cgiurl => "http://example.org/ikiwiki.cgi",
46 # And you'll likely want to customise these as well
48 #adminuser => ["yourname", ],
49 adminemail => "me@example.org",
51 # Everything else can be customised on an as-needed basis
52 srcdir => "$checkout/src",
53 templatedir => "$checkout/templates",
55 # There's not really much point to having an underlay come
56 # from the same place as the rest of the source like this:
58 # underlaydir => "$checkout/underlay",
60 # since you might as well put such content in src/ instead of
61 # in underlay. I suppose if you have some files common to
62 # several separate wiki instances then the underlay might
63 # still be useful. But for now, we'll just leave it off.
64 underlaydir = "/dev/null",
68 #historyurl => "http://git.example.org/gitweb.cgi?p=wiki.git;a=history;f=[[file]]",
69 #diffurl => "http://git.example.org/gitweb.cgi?p=wiki.git;a=blobdiff;h=[[sha1_to]];hp=[[sha1_from]];hb=[[sha1_parent]];f=[[file]]",
70 gitorigin_branch => "origin",
71 gitmaster_branch => "master",
77 # wrapper => "/var/www/wiki/ikiwiki.cgi",
78 # wrappermode => "06755",
81 # Instead of overwriting git's post-update script
82 # we generate a new program that can be called by
83 # post-update as desired.
84 wrapper => "$gitrepo/hooks/ikiwiki-post-update",
85 wrappermode => "04755",
86 # Enable mail notifications of commits.
91 # Generate rss feeds for blogs?
93 # Generate atom feeds for blogs?
95 # Urls to ping with XML-RPC when rss feeds are updated
96 #pingurl => [qw{http://rpc.technorati.com/rpc/ping}],
97 # Include discussion links on all pages?
99 # To exclude files matching a regexp from processing. This adds to
100 # the default exclude list.
101 #exclude => qr/*\.wav/,
102 # Time format (for strftime)
104 # Locale to use. Must be a UTF-8 locale.
105 #locale => 'en_US.UTF-8',
106 # Only send cookies over SSL connections.
110 # It's stupid to set verbose to 0 here since it's the default
111 # anyway, and it has the side effect of making --verbose on
112 # the command-line not work.
116 # To link to user pages in a subdirectory of the wiki.
118 # To create output files named page.html rather than page/index.html.
120 # Simple spam prevention: require an account-creation password.
121 #account_creation_password => "example",
123 # To add plugins, list them here.
124 #add_plugins => [qw{goodstuff search wikitext camelcase
125 # htmltidy fortune sidebar map rst anonok}],
126 # If you want to disable any of the default plugins, list them here.
127 #disable_plugins => [qw{inline htmlscrubber passwordauth openid}],
129 # For use with the tag plugin, make all tags be located under a
133 # For use with the search plugin if your estseek.cgi is located
135 #estseek => "/usr/lib/estraier/estseek.cgi",
137 # For use with the openid plugin, to give an url to a page users
138 # can use to signup for an OpenID.
139 #openidsignup => "http://myopenid.com/",
141 # For use with the mirrorlist plugin, a list of mirrors.
143 # mirror1 => "http://hostname1",
144 # mirror2 => "http://hostname2/mirror",