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=[[changeset]];file=[[file]]",
  45
  46         # Monotone stuff
  47         #rcs => "monotone",
  48         #mtnkey => "web\@machine.company.com",
  49         # Monotone options
  50         #mtnsync => 0,                              # set this if you want the wiki to sync on update and commit
  51         #mtnrootdir => "path/to/root/of/workspace", # The path to your workspace (defaults to the srcdir itself)
  52                                                     # e.g. use if your srcdir is a subdirectory of the workspace
  53         #mtnbinpath => "path/to/montone/binary",    # by default we just use "mtn" and assume it is in your path.
  54         #mtnmergerc => "path/to/mergerc",           # this is a monotone lua hook file used by ikiwiki for
  55                                                     # inserting conflict markers.  By default we 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
  60         wrappers => [
  61                 #{
  62                 #       # The cgi wrapper.
  63                 #       cgi => 1,
  64                 #       wrapper => "/var/www/wiki/ikiwiki.cgi",
  65                 #       wrappermode => "06755",
  66                 #},
  67                 #{
  68                 #       # The svn post-commit wrapper.
  69                 #       # Note that this will overwrite any existing
  70                 #       # post-commit hook script, which may not be
  71                 #       # what you want.
  72                 #       wrapper => "/svn/wikirepo/hooks/post-commit",
  73                 #       wrappermode => "04755",
  74                 #       # Enable mail notifications of commits.
  75                 #       notify => 1,
  76                 #       # Log to syslog since svn post-commit hooks
  77                 #       # hide output and errors.
  78                 #       syslog => 1,
  79                 #},
  80                 #{
  81                 #       # The git post-update wrapper.
  82                 #       # Note that this will overwrite any existing
  83                 #       # post-update hook script, which may not be
  84                 #       # what you want.
  85                 #       wrapper => "/git/wiki.git/hooks/post-update",
  86                 #       wrappermode => "04755",
  87                 #       # Enable mail notifications of commits.
  88                 #       notify => 1,
  89                 #},
  90         ],
  91
  92         # Generate rss feeds for blogs?
  93         rss => 1,
  94         # Generate atom feeds for blogs?
  95         atom => 1,
  96         # Urls to ping with XML-RPC when rss feeds are updated
  97         #pingurl => [qw{http://rpc.technorati.com/rpc/ping}],
  98         # Include discussion links on all pages?
  99         discussion => 1,
 100         # To exclude files matching a regexp from processing. This adds to
 101         # the default exclude list.
 102         #exclude => qr/*\.wav/,
 103         # To change the extension used for generated html files.
 104         #htmlext => 'htm',
 105         # Time format (for strftime)
 106         #timeformat => '%c',
 107         # Locale to use. Must be a UTF-8 locale.
 108         #locale => 'en_US.UTF-8',
 109         # Only send cookies over SSL connections.
 110         #sslcookie => 1,
 111         # Logging settings:
 112         #verbose => 1,
 113         syslog => 0,
 114         # To link to user pages in a subdirectory of the wiki.
 115         #userdir => "users",
 116         # To create output files named page.html rather than page/index.html.
 117         #usedirs => 0,
 118         # Simple spam prevention: require an account-creation password.
 119         #account_creation_password => "example",
 120
 121         # To add plugins, list them here.
 122         #add_plugins => [qw{goodstuff search wikitext camelcase
 123         #                   htmltidy fortune sidebar map rst anonok}],
 124         # If you want to disable any of the default plugins, list them here.
 125         #disable_plugins => [qw{inline htmlscrubber passwordauth openid}],
 126         # To add a directory to the perl searh path, use this.
 127         #libdir => "/home/me/.ikiwiki/",
 128
 129         # For use with the tag plugin, make all tags be located under a
 130         # base page.
 131         #tagbase => "tag",
 132
 133         # For use with the search plugin if your estseek.cgi is located
 134         # somewhere else.
 135         #estseek => "/usr/lib/estraier/estseek.cgi",
 136
 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/",
 140
 141         # For use with the mirrorlist plugin, a list of mirrors.
 142         #mirrorlist => {
 143         #       mirror1 => "http://hostname1",
 144         #       mirror2 => "http://hostname2/mirror",
 145         #},
 146 }