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