web.setup

   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 => [qw{admin josh}],
  16         # users who are banned from the wiki
  17         banned_users => [],
  18         # where the source of the wiki is located
  19         srcdir => '/srv/devwiki/src',
  20         # where to build the wiki
  21         destdir => '/srv/devwiki/out',
  22         # base url to the wiki
  23         url => 'http://www.project-moonshot.org/devwiki/',
  24         # url to the ikiwiki.cgi
  25         cgiurl => 'http://www.project-moonshot.org/devwiki/cgi',
  26         # filename of cgi wrapper to generate
  27         cgi_wrapper => '/srv/devwiki/ikiwiki.cgi',
  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 => [qw{toc goodstuff }],
  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|.*\\.setup)$',
  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, git, htmlscrubber, inline, link, meta, parentlinks)
  92         ######################################################################
  93
  94         # git plugin
  95         # git hook to generate
  96         git_wrapper => '/srv/git/devwiki.git/hooks/post-update',
  97         # shell command for git_wrapper to run, in the background
  98         #git_wrapper_background_command => 'git push github',
  99         # mode for git_wrapper (can safely be made suid)
 100         #git_wrappermode => '06755',
 101         # git pre-receive hook to generate
 102         #git_test_receive_wrapper => '/git/wiki.git/hooks/pre-receive',
 103         # unix users whose commits should be checked by the pre-receive hook
 104         #untrusted_committers => [],
 105         # gitweb url to show file history ([[file]] substituted)
 106         historyurl => 'http://www.project-moonshot.org/gitweb?p=devwiki.git;a=history;f=[[file]];hb=HEAD',
 107         # gitweb url to show a diff ([[file]], [[sha1_to]], [[sha1_from]], [[sha1_commit]], and [[sha1_parent]] substituted)
 108         diffurl => 'http://www.project-moonshot.org/gitweb?p=devwiki.git;a=blobdiff;f=[[file]];h=[[sha1_to]];hp=[[sha1_from]];hb=[[sha1_commit]];hpb=[[sha1_parent]]',
 109         # where to pull and push changes (set to empty string to disable)
 110         gitorigin_branch => 'origin',
 111         # branch that the wiki is stored in
 112         gitmaster_branch => 'master',
 113
 114         # htmlscrubber plugin
 115         # PageSpec specifying pages not to scrub
 116         #htmlscrubber_skip => '!*/Discussion',
 117
 118         # inline plugin
 119         # enable rss feeds by default?
 120         #rss => 0,
 121         # enable atom feeds by default?
 122         atom => 1,
 123         # allow rss feeds to be used?
 124         #allowrss => 0,
 125         # allow atom feeds to be used?
 126         allowatom => 1,
 127         # urls to ping (using XML-RPC) on feed update
 128         pingurl => [],
 129
 130         ######################################################################
 131         # auth plugins
 132         #   (anonok, blogspam, httpauth, lockedit, moderatedcomments,
 133         #    opendiscussion, openid, passwordauth, signinedit)
 134         ######################################################################
 135
 136         # anonok plugin
 137         # PageSpec to limit which pages anonymous users can edit
 138         #anonok_pagespec => '*/discussion',
 139
 140         # blogspam plugin
 141         # PageSpec of pages to check for spam
 142         #blogspam_pagespec => 'postcomment(*)',
 143         # options to send to blogspam server
 144         #blogspam_options => 'blacklist=1.2.3.4,blacklist=8.7.6.5,max-links=10',
 145         # blogspam server XML-RPC url
 146         #blogspam_server => '',
 147
 148         # httpauth plugin
 149         # url to redirect to when authentication is needed
 150         #cgiauthurl => 'http://example.com/wiki/auth/ikiwiki.cgi',
 151         # PageSpec of pages where only httpauth will be used for authentication
 152         #httpauth_pagespec => '!*/Discussion',
 153
 154         # lockedit plugin
 155         # PageSpec controlling which pages are locked
 156         #locked_pages => '!*/Discussion',
 157
 158         # moderatedcomments plugin
 159         # PageSpec matching users or comment locations to moderate
 160         #moderate_pagespec => '*',
 161
 162         # openid plugin
 163         # url pattern of openid realm (default is cgiurl)
 164         #openid_realm => '',
 165         # url to ikiwiki cgi to use for openid authentication (default is cgiurl)
 166         #openid_cgiurl => '',
 167
 168         # passwordauth plugin
 169         # a password that must be entered when signing up for an account
 170         #account_creation_password => 's3cr1t',
 171         # cost of generating a password using Authen::Passphrase::BlowfishCrypt
 172 password_cost => 8,
 173
 174         ######################################################################
 175         # format plugins
 176         #   (creole, highlight, hnb, html, mdwn, otl, rawhtml, textile, txt)
 177         ######################################################################
 178
 179         # highlight plugin
 180         # types of source files to syntax highlight
 181         #tohighlight => '.c .h .cpp .pl .py Makefile:make',
 182
 183         # mdwn plugin
 184         # enable multimarkdown features?
 185         #multimarkdown => 0,
 186
 187         ######################################################################
 188         # misc plugins
 189         #   (filecheck)
 190         ######################################################################
 191
 192         ######################################################################
 193         # web plugins
 194         #   (404, attachment, comments, editdiff, edittemplate, getsource,
 195         #    google, goto, mirrorlist, remove, rename, repolist, search,
 196         #    theme, websetup, wmd)
 197         ######################################################################
 198
 199         # attachment plugin
 200         # enhanced PageSpec specifying what attachments are allowed
 201         #allowed_attachments => 'virusfree() and mimetype(image/*) and maxsize(50kb)',
 202         # virus checker program (reads STDIN, returns nonzero if virus found)
 203         #virus_checker => 'clamdscan -',
 204
 205         # comments plugin
 206         # PageSpec of pages where comments are allowed
 207         #comments_pagespec => 'blog/* and !*/Discussion',
 208         # PageSpec of pages where posting new comments is not allowed
 209         #comments_closed_pagespec => 'blog/controversial or blog/flamewar',
 210         # Base name for comments, e.g. "comment_" for pages like "sandbox/comment_12"
 211         #comments_pagename => '',
 212         # Interpret directives in comments?
 213         #comments_allowdirectives => 0,
 214         # Allow anonymous commenters to set an author name?
 215         #comments_allowauthor => 0,
 216         # commit comments to the VCS
 217         #comments_commit => 1,
 218
 219         # getsource plugin
 220         # Mime type for returned source.
 221         #getsource_mimetype => 'text/plain; charset=utf-8',
 222
 223         # mirrorlist plugin
 224         # list of mirrors
 225         #mirrorlist => {},
 226
 227         # repolist plugin
 228         # URIs of repositories containing the wiki's source
 229         #repositories => [qw{svn://svn.example.org/wiki/trunk}],
 230
 231         # search plugin
 232         # path to the omega cgi program
 233         #omega_cgi => '/usr/lib/cgi-bin/omega/omega',
 234
 235         # theme plugin
 236         # name of theme to enable
 237         #theme => 'actiontabs',
 238
 239         # websetup plugin
 240         # list of plugins that cannot be enabled/disabled via the web interface
 241         #websetup_force_plugins => [],
 242         # list of additional setup field keys to treat as unsafe
 243         #websetup_unsafe => [],
 244         # show unsafe settings, read-only, in web interface?
 245         websetup_show_unsafe => 1,
 246
 247         ######################################################################
 248         # widget plugins
 249         #   (calendar, color, conditional, cutpaste, date, format, fortune,
 250         #    graphviz, haiku, img, linkmap, listdirectives, map, more,
 251         #    orphans, pagecount, pagestats, poll, polygen, postsparkline,
 252         #    progress, shortcut, sparkline, table, template, teximg, toc,
 253         #    toggle, version)
 254         ######################################################################
 255
 256         # calendar plugin
 257         # base of the archives hierarchy
 258         #archivebase => 'archives',
 259         # PageSpec of pages to include in the archives; used by ikiwiki-calendar command
 260         #archive_pagespec => 'page(posts/*) and !*/Discussion',
 261
 262         # listdirectives plugin
 263         # directory in srcdir that contains directive descriptions
 264         #directive_description_dir => 'ikiwiki/directive',
 265
 266         # teximg plugin
 267         # Should teximg use dvipng to render, or dvips and convert?
 268         #teximg_dvipng => '',
 269         # LaTeX prefix for teximg plugin
 270         #teximg_prefix => '\\documentclass{article}
 271         #\\usepackage{amsmath}
 272         #\\usepackage{amsfonts}
 273         #\\usepackage{amssymb}
 274         #\\pagestyle{empty}
 275         #\\begin{document}
 276         #',
 277         # LaTeX postfix for teximg plugin
 278         #teximg_postfix => '\\end{document}',
 279
 280         ######################################################################
 281         # other plugins
 282         #   (aggregate, autoindex, brokenlinks, camelcase, ddate, embed,
 283         #    favicon, goodstuff, htmlbalance, localstyle, pagetemplate,
 284         #    pingee, pinger, prettydate, recentchanges, recentchangesdiff,
 285         #    relativedate, rsync, sidebar, smiley, sortnaturally, tag,
 286         #    testpagespec, underlay)
 287         ######################################################################
 288
 289         # aggregate plugin
 290         # enable aggregation to internal pages?
 291         #aggregateinternal => 1,
 292         # allow aggregation to be triggered via the web?
 293         #aggregate_webtrigger => 0,
 294
 295         # camelcase plugin
 296         # list of words to not turn into links
 297         #camelcase_ignore => [],
 298
 299         # pinger plugin
 300         # how many seconds to try pinging before timing out
 301         #pinger_timeout => 15,
 302
 303         # prettydate plugin
 304         # format to use to display date
 305         #prettydateformat => '%X, %B %o, %Y',
 306
 307         # recentchanges plugin
 308         # name of the recentchanges page
 309         recentchangespage => 'recentchanges',
 310         # number of changes to track
 311         recentchangesnum => 100,
 312
 313         # rsync plugin
 314         # command to run to sync updated pages
 315         #rsync_command => 'rsync -qa --delete . user@host:/path/to/docroot/',
 316
 317         # sidebar plugin
 318         # show sidebar page on all pages?
 319         #global_sidebars => 1,
 320
 321         # tag plugin
 322         # parent page tags are located under
 323         #tagbase => 'tag',
 324         # autocreate new tag pages?
 325         #tag_autocreate => 1,
 326
 327         # underlay plugin
 328         # extra underlay directories to add
 329         #add_underlays => [qw{/home/hartmans/wiki.underlay}],
 330 }