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/log/tip/[[file]]", # hg serve'd local repository
  44         #diffurl => "http://localhost:8000/?fd=[[r2]];file=[[file]]",
  45
  46         # Bazaar stuff.
  47         #rcs => "bzr",
  48         #historyurl => "",
  49         #diffurl => "http://example.com/revision?start_revid=[[r2]]#[[file]]-s", # using loggerhead
  50
  51         # Monotone stuff
  52         #rcs => "monotone",
  53         #mtnkey => "web\@machine.company.com",
  54         #historyurl => "http://viewmtn.example.com/branch/head/filechanges/com.example.branch/[[file]]",
  55         #diffurl => "http://viewmtn.example.com/revision/diff/[[r1]]/with/[[r2]]/[[file]]",
  56         # Set if you want the wiki to sync on update and commit.
  57         #mtnsync => 0,
  58         # The path to your workspace (defaults to the srcdir itself)
  59         # e.g. use if your srcdir is a subdirectory of the workspace.
  60         #mtnrootdir => "path/to/root/of/workspace",
  61
  62         wrappers => [
  63                 #{
  64                 #       # The cgi wrapper.
  65                 #       cgi => 1,
  66                 #       wrapper => "/var/www/wiki/ikiwiki.cgi",
  67                 #       wrappermode => "06755",
  68                 #},
  69                 #{
  70                 #       # The svn post-commit wrapper.
  71                 #       # Note that this will overwrite any existing
  72                 #       # post-commit hook script, which may not be
  73                 #       # what you want.
  74                 #       wrapper => "/svn/wikirepo/hooks/post-commit",
  75                 #       wrappermode => "04755",
  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 => "06755",
  87                 #},
  88                 #{
  89                 #       # The monotone netsync hook.
  90                 #       wrapper => "path/to/root/of/workspace/_MTN/ikiwiki-netsync-hook",
  91                 #       wrappermode => "06755",
  92                 #},
  93         ],
  94
  95         # Default to generating rss feeds for pages with feeds?
  96         #rss => 1,
  97         # Default to generating atom feeds for pages with feeds?
  98         #atom => 1,
  99         # Allow generating feeds even if not generated by default?
 100         #allowrss => 1,
 101         #allowatom => 1,
 102         # Urls to ping with XML-RPC when feeds are updated
 103         #pingurl => [qw{http://rpc.technorati.com/rpc/ping}],
 104         # Include discussion links on all pages?
 105         discussion => 1,
 106         # To exclude files matching a regexp from processing. This adds to
 107         # the default exclude list.
 108         #exclude => qr/\.wav$/,
 109         # To change the extension used for generated html files.
 110         #htmlext => 'htm',
 111         # Time format (for strftime)
 112         #timeformat => '%c',
 113         # Locale to use. Must be a UTF-8 locale.
 114         #locale => 'en_US.UTF-8',
 115         # Only send cookies over SSL connections.
 116         #sslcookie => 1,
 117         # Logging settings:
 118         #verbose => 1,
 119         syslog => 0,
 120         # To link to user pages in a subdirectory of the wiki.
 121         #userdir => "users",
 122         # To create output files named page.html rather than page/index.html.
 123         #usedirs => 0,
 124         # Simple spam prevention: require an account-creation password.
 125         #account_creation_password => "example",
 126         # Uncomment to force ikiwiki to run with a particular umask.
 127         #umask => 022,
 128         # Default settings for the recentchanges page.
 129         #recentchangespage => "recentchanges",
 130         #recentchangesnum => 100,
 131         # Use new '!'-prefixed preprocessor directive syntax
 132         #prefix_directives => 0,
 133         # Attempt to make hardlinks to source files instead of copying them.
 134         # Useful if the wiki contains large media files.
 135         #hardlink => 1,
 136
 137         # To add plugins, list them here.
 138         #add_plugins => [qw{goodstuff search wikitext camelcase
 139         #                   htmltidy fortune sidebar map rst anonok}],
 140         # If you want to disable any of the default plugins, list them here.
 141         #disable_plugins => [qw{inline htmlscrubber passwordauth openid}],
 142         # To add a directory to the perl search path, use this.
 143         #libdir => "/home/me/.ikiwiki/",
 144
 145         # For use with the tag plugin, make all tags be located under a
 146         # base page.
 147         #tagbase => "tag",
 148
 149         # For use with the search plugin if your estseek.cgi is located
 150         # somewhere else.
 151         #estseek => "/usr/lib/estraier/estseek.cgi",
 152
 153         # For use with the openid plugin, to give an url to a page users
 154         # can use to signup for an OpenID.
 155         #openidsignup => "http://myopenid.com/",
 156
 157         # For use with the mirrorlist plugin, a list of mirrors.
 158         #mirrorlist => {
 159         #       mirror1 => "http://hostname1",
 160         #       mirror2 => "http://hostname2/mirror",
 161         #},
 162
 163         # For use with the anonok plugin, a PageSpec specifying what
 164         # pages anonymous users can edit
 165         #anonok_pagespec => "*",
 166
 167         # For use with the aggregate plugin, to allow aggregation to be
 168         # triggered via the web.
 169         #aggregate_webtrigger => 1,
 170
 171         # For use with the pinger plugin, how many seconds to wait before
 172         # timing out.
 173         #pinger_timeout => 15.
 174
 175         # For use with the amazon S3 plugin, your public access key id.
 176         #amazon_s3_key_id => 'XXXXXXXXXXXXXXXXXXXX',
 177         # And a file holding your secret key. This file *must* not be
 178         # readable by others!
 179         #amazon_s3_key_file => "/home/me/.hide/.s3_key
 180         # The globally unique name of the bucket to use to store the wiki.
 181         #amazon_s3_bucket => "mywiki",
 182         # A prefix to prepend to each page name.
 183         #amazon_s3_prefix => "wiki/",
 184         # Uncomment to use the S3 European datacenter.
 185         #amazon_s3_location => "EU",
 186         # Uncomment if you need to store each index file twice.
 187         #amazon_s3_dupindex => 1,
 188 }