ikiwiki.setup

   1 #!/usr/bin/perl
   2 # Setup file for ikiwiki.
   3 #
   4 # Passing this to ikiwiki --setup will make ikiwiki generate
   5 # wrappers and build the wiki.
   6 #
   7 # Remember to re-run ikiwiki --setup any time you edit this file.
   8 use IkiWiki::Setup::Standard {
   9         # name of the wiki
  10         wikiname => 'unfolding disasters',
  11         # contact email for wiki
  12         adminemail => 'wking@tremily.us',
  13         # users who are wiki admins
  14         adminuser => [qw{wking}],
  15         # users who are banned from the wiki
  16         banned_users => [],
  17         # where the source of the wiki is located
  18         srcdir => '.',
  19         # where to build the wiki
  20         destdir => 'html',
  21         # base url to the wiki
  22         url => 'http://blog.tremily.us/',
  23         # url to the ikiwiki.cgi
  24         #cgiurl => 'http://blog.tremily.us/cgi-bin/ikiwiki.cgi',
  25         # filename of cgi wrapper to generate
  26         #cgi_wrapper => 'html/cgi-bin/ikiwiki.cgi',
  27         # mode for cgi_wrapper (can safely be made suid)
  28         #cgi_wrappermode => '06755',
  29         # rcs backend to use
  30         rcs => 'git',
  31         # plugins to add to the default configuration
  32         add_plugins => [qw{goodstuff linktoimgonly lockedit mdwn_itex org sidebar rawhtml rst}],
  33         # plugins to disable
  34         disable_plugins => [qw{editpage passwordauth smiley}],
  35         # location of template files
  36         templatedir => '/home/wking/.ikiwiki/templates',
  37         # base wiki source location
  38         underlaydir => '/usr/share/ikiwiki/basewiki',
  39         # generate HTML5?
  40         html5 => 1,
  41         # display verbose messages?
  42         verbose => 1,
  43         # log to syslog?
  44         #syslog => 1,
  45         syslog => 0,
  46         # create output files named page/index.html?
  47         usedirs => 1,
  48         # use '!'-prefixed preprocessor directives?
  49         prefix_directives => 1,
  50         # use page/index.mdwn source files
  51         indexpages => 0,
  52         # enable Discussion pages?
  53         discussion => 0,
  54         # only send cookies over SSL connections?
  55         sslcookie => 0,
  56         # extension to use for new pages
  57         default_pageext => 'mdwn',
  58         # extension to use for html files
  59         htmlext => 'html',
  60         # strftime format string to display date
  61         timeformat => '%c',
  62         # UTF-8 locale to use
  63         #locale => 'en_US.UTF-8',
  64         # put user pages below specified page
  65         userdir => '',
  66         # how many backlinks to show before hiding excess (0 to show all)
  67         numbacklinks => 10,
  68         # attempt to hardlink source files? (optimisation for large files)
  69         hardlink => 0,
  70         # force ikiwiki to use a particular umask
  71         #umask => 022,
  72         # group for wrappers to run in
  73         #wrappergroup => 'ikiwiki',
  74         # extra library and plugin directory
  75         libdir => '/home/wking/.ikiwiki',
  76         # environment variables
  77         ENV => {},
  78         # regexp of source files to ignore
  79         exclude => qr/^(html\/.*|ikiwiki.setup|Makefile)/,
  80         # specifies the characters that are allowed in source filenames
  81         wiki_file_chars => '-[:alnum:]+/.:_',
  82         # allow symlinks in the path leading to the srcdir (potentially insecure)
  83         allow_symlinks_before_srcdir => 0,
  84
  85         # git plugin
  86         # git hook to generate
  87         #git_wrapper => '/tmp/ikiwiki.git/hooks/post-update.ikiwiki',
  88         # mode for git_wrapper (can safely be made suid)
  89         #git_wrappermode => '06755',
  90         # git pre-receive hook to generate
  91         #git_test_receive_wrapper => '/git/wiki.git/hooks/pre-receive',
  92         # unix users whose commits should be checked by the pre-receive hook
  93         #untrusted_committers => [],
  94         # gitweb url to show file history ([[file]] substituted)
  95         #historyurl => 'http://git.example.com/gitweb.cgi?p=wiki.git;a=history;f=[[file]]',
  96         # gitweb url to show a diff ([[file]], [[sha1_to]], [[sha1_from]], [[sha1_commit]], and [[sha1_parent]] substituted)
  97         #diffurl => 'http://git.example.com/gitweb.cgi?p=wiki.git;a=blobdiff;f=[[file]];h=[[sha1_to]];hp=[[sha1_from]];hb=[[sha1_commit]];hpb=[[sha1_parent]]',
  98         # where to pull and push changes (set to empty string to disable)
  99         #gitorigin_branch => 'origin',
 100         gitorigin_branch => '', # don't pull during build
 101         # branch that the wiki is stored in
 102         #gitmaster_branch => 'master',
 103
 104         # htmlscrubber plugin
 105         # PageSpec specifying pages not to scrub
 106         htmlscrubber_skip => "!templates/*",
 107
 108         # inline plugin
 109         # enable rss feeds by default?
 110         rss => 1,
 111         # enable atom feeds by default?
 112         atom => 1,
 113         # allow rss feeds to be used?
 114         #allowrss => 0,
 115         # allow atom feeds to be used?
 116         #allowatom => 0,
 117         # urls to ping (using XML-RPC) on feed update
 118         #pingurl => 'http://rpc.technorati.com/rpc/ping',
 119         # templates for which you want raw content
 120         raw_templates => [qw{raw}],
 121
 122         # lockedit plugin
 123         # PageSpec controlling which pages are locked
 124         locked_pages => '*',
 125
 126         # mdwn plugin
 127         # enable multimarkdown features?
 128         #multimarkdown => 0,
 129
 130         # mdwn_itex plugin
 131         # path to the itex2MML binary
 132         #itex2mml => '/usr/bin/itex2MML',
 133         itex2mml => '/home/wking/bin/itex2MML',
 134   # Must return numeric character references (e.g. &#x003B1;) or UTF-8
 135   # instead of MathML entities (e.g. &alpha;).  If you're using the
 136   # stock itex2MML, you might use a script like this:
 137   #    #!/bin/sh
 138   #    /usr/bin/itex2MML "${@}" | perl -e 'use MathML::Entities; print name2numbered($_) while(<>);'
 139
 140         # autonumber \[..\]x equations?
 141         itex_num_equations => 1,
 142
 143         # recentchanges plugin
 144         # name of the recentchanges page
 145         #recentchangespage => 'recentchanges',
 146         # number of changes to track
 147         #recentchangesnum => 100,
 148
 149         # repolist plugin
 150         # URIs of repositories containing the wiki's source
 151         repositories => [qw{git://tremily.us/blog.git}],
 152
 153         # sidebar plugin
 154         # show sidebar page on all pages?
 155         #global_sidebars => 1,
 156
 157         # tag plugin
 158         # parent page tags are located under
 159         #tagbase => 'tag',
 160 }