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         #svnpath => "trunk",
  27
  28         # Git stuff.
  29         #rcs => "git",
  30         #historyurl => "http://git.example.org/gitweb.cgi?p=wiki.git;a=history;f=[[file]]",
  31         #diffurl => "http://git.example.org/gitweb.cgi?p=wiki.git;a=blobdiff;h=[[sha1_to]];hp=[[sha1_from]];hb=[[sha1_parent]];f=[[file]]",
  32         #gitorigin_branch => "origin",
  33         #gitmaster_branch => "master",
  34
  35         # Tla stuff.
  36         #rcs => "tla"
  37         #historyurl => ??,
  38         #diffurl => ??,
  39
  40         # Mercurial stuff.
  41         #rcs => "mercurial",
  42         #historyurl => "http://localhost:8000/log/tip/[[file]]", # hg serve'd local repository
  43         #diffurl => "http://localhost:8000/?fd=[[r2]];file=[[file]]",
  44
  45         # Bazaar stuff.
  46         #rcs => "bzr",
  47         #historyurl => "",
  48         #diffurl => "http://example.com/revision?start_revid=[[r2]]#[[file]]-s", # using loggerhead
  49
  50         # Monotone stuff
  51         #rcs => "monotone",
  52         #mtnkey => "web\@machine.company.com",
  53         #historyurl => "http://viewmtn.example.com/branch/head/filechanges/com.example.branch/[[file]]",
  54         #diffurl => "http://viewmtn.example.com/revision/diff/[[r1]]/with/[[r2]]/[[file]]",
  55         # Set if you want the wiki to sync on update and commit.
  56         #mtnsync => 0,
  57         # The path to your workspace (defaults to the srcdir itself)
  58         # e.g. use if your srcdir is a subdirectory of the workspace.
  59         #mtnrootdir => "path/to/root/of/workspace",
  60         # This is a monotone lua hook file used by ikiwiki for
  61         # inserting conflict markers. By default it will use
  62         # mtnrootdir/_MTN/mergerc. This hook will be populated with
  63         # default code the first time you use ikiwiki.  You can
  64         # change it to alter how conflict markers are inserted.
  65         #mtnmergerc => "path/to/mergerc",
  66
  67         wrappers => [
  68                 #{
  69                 #       # The cgi wrapper.
  70                 #       cgi => 1,
  71                 #       wrapper => "/var/www/wiki/ikiwiki.cgi",
  72                 #       wrappermode => "06755",
  73                 #},
  74                 #{
  75                 #       # The svn post-commit wrapper.
  76                 #       # Note that this will overwrite any existing
  77                 #       # post-commit hook script, which may not be
  78                 #       # what you want.
  79                 #       wrapper => "/svn/wikirepo/hooks/post-commit",
  80                 #       wrappermode => "04755",
  81                 #       # Log to syslog since svn post-commit hooks
  82                 #       # hide output and errors.
  83                 #       syslog => 1,
  84                 #},
  85                 #{
  86                 #       # The git post-update wrapper.
  87                 #       # Note that this will overwrite any existing
  88                 #       # post-update hook script, which may not be
  89                 #       # what you want.
  90                 #       wrapper => "/git/wiki.git/hooks/post-update",
  91                 #       wrappermode => "06755",
  92                 #},
  93                 #{
  94                 #       # The monotone netsync hook.
  95                 #       wrapper => "path/to/root/of/workspace/_MTN/ikiwiki-netsync-hook",
  96                 #       wrappermode => "06755",
  97                 #},
  98         ],
  99
 100         # Default to generating rss feeds for blogs?
 101         #rss => 1,
 102         # Default to generating atom feeds for blogs?
 103         #atom => 1,
 104         # Allow generating feeds even if not generated by default?
 105         #allowrss => 1,
 106         #allowatom => 1,
 107         # Urls to ping with XML-RPC when rss feeds are updated
 108         #pingurl => [qw{http://rpc.technorati.com/rpc/ping}],
 109         # Include discussion links on all pages?
 110         discussion => 1,
 111         # To exclude files matching a regexp from processing. This adds to
 112         # the default exclude list.
 113         #exclude => qr/*\.wav/,
 114         # To change the extension used for generated html files.
 115         #htmlext => 'htm',
 116         # Time format (for strftime)
 117         #timeformat => '%c',
 118         # Locale to use. Must be a UTF-8 locale.
 119         #locale => 'en_US.UTF-8',
 120         # Only send cookies over SSL connections.
 121         #sslcookie => 1,
 122         # Logging settings:
 123         #verbose => 1,
 124         syslog => 0,
 125         # To link to user pages in a subdirectory of the wiki.
 126         #userdir => "users",
 127         # To create output files named page.html rather than page/index.html.
 128         #usedirs => 0,
 129         # Simple spam prevention: require an account-creation password.
 130         #account_creation_password => "example",
 131         # Uncomment to force ikiwiki to run with a particular umask.
 132         #umask => 022,
 133         # Default settings for the recentchanges page.
 134         #recentchangespage => "recentchanges",
 135         #recentchangesnum => 100,
 136         # Use new '!'-prefixed preprocessor directive syntax
 137         #prefix_directives => 0,
 138
 139         # To add plugins, list them here.
 140         #add_plugins => [qw{goodstuff search wikitext camelcase
 141         #                   htmltidy fortune sidebar map rst anonok}],
 142         # If you want to disable any of the default plugins, list them here.
 143         #disable_plugins => [qw{inline htmlscrubber passwordauth openid}],
 144         # To add a directory to the perl search path, use this.
 145         #libdir => "/home/me/.ikiwiki/",
 146
 147         # For use with the tag plugin, make all tags be located under a
 148         # base page.
 149         #tagbase => "tag",
 150
 151         # For use with the search plugin if your estseek.cgi is located
 152         # somewhere else.
 153         #estseek => "/usr/lib/estraier/estseek.cgi",
 154
 155         # For use with the openid plugin, to give an url to a page users
 156         # can use to signup for an OpenID.
 157         #openidsignup => "http://myopenid.com/",
 158
 159         # For use with the mirrorlist plugin, a list of mirrors.
 160         #mirrorlist => {
 161         #       mirror1 => "http://hostname1",
 162         #       mirror2 => "http://hostname2/mirror",
 163         #},
 164 }