git.oblomov.eu Git - ikiwiki/blob - doc/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 use IkiWiki::Setup::Standard {
   9         wikiname => "MyWiki",
  10         #adminuser => ["yourname", ],
  11         adminemail => 'me@example.org',
  12
  13         # Be sure to customise these..
  14         srcdir => "/path/to/source",
  15         destdir => "/var/www/wiki",
  16
  17         url => "http://example.org/wiki",
  18         cgiurl => "http://example.org/ikiwiki.cgi",
  19         #templatedir => "/usr/share/ikiwiki/templates",
  20         #underlaydir => "/usr/share/ikiwiki/basewiki",
  21
  22         # Subversion stuff.
  23         #rcs => "svn",
  24         #historyurl => "http://svn.example.org/trunk/[[file]]",
  25         #diffurl => "http://svn.example.org/trunk/[[file]]?root=wiki&amp;r1=[[r1]]&amp;r2=[[r2]]",
  26         #svnrepo => "/svn/wiki",
  27         #svnpath => "trunk",
  28
  29         # Git stuff.
  30         #rcs => "git",
  31         #historyurl => "http://git.example.org/gitweb.cgi?p=wiki.git;a=history;f=[[file]]",
  32         #diffurl => "http://git.example.org/gitweb.cgi?p=wiki.git;a=blobdiff;h=[[sha1_to]];hp=[[sha1_from]];hb=[[sha1_parent]];f=[[file]]",
  33         #gitorigin_branch => "origin",
  34         #gitmaster_branch => "master",
  35
  36         # Tla stuff.
  37         #rcs => "tla"
  38         #historyurl => ??,
  39         #diffurl => ??,
  40
  41         # Mercurial stuff.
  42         #rcs => "mercurial",
  43         #historyurl => "http://localhost:8000/", # hg serve'd local repository
  44         #diffurl => "http://localhost:8000/?fd=[[r2]];file=[[file]]",
  45
  46         # Monotone stuff
  47         #rcs => "monotone",
  48         #mtnkey => "web\@machine.company.com",
  49         # Set if you want the wiki to sync on update and commit.
  50         #mtnsync => 0,
  51         # The path to your workspace (defaults to the srcdir itself)
  52         # e.g. use if your srcdir is a subdirectory of the workspace.
  53         #mtnrootdir => "path/to/root/of/workspace",
  54         # This is a monotone lua hook file used by ikiwiki for
  55         # inserting conflict markers. By default it will use
  56         # mtnrootdir/_MTN/mergerc. This hook will be populated with
  57         # default code the first time you use ikiwiki.  You can
  58         # change it to alter how conflict markers are inserted.
  59         #mtnmergerc => "path/to/mergerc",
  60
  61         wrappers => [
  62                 #{
  63                 #       # The cgi wrapper.
  64                 #       cgi => 1,
  65                 #       wrapper => "/var/www/wiki/ikiwiki.cgi",
  66                 #       wrappermode => "06755",
  67                 #},
  68                 #{
  69                 #       # The svn post-commit wrapper.
  70                 #       # Note that this will overwrite any existing
  71                 #       # post-commit hook script, which may not be
  72                 #       # what you want.
  73                 #       wrapper => "/svn/wikirepo/hooks/post-commit",
  74                 #       wrappermode => "04755",
  75                 #       # Enable mail notifications of commits.
  76                 #       notify => 1,
  77                 #       # Log to syslog since svn post-commit hooks
  78                 #       # hide output and errors.
  79                 #       syslog => 1,
  80                 #},
  81                 #{
  82                 #       # The git post-update wrapper.
  83                 #       # Note that this will overwrite any existing
  84                 #       # post-update hook script, which may not be
  85                 #       # what you want.
  86                 #       wrapper => "/git/wiki.git/hooks/post-update",
  87                 #       wrappermode => "04755",
  88                 #       # Enable mail notifications of commits.
  89                 #       notify => 1,
  90                 #},
  91         ],
  92
  93         # Generate rss feeds for blogs?
  94         rss => 1,
  95         # Generate atom feeds for blogs?
  96         atom => 1,
  97         # Urls to ping with XML-RPC when rss feeds are updated
  98         #pingurl => [qw{http://rpc.technorati.com/rpc/ping}],
  99         # Include discussion links on all pages?
 100         discussion => 1,
 101         # To exclude files matching a regexp from processing. This adds to
 102         # the default exclude list.
 103         #exclude => qr/*\.wav/,
 104         # To change the extension used for generated html files.
 105         #htmlext => 'htm',
 106         # Time format (for strftime)
 107         #timeformat => '%c',
 108         # Locale to use. Must be a UTF-8 locale.
 109         #locale => 'en_US.UTF-8',
 110         # Only send cookies over SSL connections.
 111         #sslcookie => 1,
 112         # Logging settings:
 113         #verbose => 1,
 114         syslog => 0,
 115         # To link to user pages in a subdirectory of the wiki.
 116         #userdir => "users",
 117         # To create output files named page.html rather than page/index.html.
 118         #usedirs => 0,
 119         # Simple spam prevention: require an account-creation password.
 120         #account_creation_password => "example",
 121
 122         # To add plugins, list them here.
 123         #add_plugins => [qw{goodstuff search wikitext camelcase
 124         #                   htmltidy fortune sidebar map rst anonok}],
 125         # If you want to disable any of the default plugins, list them here.
 126         #disable_plugins => [qw{inline htmlscrubber passwordauth openid}],
 127         # To add a directory to the perl searh path, use this.
 128         #libdir => "/home/me/.ikiwiki/",
 129
 130         # For use with the tag plugin, make all tags be located under a
 131         # base page.
 132         #tagbase => "tag",
 133
 134         # For use with the search plugin if your estseek.cgi is located
 135         # somewhere else.
 136         #estseek => "/usr/lib/estraier/estseek.cgi",
 137
 138         # For use with the openid plugin, to give an url to a page users
 139         # can use to signup for an OpenID.
 140         #openidsignup => "http://myopenid.com/",
 141
 142         # For use with the mirrorlist plugin, a list of mirrors.
 143         #mirrorlist => {
 144         #       mirror1 => "http://hostname1",
 145         #       mirror2 => "http://hostname2/mirror",
 146         #},
 147 }