ikiwiki.setup

   1 # IkiWiki::Setup::Yaml - YAML formatted setup file
   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 #
  10 # name of the wiki
  11 wikiname: ikiwiki
  12 # contact email for wiki
  13 adminemail: joey@kitenet.net
  14 # users who are wiki admins
  15 adminuser:
  16   - http://none/
  17 # users who are banned from the wiki
  18 banned_users: []
  19 # where the source of the wiki is located
  20 srcdir: /home/b-ikiwiki/source
  21 # where to build the wiki
  22 destdir: /home/b-ikiwiki/public_html
  23 # base url to the wiki
  24 url: http://ikiwiki.branchable.com
  25 # url to the ikiwiki.cgi
  26 cgiurl: http://ikiwiki.branchable.com/ikiwiki.cgi
  27 # filename of cgi wrapper to generate
  28 cgi_wrapper: /var/www/b-ikiwiki/ikiwiki.cgi
  29 # mode for cgi_wrapper (can safely be made suid)
  30 cgi_wrappermode: 0755
  31 # rcs backend to use
  32 rcs: git
  33 # plugins to add to the default configuration
  34 add_plugins:
  35   - goodstuff
  36   - websetup
  37   - 404
  38   - ikiwikihosting
  39   - branchable
  40   - recentchangesdiff
  41   - attachment
  42   - remove
  43   - rename
  44   - edittemplate
  45   - favicon
  46   - format
  47   - fortune
  48   - highlight
  49   - listdirectives
  50   - poll
  51   - progress
  52   - relativedate
  53   - search
  54   - testpagespec
  55   - version
  56   - theme
  57 # plugins to disable
  58 disable_plugins: []
  59 # additional directory to search for template files
  60 templatedir: /usr/share/ikiwiki/templates
  61 # base wiki source location
  62 underlaydir: /usr/share/ikiwiki/basewiki
  63 # display verbose messages?
  64 #verbose: 1
  65 # log to syslog?
  66 syslog: 1
  67 # create output files named page/index.html?
  68 usedirs: 1
  69 # use '!'-prefixed preprocessor directives?
  70 prefix_directives: 1
  71 # use page/index.mdwn source files
  72 indexpages: 0
  73 # enable Discussion pages?
  74 discussion: 1
  75 # name of Discussion pages
  76 discussionpage: Discussion
  77 # generate HTML5? (experimental)
  78 html5: 0
  79 # only send cookies over SSL connections?
  80 sslcookie: 0
  81 # extension to use for new pages
  82 default_pageext: mdwn
  83 # extension to use for html files
  84 htmlext: html
  85 # strftime format string to display date
  86 timeformat: '%c'
  87 # UTF-8 locale to use
  88 #locale: en_US.UTF-8
  89 # put user pages below specified page
  90 userdir: ''
  91 # how many backlinks to show before hiding excess (0 to show all)
  92 numbacklinks: 10
  93 # attempt to hardlink source files? (optimisation for large files)
  94 hardlink: 1
  95 # force ikiwiki to use a particular umask
  96 #umask: 022
  97 # group for wrappers to run in
  98 #wrappergroup: ikiwiki
  99 # extra library and plugin directory
 100 libdir: /home/b-ikiwiki/.ikiwiki
 101 # environment variables
 102 ENV:
 103   TMPDIR: /home/b-ikiwiki/tmp
 104 # time zone name
 105 #timezone: US/Eastern
 106 # regexp of normally excluded files to include
 107 #include: '^\.htaccess$'
 108 # regexp of files that should be skipped
 109 #exclude: '^(*\.private|Makefile)$'
 110 # specifies the characters that are allowed in source filenames
 111 wiki_file_chars: '-[:alnum:]+/.:_'
 112 # allow symlinks in the path leading to the srcdir (potentially insecure)
 113 allow_symlinks_before_srcdir: 0
 114
 115 ######################################################################
 116 # core plugins
 117 #   (branchable, editpage, git, gitpush, htmlscrubber, ikiwikihosting,
 118 #    inline, link, meta, parentlinks)
 119 ######################################################################
 120
 121 # branchable plugin
 122 # Allow anyone to branch, check out, and copy this site?
 123 branchable: 1
 124 # Allow anyone to git push verified changes to this site?
 125 anonpush: 1
 126 # Display "Branchable" link on action bar?
 127 #branchable_action: 1
 128
 129 # git plugin
 130 # git hook to generate
 131 git_wrapper: /home/b-ikiwiki/source.git/hooks/post-update
 132 # shell command for git_wrapper to run, in the background
 133 #git_wrapper_background_command: git push github
 134 # mode for git_wrapper (can safely be made suid)
 135 git_wrappermode: 6755
 136 # git pre-receive hook to generate
 137 #git_test_receive_wrapper: /git/wiki.git/hooks/pre-receive
 138 # unix users whose commits should be checked by the pre-receive hook
 139 untrusted_committers:
 140   - ikiwiki-anon
 141 # gitweb url to show file history ([[file]] substituted)
 142 historyurl: 'http://source.ikiwiki.branchable.com/?p=source.git;a=history;f=[[file]];hb=HEAD'
 143 # gitweb url to show a diff ([[file]], [[sha1_to]], [[sha1_from]], [[sha1_commit]], and [[sha1_parent]] substituted)
 144 diffurl: 'http://source.ikiwiki.branchable.com/?p=source.git;a=blobdiff;f=[[file]];h=[[sha1_to]];hp=[[sha1_from]];hb=[[sha1_commit]];hpb=[[sha1_parent]]'
 145 # where to pull and push changes (set to empty string to disable)
 146 #gitorigin_branch: origin
 147 # branch that the wiki is stored in
 148 #gitmaster_branch: master
 149
 150 # gitpush plugin
 151 # git repository urls that changes are pushed to
 152 #git_push_to: []
 153
 154 # htmlscrubber plugin
 155 # PageSpec specifying pages not to scrub
 156 #htmlscrubber_skip: '!*/Discussion'
 157
 158 # ikiwikihosting plugin
 159 # list of urls that alias to the main url
 160 #urlalias: []
 161 # openid of primary site owner
 162 owner: http://joey.kitenet.net/
 163 # optional hostname of site this one was branched from
 164 #parent: ''
 165 # internal hostname of this site
 166 hostname: ikiwiki.branchable.com
 167 # site creation datestamp
 168 created: 1305836524
 169 # how many days to retain logs
 170 #log_period: 7
 171 # disable IPv6?
 172 #ipv6_disabled: 1
 173
 174 # inline plugin
 175 # enable rss feeds by default?
 176 rss: 1
 177 # enable atom feeds by default?
 178 atom: 1
 179 # allow rss feeds to be used?
 180 #allowrss: 0
 181 # allow atom feeds to be used?
 182 #allowatom: 0
 183 # urls to ping (using XML-RPC) on feed update
 184 #pingurl: http://rpc.technorati.com/rpc/ping
 185
 186 ######################################################################
 187 # auth plugins
 188 #   (anonok, blogspam, httpauth, lockedit, moderatedcomments,
 189 #    opendiscussion, openid, passwordauth, signinedit)
 190 ######################################################################
 191
 192 # anonok plugin
 193 # PageSpec to limit which pages anonymous users can edit
 194 #anonok_pagespec: '*/discussion'
 195
 196 # blogspam plugin
 197 # PageSpec of pages to check for spam
 198 #blogspam_pagespec: postcomment(*)
 199 # options to send to blogspam server
 200 #blogspam_options: 'blacklist=1.2.3.4,blacklist=8.7.6.5,max-links=10'
 201 # blogspam server XML-RPC url
 202 #blogspam_server: ''
 203
 204 # httpauth plugin
 205 # url to redirect to when authentication is needed
 206 #cgiauthurl: http://example.com/wiki/auth/ikiwiki.cgi
 207 # PageSpec of pages where only httpauth will be used for authentication
 208 #httpauth_pagespec: '!*/Discussion'
 209
 210 # lockedit plugin
 211 # PageSpec controlling which pages are locked
 212 #locked_pages: '!*/Discussion'
 213
 214 # moderatedcomments plugin
 215 # PageSpec matching users or comment locations to moderate
 216 #moderate_pagespec: '*'
 217
 218 # openid plugin
 219 # url pattern of openid realm (default is cgiurl)
 220 openid_realm: http://*.branchable.com/
 221 # url to ikiwiki cgi to use for openid authentication (default is cgiurl)
 222 openid_cgiurl: http://ikiwiki.branchable.com/ikiwiki.cgi
 223
 224 # passwordauth plugin
 225 # a password that must be entered when signing up for an account
 226 #account_creation_password: s3cr1t
 227 # cost of generating a password using Authen::Passphrase::BlowfishCrypt
 228 #password_cost: 8
 229
 230 ######################################################################
 231 # format plugins
 232 #   (creole, highlight, hnb, html, mdwn, otl, po, rawhtml, rst, textile,
 233 #    txt)
 234 ######################################################################
 235
 236 # highlight plugin
 237 # types of source files to syntax highlight
 238 tohighlight: .c .h .cpp .pl .py Makefile:make
 239 # location of highlight's filetypes.conf
 240 #filetypes_conf: /etc/highlight/filetypes.conf
 241 # location of highlight's langDefs directory
 242 #langdefdir: /usr/share/highlight/langDefs
 243
 244 # mdwn plugin
 245 # enable multimarkdown features?
 246 #multimarkdown: 0
 247
 248 # po plugin
 249 # master language (non-PO files)
 250 #po_master_language: en|English
 251 # slave languages (translated via PO files) format: ll|Langname
 252 #po_slave_languages:
 253 #  - fr|Français
 254 #  - es|Español
 255 #  - de|Deutsch
 256 # PageSpec controlling which pages are translatable
 257 #po_translatable_pages: '* and !*/Discussion'
 258 # internal linking behavior (default/current/negotiated)
 259 #po_link_to: current
 260
 261 ######################################################################
 262 # misc plugins
 263 #   (filecheck)
 264 ######################################################################
 265
 266 ######################################################################
 267 # web plugins
 268 #   (404, attachment, comments, editdiff, edittemplate, getsource, google,
 269 #    goto, mirrorlist, remove, rename, repolist, search, theme, websetup,
 270 #    wmd)
 271 ######################################################################
 272
 273 # attachment plugin
 274 # enhanced PageSpec specifying what attachments are allowed
 275 allowed_attachments: admin() and virusfree()
 276 # virus checker program (reads STDIN, returns nonzero if virus found)
 277 virus_checker: clamdscan -
 278
 279 # comments plugin
 280 # PageSpec of pages where comments are allowed
 281 #comments_pagespec: blog/* and !*/Discussion
 282 # PageSpec of pages where posting new comments is not allowed
 283 #comments_closed_pagespec: blog/controversial or blog/flamewar
 284 # Base name for comments, e.g. "comment_" for pages like "sandbox/comment_12"
 285 #comments_pagename: ''
 286 # Interpret directives in comments?
 287 #comments_allowdirectives: 0
 288 # Allow anonymous commenters to set an author name?
 289 #comments_allowauthor: 0
 290 # commit comments to the VCS
 291 #comments_commit: 1
 292
 293 # getsource plugin
 294 # Mime type for returned source.
 295 #getsource_mimetype: text/plain; charset=utf-8
 296
 297 # mirrorlist plugin
 298 # list of mirrors
 299 #mirrorlist: {}
 300
 301 # repolist plugin
 302 # URIs of repositories containing the wiki's source
 303 #repositories:
 304 #  - svn://svn.example.org/wiki/trunk
 305
 306 # search plugin
 307 # path to the omega cgi program
 308 #omega_cgi: /usr/lib/cgi-bin/omega/omega
 309
 310 # theme plugin
 311 # name of theme to enable
 312 #theme: actiontabs
 313
 314 # websetup plugin
 315 # list of plugins that cannot be enabled/disabled via the web interface
 316 websetup_force_plugins:
 317   - httpauth
 318   - openid
 319   - mdwn
 320   - wmd
 321 # list of additional setup field keys to treat as unsafe
 322 websetup_unsafe:
 323   - url
 324   - cgiurl
 325   - verbose
 326   - syslog
 327   - usedirs
 328   - prefix_directives
 329   - indexpages
 330   - repositories
 331 # show unsafe settings, read-only, in web interface?
 332 websetup_show_unsafe: 0
 333
 334 ######################################################################
 335 # widget plugins
 336 #   (calendar, color, conditional, cutpaste, date, format, fortune,
 337 #    graphviz, haiku, img, linkmap, listdirectives, map, more, orphans,
 338 #    pagecount, pagestats, poll, polygen, postsparkline, progress,
 339 #    shortcut, sparkline, table, template, teximg, toc, toggle, version)
 340 ######################################################################
 341
 342 # calendar plugin
 343 # base of the archives hierarchy
 344 #archivebase: archives
 345 # PageSpec of pages to include in the archives; used by ikiwiki-calendar command
 346 #archive_pagespec: page(posts/*) and !*/Discussion
 347
 348 # listdirectives plugin
 349 # directory in srcdir that contains directive descriptions
 350 #directive_description_dir: ikiwiki/directive
 351
 352 # teximg plugin
 353 # Should teximg use dvipng to render, or dvips and convert?
 354 #teximg_dvipng: ''
 355 # LaTeX prefix for teximg plugin
 356 #teximg_prefix: |
 357 #  \documentclass{article}
 358 #  \usepackage[utf8]{inputenc}
 359 #  \usepackage{amsmath}
 360 #  \usepackage{amsfonts}
 361 #  \usepackage{amssymb}
 362 #  \pagestyle{empty}
 363 #  \begin{document}
 364 # LaTeX postfix for teximg plugin
 365 #teximg_postfix: '\end{document}'
 366
 367 ######################################################################
 368 # other plugins
 369 #   (aggregate, autoindex, brokenlinks, camelcase, ddate, embed, favicon,
 370 #    flattr, goodstuff, htmlbalance, localstyle, missingsite, pagetemplate,
 371 #    parked, pingee, pinger, prettydate, recentchanges, recentchangesdiff,
 372 #    relativedate, rsync, sidebar, smiley, sortnaturally, tag,
 373 #    testpagespec, transient, typography, underlay)
 374 ######################################################################
 375
 376 # aggregate plugin
 377 # enable aggregation to internal pages?
 378 #aggregateinternal: 1
 379 # allow aggregation to be triggered via the web?
 380 #aggregate_webtrigger: 0
 381 # cookie control
 382 #cookiejar:
 383 #  file: /home/b-ikiwiki/.ikiwiki/cookies
 384
 385 # autoindex plugin
 386 # commit autocreated index pages
 387 #autoindex_commit: 1
 388
 389 # camelcase plugin
 390 # list of words to not turn into links
 391 #camelcase_ignore: []
 392
 393 # flattr plugin
 394 # userid or user name to use by default for Flattr buttons
 395 #flattr_userid: joeyh
 396
 397 # parked plugin
 398 # An optional message explaining why this site is parked.
 399 #parked_message: ''
 400
 401 # pinger plugin
 402 # how many seconds to try pinging before timing out
 403 #pinger_timeout: 15
 404
 405 # prettydate plugin
 406 # format to use to display date
 407 #prettydateformat: '%X, %B %o, %Y'
 408
 409 # recentchanges plugin
 410 # name of the recentchanges page
 411 #recentchangespage: recentchanges
 412 # number of changes to track
 413 #recentchangesnum: 100
 414
 415 # rsync plugin
 416 # command to run to sync updated pages
 417 #rsync_command: rsync -qa --delete . user@host:/path/to/docroot/
 418
 419 # sidebar plugin
 420 # show sidebar page on all pages?
 421 #global_sidebars: 1
 422
 423 # tag plugin
 424 # parent page tags are located under
 425 #tagbase: tag
 426 # autocreate new tag pages?
 427 #tag_autocreate: 1
 428 # commit autocreated tag pages
 429 #tag_autocreate_commit: 1
 430
 431 # typography plugin
 432 # Text::Typography attributes value
 433 #typographyattributes: 3
 434
 435 # underlay plugin
 436 # extra underlay directories to add
 437 #add_underlays:
 438 #  - /home/b-ikiwiki/wiki.underlay