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