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