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 # 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   - joey@git.kitenet.net:/srv/git/ikiwiki.git
 208
 209 # htmlscrubber plugin
 210 # PageSpec specifying pages not to scrub
 211 htmlscrubber_skip: tipjar
 212
 213 # ikiwikihosting plugin
 214 # list of urls that alias to the main url
 215 urlalias:
 216   - http://ikiwiki.branchable.com/
 217   - http://www.ikiwiki.info/
 218 # openid of primary site owner
 219 owner: http://joey.kitenet.net/
 220 # optional hostname of site this one was branched from
 221 #parent: ''
 222 # internal hostname of this site
 223 hostname: ikiwiki.branchable.com
 224 # site creation datestamp
 225 created: 1305836524
 226 # how many days to retain logs
 227 #log_period: 7
 228 # disable IPv6?
 229 ipv6_disabled: 0
 230
 231 # inline plugin
 232 # enable rss feeds by default?
 233 rss: 1
 234 # enable atom feeds by default?
 235 atom: 0
 236 # allow rss feeds to be used?
 237 #allowrss: 0
 238 # allow atom feeds to be used?
 239 allowatom: 1
 240 # urls to ping (using XML-RPC) on feed update
 241 pingurl: []
 242
 243 ######################################################################
 244 # auth plugins
 245 #   (anonok, blogspam, httpauth, lockedit, moderatedcomments,
 246 #    opendiscussion, openid, passwordauth, signinedit)
 247 ######################################################################
 248
 249 # anonok plugin
 250 # PageSpec to limit which pages anonymous users can edit
 251 #anonok_pagespec: '*/discussion'
 252
 253 # blogspam plugin
 254 # PageSpec of pages to check for spam
 255 #blogspam_pagespec: postcomment(*)
 256 # options to send to blogspam server
 257 #blogspam_options: 'blacklist=1.2.3.4,blacklist=8.7.6.5,max-links=10'
 258 # blogspam server XML-RPC url
 259 #blogspam_server: ''
 260
 261 # httpauth plugin
 262 # url to redirect to when authentication is needed
 263 #cgiauthurl: http://example.com/wiki/auth/ikiwiki.cgi
 264 # PageSpec of pages where only httpauth will be used for authentication
 265 #httpauth_pagespec: '!*/Discussion'
 266
 267 # lockedit plugin
 268 # PageSpec controlling which pages are locked
 269 locked_pages: tipjar
 270
 271 # moderatedcomments plugin
 272 # PageSpec matching users or comment locations to moderate
 273 #moderate_pagespec: '*'
 274
 275 # openid plugin
 276 # url pattern of openid realm (default is cgiurl)
 277 openid_realm: http://*.branchable.com/
 278 # url to ikiwiki cgi to use for openid authentication (default is cgiurl)
 279 openid_cgiurl: http://ikiwiki.branchable.com/ikiwiki.cgi
 280
 281 # passwordauth plugin
 282 # a password that must be entered when signing up for an account
 283 #account_creation_password: s3cr1t
 284 # cost of generating a password using Authen::Passphrase::BlowfishCrypt
 285 #password_cost: 8
 286
 287 ######################################################################
 288 # format plugins
 289 #   (creole, highlight, hnb, html, mdwn, otl, po, rawhtml, rst, textile,
 290 #    txt)
 291 ######################################################################
 292
 293 # highlight plugin
 294 # types of source files to syntax highlight
 295 tohighlight: .c .h .cpp .pl .py Makefile:make
 296 # location of highlight's filetypes.conf
 297 filetypes_conf: /etc/highlight/filetypes.conf
 298 # location of highlight's langDefs directory
 299 langdefdir: /usr/share/highlight/langDefs
 300
 301 # mdwn plugin
 302 # enable multimarkdown features?
 303 #multimarkdown: 0
 304
 305 # po plugin
 306 # master language (non-PO files)
 307 #po_master_language: en|English
 308 # slave languages (translated via PO files) format: ll|Langname
 309 #po_slave_languages:
 310 #  - fr|Français
 311 #  - es|Español
 312 #  - de|Deutsch
 313 # PageSpec controlling which pages are translatable
 314 po_translatable_pages: ''
 315 # internal linking behavior (default/current/negotiated)
 316 po_link_to: default
 317
 318 ######################################################################
 319 # misc plugins
 320 #   (filecheck)
 321 ######################################################################
 322
 323 ######################################################################
 324 # web plugins
 325 #   (404, attachment, comments, editdiff, edittemplate, google, goto,
 326 #    mirrorlist, remove, rename, repolist, search, theme, websetup, wmd)
 327 ######################################################################
 328
 329 # attachment plugin
 330 # enhanced PageSpec specifying what attachments are allowed
 331 allowed_attachments: admin() and virusfree()
 332 # virus checker program (reads STDIN, returns nonzero if virus found)
 333 virus_checker: clamdscan -
 334
 335 # comments plugin
 336 # PageSpec of pages where comments are allowed
 337 comments_pagespec: forum/* and !*/Discussion
 338 # PageSpec of pages where posting new comments is not allowed
 339 comments_closed_pagespec: ''
 340 # Base name for comments, e.g. "comment_" for pages like "sandbox/comment_12"
 341 comments_pagename: comment_
 342 # Interpret directives in comments?
 343 #comments_allowdirectives: 0
 344 # Allow anonymous commenters to set an author name?
 345 comments_allowauthor: 0
 346 # commit comments to the VCS
 347 comments_commit: 1
 348
 349 # mirrorlist plugin
 350 # list of mirrors
 351 #mirrorlist: {}
 352
 353 # repolist plugin
 354 # URIs of repositories containing the wiki's source
 355 repositories:
 356   - ssh://b-ikiwiki@ikiwiki.branchable.com/
 357   - git://ikiwiki.branchable.com/
 358
 359 # search plugin
 360 # path to the omega cgi program
 361 omega_cgi: /usr/lib/cgi-bin/omega/omega
 362
 363 # theme plugin
 364 # name of theme to enable
 365 #theme: actiontabs
 366
 367 # websetup plugin
 368 # list of plugins that cannot be enabled/disabled via the web interface
 369 websetup_force_plugins:
 370   - httpauth
 371   - openid
 372   - mdwn
 373   - wmd
 374 # list of additional setup field keys to treat as unsafe
 375 websetup_unsafe:
 376   - url
 377   - cgiurl
 378   - verbose
 379   - syslog
 380   - usedirs
 381   - prefix_directives
 382   - indexpages
 383   - repositories
 384 # show unsafe settings, read-only, in web interface?
 385 websetup_show_unsafe: 0
 386
 387 ######################################################################
 388 # widget plugins
 389 #   (calendar, color, conditional, cutpaste, date, format, fortune,
 390 #    graphviz, haiku, img, linkmap, listdirectives, map, more, orphans,
 391 #    pagecount, pagestats, poll, polygen, postsparkline, progress,
 392 #    shortcut, sparkline, table, template, teximg, toc, toggle, version)
 393 ######################################################################
 394
 395 # calendar plugin
 396 # base of the archives hierarchy
 397 #archivebase: archives
 398 # PageSpec of pages to include in the archives; used by ikiwiki-calendar command
 399 #archive_pagespec: page(posts/*) and !*/Discussion
 400
 401 # listdirectives plugin
 402 # directory in srcdir that contains directive descriptions
 403 directive_description_dir: ikiwiki/directive
 404
 405 # teximg plugin
 406 # Should teximg use dvipng to render, or dvips and convert?
 407 #teximg_dvipng: ''
 408 # LaTeX prefix for teximg plugin
 409 #teximg_prefix: |
 410 #  \documentclass{article}
 411 #  \usepackage[utf8]{inputenc}
 412 #  \usepackage{amsmath}
 413 #  \usepackage{amsfonts}
 414 #  \usepackage{amssymb}
 415 #  \pagestyle{empty}
 416 #  \begin{document}
 417 # LaTeX postfix for teximg plugin
 418 #teximg_postfix: '\end{document}'
 419
 420 ######################################################################
 421 # other plugins
 422 #   (aggregate, autoindex, brokenlinks, camelcase, ddate, embed, favicon,
 423 #    flattr, goodstuff, htmlbalance, localstyle, missingsite, pagetemplate,
 424 #    parked, pingee, pinger, prettydate, recentchanges, recentchangesdiff,
 425 #    relativedate, rsync, sidebar, smiley, sortnaturally, tag,
 426 #    testpagespec, transient, typography, underlay)
 427 ######################################################################
 428
 429 # aggregate plugin
 430 # enable aggregation to internal pages?
 431 aggregateinternal: 1
 432 # allow aggregation to be triggered via the web?
 433 #aggregate_webtrigger: 0
 434 # cookie control
 435 cookiejar:
 436   file: /home/b-ikiwiki/.ikiwiki/cookies
 437
 438 # autoindex plugin
 439 # commit autocreated index pages
 440 autoindex_commit: 1
 441
 442 # camelcase plugin
 443 # list of words to not turn into links
 444 #camelcase_ignore: []
 445
 446 # flattr plugin
 447 # userid or user name to use by default for Flattr buttons
 448 #flattr_userid: joeyh
 449
 450 # parked plugin
 451 # An optional message explaining why this site is parked.
 452 #parked_message: ''
 453
 454 # pinger plugin
 455 # how many seconds to try pinging before timing out
 456 #pinger_timeout: 15
 457
 458 # prettydate plugin
 459 # format to use to display date
 460 prettydateformat: '%X, %B %o, %Y'
 461
 462 # recentchanges plugin
 463 # name of the recentchanges page
 464 recentchangespage: recentchanges
 465 # number of changes to track
 466 recentchangesnum: 100
 467
 468 # rsync plugin
 469 # command to run to sync updated pages
 470 #rsync_command: rsync -qa --delete . user@host:/path/to/docroot/
 471
 472 # sidebar plugin
 473 # show sidebar page on all pages?
 474 global_sidebars: 0
 475
 476 # tag plugin
 477 # parent page tags are located under
 478 #tagbase: tag
 479 # autocreate new tag pages?
 480 #tag_autocreate: 1
 481 # commit autocreated tag pages
 482 tag_autocreate_commit: 1
 483
 484 # typography plugin
 485 # Text::Typography attributes value
 486 #typographyattributes: 3
 487
 488 # underlay plugin
 489 # extra underlay directories to add
 490 #add_underlays:
 491 #  - /home/b-ikiwiki/wiki.underlay