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