wiki.conf

   1 #!/usr/bin/perl
   2 #
   3 # Setup file for ikiwiki.
   4 #
   5 # Passing this to ikiwiki --setup will make ikiwiki generate
   6 # wrappers and build the wiki.
   7 #
   8 # Remember to re-run ikiwiki --setup any time you edit this file.
   9 use IkiWiki::Setup::Standard {
  10         # name of the wiki
  11         wikiname => 'Moonshot Developer Wiki',
  12         # contact email for wiki
  13         adminemail => 'moonshot-community@jiscmail.ac.uk',
  14         # users who are wiki admins
  15         adminuser => [],
  16         # users who are banned from the wiki
  17         banned_users => [],
  18         # where the source of the wiki is located
  19         srcdir => '.',
  20         # where to build the wiki
  21         destdir => '../wiki-out',
  22         # base url to the wiki
  23         url => '',
  24         # url to the ikiwiki.cgi
  25         cgiurl => '',
  26         # filename of cgi wrapper to generate
  27         cgi_wrapper => '',
  28         # mode for cgi_wrapper (can safely be made suid)
  29         cgi_wrappermode => '06755',
  30         # rcs backend to use
  31         rcs => 'git',
  32         # plugins to add to the default configuration
  33         add_plugins => ['toc'],
  34         # plugins to disable
  35         disable_plugins => [],
  36         # additional directory to search for template files
  37         templatedir => '/usr/share/ikiwiki/templates',
  38         # base wiki source location
  39         underlaydir => '/usr/share/ikiwiki/basewiki',
  40         # display verbose messages?
  41         #verbose => 1,
  42         # log to syslog?
  43         #syslog => 1,
  44         # create output files named page/index.html?
  45         usedirs => 1,
  46         # use '!'-prefixed preprocessor directives?
  47         prefix_directives => 1,
  48         # use page/index.mdwn source files
  49         indexpages => 0,
  50         # enable Discussion pages?
  51         discussion => 1,
  52         # name of Discussion pages
  53         discussionpage => 'Discussion',
  54         # generate HTML5? (experimental)
  55         html5 => 0,
  56         # only send cookies over SSL connections?
  57         sslcookie => 0,
  58         # extension to use for new pages
  59         default_pageext => 'mdwn',
  60         # extension to use for html files
  61         htmlext => 'html',
  62         # strftime format string to display date
  63         timeformat => '%c',
  64         # UTF-8 locale to use
  65         #locale => 'en_US.UTF-8',
  66         # put user pages below specified page
  67         userdir => '',
  68         # how many backlinks to show before hiding excess (0 to show all)
  69         numbacklinks => 10,
  70         # attempt to hardlink source files? (optimisation for large files)
  71         hardlink => 0,
  72         # force ikiwiki to use a particular umask
  73         #umask => 022,
  74         # group for wrappers to run in
  75         #wrappergroup => 'ikiwiki',
  76         # extra library and plugin directory
  77         libdir => '',
  78         # environment variables
  79         ENV => {},
  80         # regexp of normally excluded files to include
  81         #include => '^\\.htaccess$',
  82         # regexp of files that should be skipped
  83         #exclude => '^(*\\.private|Makefile)$',
  84         # specifies the characters that are allowed in source filenames
  85         wiki_file_chars => '-[:alnum:]+/.:_',
  86         # allow symlinks in the path leading to the srcdir (potentially insecure)
  87         allow_symlinks_before_srcdir => 0,
  88
  89         ######################################################################
  90         # core plugins
  91         #   (editpage, htmlscrubber, inline, link, meta, parentlinks)
  92         ######################################################################
  93
  94         # htmlscrubber plugin
  95         # PageSpec specifying pages not to scrub
  96         #htmlscrubber_skip => '!*/Discussion',
  97
  98         # inline plugin
  99         # enable rss feeds by default?
 100         #rss => 0,
 101         # enable atom feeds by default?
 102           atom => 1,
 103         # allow rss feeds to be used?
 104         #allowrss => 0,
 105         # allow atom feeds to be used?
 106         allowatom => 1,
 107         # urls to ping (using XML-RPC) on feed update
 108         pingurl => [],
 109
 110         ######################################################################
 111         # auth plugins
 112         #   (anonok, blogspam, httpauth, lockedit, moderatedcomments,
 113         #    opendiscussion, openid, passwordauth, signinedit)
 114         ######################################################################
 115
 116         # anonok plugin
 117         # PageSpec to limit which pages anonymous users can edit
 118         #anonok_pagespec => '*/discussion',
 119
 120         # blogspam plugin
 121         # PageSpec of pages to check for spam
 122         #blogspam_pagespec => 'postcomment(*)',
 123         # options to send to blogspam server
 124         #blogspam_options => 'blacklist=1.2.3.4,blacklist=8.7.6.5,max-links=10',
 125         # blogspam server XML-RPC url
 126         #blogspam_server => '',
 127
 128         # httpauth plugin
 129         # url to redirect to when authentication is needed
 130         #cgiauthurl => 'http://example.com/wiki/auth/ikiwiki.cgi',
 131         # PageSpec of pages where only httpauth will be used for authentication
 132         #httpauth_pagespec => '!*/Discussion',
 133
 134         # lockedit plugin
 135         # PageSpec controlling which pages are locked
 136         #locked_pages => '!*/Discussion',
 137
 138         # moderatedcomments plugin
 139         # PageSpec matching users or comment locations to moderate
 140         #moderate_pagespec => '*',
 141
 142         # openid plugin
 143         # url pattern of openid realm (default is cgiurl)
 144         #openid_realm => '',
 145         # url to ikiwiki cgi to use for openid authentication (default is cgiurl)
 146         #openid_cgiurl => '',
 147
 148         # passwordauth plugin
 149         # a password that must be entered when signing up for an account
 150         #account_creation_password => 's3cr1t',
 151         # cost of generating a password using Authen::Passphrase::BlowfishCrypt
 152         #password_cost => 8,
 153
 154         ######################################################################
 155         # format plugins
 156         #   (creole, highlight, hnb, html, mdwn, otl, rawhtml, textile, txt)
 157         ######################################################################
 158
 159         # highlight plugin
 160         # types of source files to syntax highlight
 161         #tohighlight => '.c .h .cpp .pl .py Makefile:make',
 162
 163         # mdwn plugin
 164         # enable multimarkdown features?
 165         #multimarkdown => 0,
 166
 167         ######################################################################
 168         # misc plugins
 169         #   (filecheck)
 170         ######################################################################
 171
 172         ######################################################################
 173         # web plugins
 174         #   (404, attachment, comments, editdiff, edittemplate, getsource,
 175         #    google, goto, mirrorlist, remove, rename, repolist, search,
 176         #    theme, websetup, wmd)
 177         ######################################################################
 178
 179         # attachment plugin
 180         # enhanced PageSpec specifying what attachments are allowed
 181         #allowed_attachments => 'virusfree() and mimetype(image/*) and maxsize(50kb)',
 182         # virus checker program (reads STDIN, returns nonzero if virus found)
 183         #virus_checker => 'clamdscan -',
 184
 185         # comments plugin
 186         # PageSpec of pages where comments are allowed
 187         #comments_pagespec => 'blog/* and !*/Discussion',
 188         # PageSpec of pages where posting new comments is not allowed
 189         #comments_closed_pagespec => 'blog/controversial or blog/flamewar',
 190         # Base name for comments, e.g. "comment_" for pages like "sandbox/comment_12"
 191         #comments_pagename => '',
 192         # Interpret directives in comments?
 193         #comments_allowdirectives => 0,
 194         # Allow anonymous commenters to set an author name?
 195         #comments_allowauthor => 0,
 196         # commit comments to the VCS
 197         #comments_commit => 1,
 198
 199         # getsource plugin
 200         # Mime type for returned source.
 201         #getsource_mimetype => 'text/plain; charset=utf-8',
 202
 203         # mirrorlist plugin
 204         # list of mirrors
 205         #mirrorlist => {},
 206
 207         # repolist plugin
 208         # URIs of repositories containing the wiki's source
 209         #repositories => [qw{svn://svn.example.org/wiki/trunk}],
 210
 211         # search plugin
 212         # path to the omega cgi program
 213         #omega_cgi => '/usr/lib/cgi-bin/omega/omega',
 214
 215         # theme plugin
 216         # name of theme to enable
 217         #theme => 'actiontabs',
 218
 219         # websetup plugin
 220         # list of plugins that cannot be enabled/disabled via the web interface
 221         #websetup_force_plugins => [],
 222         # list of additional setup field keys to treat as unsafe
 223         #websetup_unsafe => [],
 224         # show unsafe settings, read-only, in web interface?
 225         #websetup_show_unsafe => 1,
 226
 227         ######################################################################
 228         # widget plugins
 229         #   (calendar, color, conditional, cutpaste, date, format, fortune,
 230         #    graphviz, haiku, img, linkmap, listdirectives, map, more,
 231         #    orphans, pagecount, pagestats, poll, polygen, postsparkline,
 232         #    progress, shortcut, sparkline, table, template, teximg, toc,
 233         #    toggle, version)
 234         ######################################################################
 235
 236         # calendar plugin
 237         # base of the archives hierarchy
 238         #archivebase => 'archives',
 239         # PageSpec of pages to include in the archives; used by ikiwiki-calendar command
 240         #archive_pagespec => 'page(posts/*) and !*/Discussion',
 241
 242         # listdirectives plugin
 243         # directory in srcdir that contains directive descriptions
 244         #directive_description_dir => 'ikiwiki/directive',
 245
 246         # teximg plugin
 247         # Should teximg use dvipng to render, or dvips and convert?
 248         #teximg_dvipng => '',
 249         # LaTeX prefix for teximg plugin
 250         #teximg_prefix => '\\documentclass{article}
 251         #\\usepackage{amsmath}
 252         #\\usepackage{amsfonts}
 253         #\\usepackage{amssymb}
 254         #\\pagestyle{empty}
 255         #\\begin{document}
 256         #',
 257         # LaTeX postfix for teximg plugin
 258         #teximg_postfix => '\\end{document}',
 259
 260         ######################################################################
 261         # other plugins
 262         #   (aggregate, autoindex, brokenlinks, camelcase, ddate, embed,
 263         #    favicon, goodstuff, htmlbalance, localstyle, pagetemplate,
 264         #    pingee, pinger, prettydate, recentchanges, recentchangesdiff,
 265         #    relativedate, rsync, sidebar, smiley, sortnaturally, tag,
 266         #    testpagespec, underlay)
 267         ######################################################################
 268
 269         # aggregate plugin
 270         # enable aggregation to internal pages?
 271         #aggregateinternal => 1,
 272         # allow aggregation to be triggered via the web?
 273         #aggregate_webtrigger => 0,
 274
 275         # camelcase plugin
 276         # list of words to not turn into links
 277         #camelcase_ignore => [],
 278
 279         # pinger plugin
 280         # how many seconds to try pinging before timing out
 281         #pinger_timeout => 15,
 282
 283         # prettydate plugin
 284         # format to use to display date
 285         #prettydateformat => '%X, %B %o, %Y',
 286
 287         # recentchanges plugin
 288         # name of the recentchanges page
 289         recentchangespage => 'recentchanges',
 290         # number of changes to track
 291         recentchangesnum => 100,
 292
 293         # rsync plugin
 294         # command to run to sync updated pages
 295         #rsync_command => 'rsync -qa --delete . user@host:/path/to/docroot/',
 296
 297         # sidebar plugin
 298         # show sidebar page on all pages?
 299         #global_sidebars => 1,
 300
 301         # tag plugin
 302         # parent page tags are located under
 303         #tagbase => 'tag',
 304         # autocreate new tag pages?
 305         #tag_autocreate => 1,
 306
 307         # underlay plugin
 308         # extra underlay directories to add
 309         #add_underlays => [qw{/home/hartmans/wiki.underlay}],
 310 }