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

   1 #!/usr/bin/perl
   2 # Configuration file for ikiwiki.
   3 # Passing this to ikiwiki --setup will make ikiwiki generate wrappers and
   4 # build the wiki.
   5 #
   6 # Remember to re-run ikiwiki --setup any time you edit this file.
   7
   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.
  10 #
  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.
  16 #
  17 # To set this up, just do:
  18 #
  19 #       mkdir -p $gitrepo
  20 #       cd $gitrepo
  21 #       GIT_DIR=. git init-db
  22 #       git clone $gitrepo ikiwiki-checkout
  23 #
  24 # And then push into $gitrepo this ikiwiki.setup file, a templates/
  25 # directory, and a src/ directory with your wiki content.
  26 #
  27 # Also, see the destdir and url parameters below which must also be
  28 # configured before things will work at all.
  29
  30 my gitrepo = '/path/to/bare/git/repo';
  31 my checkout = "$gitrepo/ikiwiki-checkout";
  32
  33 use IkiWiki::Setup::Standard {
  34
  35         # These (along with gitrepo above) must be configured
  36         # correctly before anything will work
  37         destdir => "/var/www/wiki",
  38         url => "http://example.org/wiki",
  39         cgiurl => "http://example.org/ikiwiki.cgi",
  40
  41         # And you'll likely want to customise these as well
  42         wikiname => "MyWiki",
  43         #adminuser => ["yourname", ],
  44         adminemail => 'me@example.org',
  45
  46         # Everything else can be customised on an as-needed basis
  47         srcdir => "$checkout/src",
  48         templatedir => "$checkout/templates",
  49         underlaydir => "$checkout/underlay",
  50
  51         # Git stuff.
  52         rcs => "git",
  53         #historyurl => "http://git.example.org/gitweb.cgi?p=wiki.git;a=history;f=[[file]]",
  54         #diffurl => "http://git.example.org/gitweb.cgi?p=wiki.git;a=blobdiff;h=[[sha1_to]];hp=[[sha1_from]];hb=[[sha1_parent]];f=[[file]]",
  55         gitorigin_branch => "origin",
  56         gitmaster_branch => "master",
  57
  58         wrappers => [
  59                 #{
  60                 #       # The cgi wrapper.
  61                 #       cgi => 1,
  62                 #       wrapper => "/var/www/wiki/ikiwiki.cgi",
  63                 #       wrappermode => "06755",
  64                 #},
  65                 {
  66                         # Instead of overwriting git's post-update script
  67                         # we generate a new program that can be called by
  68                         # post-update as desired.
  69                         wrapper => "$gitrepo/hooks/ikiwiki-post-update",
  70                         wrappermode => "04755",
  71                         # Enable mail notifications of commits.
  72                         #notify => 1,
  73                 },
  74         ],
  75
  76         # Generate rss feeds for blogs?
  77         rss => 1,
  78         # Generate atom feeds for blogs?
  79         atom => 1,
  80         # Urls to ping with XML-RPC when rss feeds are updated
  81         #pingurl => [qw{http://rpc.technorati.com/rpc/ping}],
  82         # Include discussion links on all pages?
  83         discussion => 1,
  84         # To exclude files matching a regexp from processing. This adds to
  85         # the default exclude list.
  86         #exclude => qr/*\.wav/,
  87         # Time format (for strftime)
  88         #timeformat => '%c',
  89         # Locale to use. Must be a UTF-8 locale.
  90         #locale => 'en_US.UTF-8',
  91         # Only send cookies over SSL connections.
  92         #sslcookie => 1,
  93         # Logging settings:
  94         verbose => 0,
  95         syslog => 0,
  96         # To link to user pages in a subdirectory of the wiki.
  97         #userdir => "users",
  98         # To create output files named page.html rather than page/index.html.
  99         #usedirs => 0,
 100         # Simple spam prevention: require an account-creation password.
 101         #account_creation_password => "example",
 102
 103         # To add plugins, list them here.
 104         #add_plugins => [qw{goodstuff search wikitext camelcase
 105         #                   htmltidy fortune sidebar map rst anonok}],
 106         # If you want to disable any of the default plugins, list them here.
 107         #disable_plugins => [qw{inline htmlscrubber passwordauth openid}],
 108
 109         # For use with the tag plugin, make all tags be located under a
 110         # base page.
 111         #tagbase => "tag",
 112
 113         # For use with the search plugin if your estseek.cgi is located
 114         # somewhere else.
 115         #estseek => "/usr/lib/estraier/estseek.cgi",
 116
 117         # For use with the openid plugin, to give an url to a page users
 118         # can use to signup for an OpenID.
 119         #openidsignup => "http://myopenid.com/",
 120
 121         # For use with the mirrorlist plugin, a list of mirrors.
 122         #mirrorlist => {
 123         #       mirror1 => "http://hostname1",
 124         #       mirror2 => "http://hostname2/mirror",
 125         #},
 126 }