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