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: admin@branchable.com
  14 # users who are wiki admins
  15 adminuser:
  16 - http://joey.kitenet.net/
  17 - http://joeyh.name/
  18 - smcv
  19 # users who are banned from the wiki
  20 banned_users:
  21 - http://tonyguards.myopenid.com/
  22 - http://butoijoh.myopenid.com/
  23 - ip(62.219.8.238)
  24 - ip(184.105.146.11)
  25 - ip(184.105.146.6)
  26 - ip(149.135.147.88)
  27 - https://www.google.com/accounts/o8/id?id=AItOawnAq_X98v6qKJFwl-MyLb440vC8laTdiMg
  28 - https://www.google.com/accounts/o8/id?id=AItOawm_nWF_tPw8mLI7rMxfykA_d3FehQNvWpI
  29 - https://www.google.com/accounts/o8/id?id=AItOawkTn3HixU2KJIvvLXLqwYUzlDGDtYf43GE
  30 - https://www.google.com/accounts/o8/id?id=AItOawkDOCT-KTCLpieip-2W0N51gZwF7nGLaS0
  31 - https://www.google.com/accounts/o8/id?id=AItOawl8-V-Yp0F5ZWRmDb7j4ul1gsbMXjghDIU
  32 - https://www.google.com/accounts/o8/id?id=AItOawkaL6e6GtpyD7gJyqHphon_5ES1ACDLJgg
  33 - https://www.google.com/accounts/o8/id?id=AItOawnv-w7GplWln2P55lnzc6Ds-ltzk6sNxDY
  34 - https://me.yahoo.com/a/3hUnH9Qi24uk3RwCwHATJBWKVyqc#7d8b8
  35 - ip(95.65.50.150)
  36 - https://me.yahoo.com/a/2.Pjpm0G0Z6F9LiGW4cYO84pIrb.Lg--#137de
  37 - https://www.google.com/accounts/o8/id?id=AItOawkuR0eo_HO1s1hs49h0Y_4Bzm08l9evMEc
  38 - https://www.google.com/accounts/o8/id?id=AItOawlYXeKSEBoSCzES7o5VYiSratG5RfNucL0
  39 - https://www.google.com/accounts/o8/id?id=AItOawl_wuvPHDhkuMVnEOP5jLrZyd3nnBs8YRw
  40 - ip(115.43.30.149)
  41 - ikiwikiweb
  42 - webkatalog
  43 - ip(117.201.35.183)
  44 - adrianna
  45 - ip(94.179.251.118)
  46 - capitaine
  47 - ip(74.63.117.196)
  48 - ip(74.63.117.195)
  49 - testerer
  50 - ip(86.103.200.90)
  51 - AlbertF
  52 - ip(71.132.208.155)
  53 - MariaJackson
  54 - ip(208.75.10.42)
  55 - HelenOliver
  56 - ip(222.127.197.140)
  57 - GraceTemplman46
  58 - diannetyron
  59 - ip(119.111.124.194)
  60 - http://cmelbye.myopenid.com/
  61 - autobahnned
  62 - icerain321
  63 - shoesorder
  64 - AdamMeyars
  65 - essaywriter
  66 - blahgrad
  67 - alicia.warner
  68 - WikiJeanHawkins
  69 - nicole.adams
  70 - Smith
  71 - quentin
  72 - quentinfudge
  73 - https://www.google.com/accounts/o8/id?id=AItOawkJHb27RVmw93kqyzfoxZWNKjqR8MEVt3A
  74 - ip(123.26.115.218)
  75 - https://www.google.com/accounts/o8/id?id=AItOawkljravtnjpauReS81ng5zVurZx_thpse8
  76 - ip(123.26.124.157)
  77 - KataMutiara
  78 - tekschen
  79 - webschen1
  80 - ip(79.228.*.*)
  81 - soman81
  82 - ip(31.17.11.19)
  83 - spain1001
  84 - ip(80.187.*.*)
  85 - Toni
  86 - ip(124.105.173.121)
  87 - domtheo9110
  88 - https://www.google.com/accounts/o8/id?id=AItOawnO6NxsiqDMNHCMugqNKPwCWmTAQ7v_2Fs
  89 - ip(58.186.127.104)
  90 - https://pypi.python.org/id/tlevine
  91 - ip(82.153.13.48)
  92 - https://me.yahoo.com/a/FQMi.N5i0IzdnUgI0Ite4hPzi5Teukf.wOGAiQ--#4e81f
  93 - https://www.google.com/accounts/o8/id?id=AItOawlowX5C5dCp9CmqRAUSMhjaRcDEqZrLZ5M
  94 - spalax.
  95 - ip(122.173.*.*)
  96 - https://www.google.com/accounts/o8/id?id=AItOawlyeMDnU_eaFpTAKNEyeZJJIcWPdLyz3js
  97 - ip(187.209.217.54)
  98 # where the source of the wiki is located
  99 srcdir: /home/b-ikiwiki/source/doc
 100 # where to build the wiki
 101 destdir: /home/b-ikiwiki/public_html
 102 # base url to the wiki
 103 url: http://ikiwiki.info
 104 # url to the ikiwiki.cgi
 105 cgiurl: http://ikiwiki.info/ikiwiki.cgi
 106 # do not adjust cgiurl if CGI is accessed via different URL
 107 reverse_proxy: 0
 108 # filename of cgi wrapper to generate
 109 cgi_wrapper: /var/www/b-ikiwiki/ikiwiki.cgi
 110 # mode for cgi_wrapper (can safely be made suid)
 111 cgi_wrappermode: 0755
 112 # number of seconds to delay CGI requests when overloaded
 113 cgi_overload_delay: ''
 114 # message to display when overloaded (may contain html)
 115 cgi_overload_message: Please wait..
 116 # enable optimization of only refreshing committed changes?
 117 only_committed_changes: 0
 118 # rcs backend to use
 119 rcs: git
 120 # plugins to add to the default configuration
 121 add_plugins:
 122 - sidebar
 123 - goodstuff
 124 - websetup
 125 - table
 126 - haiku
 127 - html
 128 - polygen
 129 - fortune
 130 - linkmap
 131 - favicon
 132 - poll
 133 - postsparkline
 134 - sparkline
 135 - version
 136 - testpagespec
 137 - edittemplate
 138 - recentchangesdiff
 139 - 404
 140 - ikiwikihosting
 141 - branchable
 142 - recentchangesdiff
 143 - attachment
 144 - remove
 145 - rename
 146 - edittemplate
 147 - favicon
 148 - format
 149 - fortune
 150 - highlight
 151 - listdirectives
 152 - poll
 153 - progress
 154 - relativedate
 155 - search
 156 - testpagespec
 157 - version
 158 - theme
 159 - repolist
 160 - highlight
 161 - comments
 162 - gitpush
 163 - blogspam
 164 # plugins to disable
 165 disable_plugins: []
 166 # additional directory to search for template files
 167 templatedir: /usr/share/ikiwiki/templates
 168 # base wiki source location
 169 underlaydir: /usr/share/ikiwiki/basewiki
 170 # display verbose messages?
 171 #verbose: 1
 172 # log to syslog?
 173 syslog: 1
 174 # create output files named page/index.html?
 175 usedirs: 1
 176 # use '!'-prefixed preprocessor directives?
 177 prefix_directives: 1
 178 # use page/index.mdwn source files
 179 indexpages: 0
 180 # enable Discussion pages?
 181 discussion: 1
 182 # name of Discussion pages
 183 discussionpage: Discussion
 184 # use elements new in HTML5 like <section>?
 185 html5: 0
 186 # only send cookies over SSL connections?
 187 sslcookie: 0
 188 # extension to use for new pages
 189 default_pageext: mdwn
 190 # extension to use for html files
 191 htmlext: html
 192 # strftime format string to display date
 193 timeformat: '%c'
 194 # UTF-8 locale to use
 195 #locale: en_US.UTF-8
 196 # put user pages below specified page
 197 userdir: users
 198 # how many backlinks to show before hiding excess (0 to show all)
 199 numbacklinks: 10
 200 # attempt to hardlink source files? (optimisation for large files)
 201 hardlink: 1
 202 # force ikiwiki to use a particular umask (keywords public, group or private, or a number)
 203 #umask: public
 204 # group for wrappers to run in
 205 #wrappergroup: ikiwiki
 206 # extra library and plugin directories
 207 libdirs: []
 208 # extra library and plugin directory (searched after libdirs)
 209 libdir: /home/b-ikiwiki/.ikiwiki
 210 # environment variables
 211 ENV:
 212   TMPDIR: /home/b-ikiwiki/tmp
 213 # time zone name
 214 timezone: JEST+4
 215 # regexp of normally excluded files to include
 216 #include: ^\.htaccess$
 217 # regexp of files that should be skipped
 218 #exclude: ^(*\.private|Makefile)$
 219 # specifies the characters that are allowed in source filenames
 220 wiki_file_chars: -[:alnum:]+/.:_
 221 # allow symlinks in the path leading to the srcdir (potentially insecure)
 222 allow_symlinks_before_srcdir: 0
 223 # cookie control
 224 cookiejar:
 225   file: /home/b-ikiwiki/.ikiwiki/cookies
 226 # set custom user agent string for outbound HTTP requests e.g. when fetching aggregated RSS feeds
 227 useragent: ikiwiki/3.20150330
 228 # theme has a responsive layout? (mobile-optimized)
 229 responsive_layout: 1
 230 # try harder to produce deterministic output
 231 deterministic: 0
 232
 233 ######################################################################
 234 # core plugins
 235 #   (branchable, editpage, git, gitpush, htmlscrubber, ikiwikihosting,
 236 #    inline, link, meta, parentlinks, templatebody)
 237 ######################################################################
 238
 239 # branchable plugin
 240 # Allow anyone to branch, check out, and copy this site?
 241 branchable: 1
 242 # Allow anyone to git push verified changes to this site?
 243 anonpush: 1
 244 # Display "Branchable" link on action bar?
 245 branchable_action: 1
 246
 247 # git plugin
 248 # git hook to generate
 249 git_wrapper: /home/b-ikiwiki/source.git/hooks/post-update
 250 # shell command for git_wrapper to run, in the background
 251 #git_wrapper_background_command: git push github
 252 # mode for git_wrapper (can safely be made suid)
 253 git_wrappermode: 6755
 254 # git pre-receive hook to generate
 255 git_test_receive_wrapper: /home/b-ikiwiki/source.git/hooks/pre-receive
 256 # unix users whose commits should be checked by the pre-receive hook
 257 untrusted_committers:
 258 - ikiwiki-anon
 259 # gitweb url to show file history ([[file]] substituted)
 260 historyurl: http://source.ikiwiki.branchable.com/?p=source.git;a=history;f=doc/[[file]];hb=HEAD
 261 # gitweb url to show a diff ([[file]], [[sha1_to]], [[sha1_from]], [[sha1_commit]], and [[sha1_parent]] substituted)
 262 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]]
 263 # where to pull and push changes (set to empty string to disable)
 264 gitorigin_branch: origin
 265 # branch that the wiki is stored in
 266 gitmaster_branch: master
 267
 268 # gitpush plugin
 269 # git repository urls that changes are pushed to
 270 git_push_to:
 271 - git@github.com:joeyh/ikiwiki.git
 272 - joey@git.kitenet.net:/srv/git/ikiwiki.git
 273
 274 # htmlscrubber plugin
 275 # PageSpec specifying pages not to scrub
 276 htmlscrubber_skip: tipjar
 277
 278 # ikiwikihosting plugin
 279 # list of urls that alias to the main url
 280 urlalias:
 281 - http://ikiwiki.branchable.com/
 282 - http://ikiwiki.branchable.com/
 283 - http://git.ikiwiki.info/
 284 - http://www.ikiwiki.info/
 285 # openid or email of primary site owner
 286 owner: http://joey.kitenet.net/
 287 # optional hostname of site this one was branched from
 288 #parent: ''
 289 # internal hostname of this site
 290 hostname: ikiwiki.branchable.com
 291 # site creation datestamp
 292 created: 1305836524
 293 # how many days to retain logs
 294 #log_period: 7
 295 # disable IPv6?
 296 ipv6_disabled: 0
 297 # redirect from http to https?
 298 redirect_to_https: 0
 299
 300 # inline plugin
 301 # enable rss feeds by default?
 302 rss: 1
 303 # enable atom feeds by default?
 304 atom: 0
 305 # allow rss feeds to be used?
 306 #allowrss: 0
 307 # allow atom feeds to be used?
 308 allowatom: 1
 309 # urls to ping (using XML-RPC) on feed update
 310 pingurl: []
 311
 312 ######################################################################
 313 # auth plugins
 314 #   (anonok, blogspam, emailauth, httpauth, lockedit, moderatedcomments,
 315 #    opendiscussion, openid, passwordauth, signinedit)
 316 ######################################################################
 317
 318 # anonok plugin
 319 # PageSpec to limit which pages anonymous users can edit
 320 #anonok_pagespec: '*/discussion'
 321
 322 # blogspam plugin
 323 # PageSpec of pages to check for spam
 324 blogspam_pagespec: '*'
 325 # options to send to blogspam server
 326 #blogspam_options: blacklist=1.2.3.4,blacklist=8.7.6.5,max-links=10
 327 # blogspam server JSON url
 328 #blogspam_server: ''
 329
 330 # emailauth plugin
 331 # email address to send emailauth mails as (default: adminemail)
 332 emailauth_sender: login@branchable.com
 333
 334 # httpauth plugin
 335 # url to redirect to when authentication is needed
 336 #cgiauthurl: http://example.com/wiki/auth/ikiwiki.cgi
 337 # PageSpec of pages where only httpauth will be used for authentication
 338 #httpauth_pagespec: '!*/Discussion'
 339
 340 # lockedit plugin
 341 # PageSpec controlling which pages are locked
 342 locked_pages: tipjar or tips/DreamHost
 343
 344 # moderatedcomments plugin
 345 # PageSpec matching users or comment locations to moderate
 346 #moderate_pagespec: '*'
 347
 348 # openid plugin
 349 # url pattern of openid realm (default is cgiurl)
 350 #openid_realm: ''
 351 # url to ikiwiki cgi to use for openid authentication (default is cgiurl)
 352 #openid_cgiurl: ''
 353
 354 # passwordauth plugin
 355 # a password that must be entered when signing up for an account
 356 #account_creation_password: s3cr1t
 357 # cost of generating a password using Authen::Passphrase::BlowfishCrypt
 358 #password_cost: 8
 359
 360 ######################################################################
 361 # format plugins
 362 #   (creole, highlight, hnb, html, mdwn, otl, po, rawhtml, rst, textile,
 363 #    txt)
 364 ######################################################################
 365
 366 # highlight plugin
 367 # types of source files to syntax highlight
 368 tohighlight: .c .h .cpp .pl .py Makefile:make
 369 # location of highlight's filetypes.conf
 370 filetypes_conf: /etc/highlight/filetypes.conf
 371 # location of highlight's langDefs directory
 372 langdefdir: /usr/share/highlight/langDefs
 373
 374 # mdwn plugin
 375 # enable multimarkdown features?
 376 #multimarkdown: 0
 377 # disable use of markdown discount?
 378 #nodiscount: 0
 379
 380 # po plugin
 381 # master language (non-PO files)
 382 #po_master_language: en|English
 383 # slave languages (translated via PO files) format: ll|Langname
 384 #po_slave_languages:
 385 #- fr|FranÃ§ais
 386 #- es|EspaÃ±ol
 387 #- de|Deutsch
 388 # PageSpec controlling which pages are translatable
 389 po_translatable_pages: ''
 390 # internal linking behavior (default/current/negotiated)
 391 po_link_to: default
 392
 393 ######################################################################
 394 # special-purpose plugins
 395 #   (osm, underlay)
 396 ######################################################################
 397
 398 # osm plugin
 399 # the default zoom when you click on the map link
 400 #osm_default_zoom: 15
 401 # the icon shown on links and on the main map
 402 #osm_default_icon: ikiwiki/images/osm.png
 403 # the alt tag of links, defaults to empty
 404 #osm_alt: ''
 405 # the output format for waypoints, can be KML, GeoJSON or CSV (one or many, comma-separated)
 406 #osm_format: KML
 407 # the icon attached to a tag, displayed on the map for tagged pages
 408 #osm_tag_default_icon: icon.png
 409 # Url for the OpenLayers.js file
 410 #osm_openlayers_url: http://www.openlayers.org/api/OpenLayers.js
 411 # Layers to use in the map. Can be either the 'OSM' string or a type option for Google maps (GoogleNormal, GoogleSatellite, GoogleHybrid or GooglePhysical). It can also be an arbitrary URL in a syntax acceptable for OpenLayers.Layer.OSM.url parameter.
 412 #osm_layers:
 413 #  OSM: GoogleSatellite
 414 # Google maps API key, Google layer not used if missing, see https://code.google.com/apis/console/ to get an API key
 415 #osm_google_apikey: ''
 416
 417 # underlay plugin
 418 # extra underlay directories to add
 419 #add_underlays:
 420 #- /home/b-ikiwiki/wiki.underlay
 421
 422 ######################################################################
 423 # web plugins
 424 #   (404, attachment, comments, editdiff, edittemplate, getsource, google,
 425 #    goto, mirrorlist, remove, rename, repolist, search, theme, userlist,
 426 #    websetup, wmd)
 427 ######################################################################
 428
 429 # attachment plugin
 430 # enhanced PageSpec specifying what attachments are allowed
 431 allowed_attachments: admin() and virusfree()
 432 # virus checker program (reads STDIN, returns nonzero if virus found)
 433 virus_checker: clamdscan -
 434
 435 # comments plugin
 436 # PageSpec of pages where comments are allowed
 437 comments_pagespec: forum/* and !*/Discussion
 438 # PageSpec of pages where posting new comments is not allowed
 439 comments_closed_pagespec: ''
 440 # Base name for comments, e.g. "comment_" for pages like "sandbox/comment_12"
 441 comments_pagename: comment_
 442 # Interpret directives in comments?
 443 #comments_allowdirectives: 0
 444 # Allow anonymous commenters to set an author name?
 445 comments_allowauthor: 0
 446 # commit comments to the VCS
 447 comments_commit: 1
 448 # Restrict formats for comments to (no restriction if empty)
 449 comments_allowformats: ''
 450
 451 # getsource plugin
 452 # Mime type for returned source.
 453 #getsource_mimetype: text/plain; charset=utf-8
 454
 455 # mirrorlist plugin
 456 # list of mirrors
 457 #mirrorlist: {}
 458 # generate links that point to the mirrors' ikiwiki CGI
 459 #mirrorlist_use_cgi: 1
 460
 461 # repolist plugin
 462 # URIs of repositories containing the wiki's source
 463 repositories:
 464 - ssh://b-ikiwiki@ikiwiki.branchable.com/
 465 - git://ikiwiki.branchable.com/
 466
 467 # search plugin
 468 # path to the omega cgi program
 469 omega_cgi: /usr/lib/cgi-bin/omega/omega
 470 # use google site search rather than internal xapian index?
 471 google_search: 1
 472
 473 # theme plugin
 474 # name of theme to enable
 475 #theme: actiontabs
 476
 477 # websetup plugin
 478 # list of plugins that cannot be enabled/disabled via the web interface
 479 websetup_force_plugins:
 480 - httpauth
 481 - openid
 482 - mdwn
 483 - wmd
 484 # list of additional setup field keys to treat as unsafe
 485 websetup_unsafe:
 486 - url
 487 - cgiurl
 488 - verbose
 489 - syslog
 490 - usedirs
 491 - prefix_directives
 492 - indexpages
 493 - repositories
 494 - sslcookie
 495 # show unsafe settings, read-only, in web interface?
 496 websetup_show_unsafe: 0
 497
 498 ######################################################################
 499 # widget plugins
 500 #   (calendar, color, conditional, cutpaste, date, format, fortune,
 501 #    graphviz, haiku, headinganchors, img, linkmap, listdirectives, map,
 502 #    more, orphans, pagecount, pagestats, poll, polygen, postsparkline,
 503 #    progress, shortcut, sparkline, table, template, teximg, toc, toggle,
 504 #    version)
 505 ######################################################################
 506
 507 # calendar plugin
 508 # base of the archives hierarchy
 509 #archivebase: archives
 510 # PageSpec of pages to include in the archives, if option `calendar_autocreate` is true.
 511 #archive_pagespec: page(posts/*) and !*/Discussion
 512 # autocreate new calendar pages?
 513 #calendar_autocreate: 1
 514 # if set, when building calendar pages, also build pages of year and month when no pages were published (building empty calendars).
 515 #calendar_fill_gaps: 1
 516
 517 # listdirectives plugin
 518 # directory in srcdir that contains directive descriptions
 519 directive_description_dir: ikiwiki/directive
 520
 521 # teximg plugin
 522 # Should teximg use dvipng to render, or dvips and convert?
 523 #teximg_dvipng: ''
 524 # LaTeX prefix for teximg plugin
 525 #teximg_prefix: '\documentclass{article}
 526 #
 527 #  \usepackage[utf8]{inputenc}
 528 #
 529 #  \usepackage{amsmath}
 530 #
 531 #  \usepackage{amsfonts}
 532 #
 533 #  \usepackage{amssymb}
 534 #
 535 #  \pagestyle{empty}
 536 #
 537 #  \begin{document}
 538 #
 539 #'
 540 # LaTeX postfix for teximg plugin
 541 #teximg_postfix: \end{document}
 542
 543 ######################################################################
 544 # other plugins
 545 #   (aggregate, autoindex, brokenlinks, camelcase, ddate, embed, favicon,
 546 #    filecheck, flattr, goodstuff, htmlbalance, localstyle, loginselector,
 547 #    missingsite, notifyemail, pagetemplate, parked, pingee, pinger,
 548 #    prettydate, recentchanges, recentchangesdiff, relativedate, rsync,
 549 #    sidebar, smiley, sortnaturally, tag, testpagespec, trail, transient,
 550 #    typography)
 551 ######################################################################
 552
 553 # aggregate plugin
 554 # enable aggregation to internal pages?
 555 aggregateinternal: 1
 556 # allow aggregation to be triggered via the web?
 557 #aggregate_webtrigger: 0
 558
 559 # autoindex plugin
 560 # commit autocreated index pages
 561 autoindex_commit: 1
 562
 563 # camelcase plugin
 564 # list of words to not turn into links
 565 #camelcase_ignore: []
 566
 567 # flattr plugin
 568 # userid or user name to use by default for Flattr buttons
 569 #flattr_userid: joeyh
 570
 571 # parked plugin
 572 # An optional message explaining why this site is parked.
 573 #parked_message: ''
 574
 575 # pinger plugin
 576 # how many seconds to try pinging before timing out
 577 #pinger_timeout: 15
 578
 579 # prettydate plugin
 580 # format to use to display date
 581 prettydateformat: '%X, %B %o, %Y'
 582
 583 # recentchanges plugin
 584 # name of the recentchanges page
 585 recentchangespage: recentchanges
 586 # number of changes to track
 587 recentchangesnum: 100
 588
 589 # rsync plugin
 590 # command to run to sync updated pages
 591 #rsync_command: rsync -qa --delete . user@host:/path/to/docroot/
 592
 593 # sidebar plugin
 594 # show sidebar page on all pages?
 595 global_sidebars: 0
 596
 597 # tag plugin
 598 # parent page tags are located under
 599 #tagbase: tag
 600 # autocreate new tag pages?
 601 #tag_autocreate: 1
 602 # commit autocreated tag pages
 603 tag_autocreate_commit: 1
 604
 605 # typography plugin
 606 # Text::Typography attributes value
 607 #typographyattributes: 3