1 # IkiWiki::Setup::Yaml - YAML formatted setup file
3 # Setup file for ikiwiki.
5 # Passing this to ikiwiki --setup will make ikiwiki generate
6 # wrappers and build the wiki.
8 # Remember to re-run ikiwiki --setup any time you edit this file.
12 # contact email for wiki
13 adminemail: joey@ikiwiki.info
14 # users who are wiki admins
16 - http://joey.kitenet.net/
18 # users who are banned from the wiki
20 - http://tonyguards.myopenid.com/
21 - http://butoijoh.myopenid.com/
26 - https://www.google.com/accounts/o8/id?id=AItOawnAq_X98v6qKJFwl-MyLb440vC8laTdiMg
27 - https://www.google.com/accounts/o8/id?id=AItOawm_nWF_tPw8mLI7rMxfykA_d3FehQNvWpI
28 - https://www.google.com/accounts/o8/id?id=AItOawkTn3HixU2KJIvvLXLqwYUzlDGDtYf43GE
29 - https://www.google.com/accounts/o8/id?id=AItOawkDOCT-KTCLpieip-2W0N51gZwF7nGLaS0
30 - https://www.google.com/accounts/o8/id?id=AItOawl8-V-Yp0F5ZWRmDb7j4ul1gsbMXjghDIU
31 - https://www.google.com/accounts/o8/id?id=AItOawkaL6e6GtpyD7gJyqHphon_5ES1ACDLJgg
32 - https://www.google.com/accounts/o8/id?id=AItOawnv-w7GplWln2P55lnzc6Ds-ltzk6sNxDY
33 - https://me.yahoo.com/a/3hUnH9Qi24uk3RwCwHATJBWKVyqc#7d8b8
35 - https://me.yahoo.com/a/2.Pjpm0G0Z6F9LiGW4cYO84pIrb.Lg--#137de
36 - https://www.google.com/accounts/o8/id?id=AItOawkuR0eo_HO1s1hs49h0Y_4Bzm08l9evMEc
37 - https://www.google.com/accounts/o8/id?id=AItOawlYXeKSEBoSCzES7o5VYiSratG5RfNucL0
38 - https://www.google.com/accounts/o8/id?id=AItOawl_wuvPHDhkuMVnEOP5jLrZyd3nnBs8YRw
59 - http://cmelbye.myopenid.com/
72 - https://www.google.com/accounts/o8/id?id=AItOawkJHb27RVmw93kqyzfoxZWNKjqR8MEVt3A
74 - https://www.google.com/accounts/o8/id?id=AItOawkljravtnjpauReS81ng5zVurZx_thpse8
87 # where the source of the wiki is located
88 srcdir: /home/b-ikiwiki/source/doc
89 # where to build the wiki
90 destdir: /home/b-ikiwiki/public_html
91 # base url to the wiki
92 url: http://ikiwiki.info
93 # url to the ikiwiki.cgi
94 cgiurl: http://ikiwiki.info/ikiwiki.cgi
95 # filename of cgi wrapper to generate
96 cgi_wrapper: /var/www/b-ikiwiki/ikiwiki.cgi
97 # mode for cgi_wrapper (can safely be made suid)
99 # number of seconds to delay CGI requests when overloaded
100 cgi_overload_delay: ''
101 # message to display when overloaded (may contain html)
102 cgi_overload_message: ''
103 # enable optimization of only refreshing committed changes?
104 only_committed_changes: 0
107 # plugins to add to the default configuration
153 # additional directory to search for template files
154 templatedir: /usr/share/ikiwiki/templates
155 # base wiki source location
156 underlaydir: /usr/share/ikiwiki/basewiki
157 # display verbose messages?
161 # create output files named page/index.html?
163 # use '!'-prefixed preprocessor directives?
165 # use page/index.mdwn source files
167 # enable Discussion pages?
169 # name of Discussion pages
170 discussionpage: Discussion
173 # only send cookies over SSL connections?
175 # extension to use for new pages
176 default_pageext: mdwn
177 # extension to use for html files
179 # strftime format string to display date
181 # UTF-8 locale to use
183 # put user pages below specified page
185 # how many backlinks to show before hiding excess (0 to show all)
187 # attempt to hardlink source files? (optimisation for large files)
189 # force ikiwiki to use a particular umask (keywords public, group or private, or a number)
191 # group for wrappers to run in
192 #wrappergroup: ikiwiki
193 # extra library and plugin directory
194 libdir: /home/b-ikiwiki/.ikiwiki
195 # environment variables
197 TMPDIR: /home/b-ikiwiki/tmp
200 # regexp of normally excluded files to include
201 #include: ^\.htaccess$
202 # regexp of files that should be skipped
203 #exclude: ^(*\.private|Makefile)$
204 # specifies the characters that are allowed in source filenames
205 wiki_file_chars: -[:alnum:]+/.:_
206 # allow symlinks in the path leading to the srcdir (potentially insecure)
207 allow_symlinks_before_srcdir: 0
210 file: /home/b-ikiwiki/.ikiwiki/cookies
212 ######################################################################
214 # (branchable, editpage, git, gitpush, htmlscrubber, ikiwikihosting,
215 # inline, link, meta, parentlinks)
216 ######################################################################
219 # Allow anyone to branch, check out, and copy this site?
221 # Allow anyone to git push verified changes to this site?
223 # Display "Branchable" link on action bar?
227 # git hook to generate
228 git_wrapper: /home/b-ikiwiki/source.git/hooks/post-update
229 # shell command for git_wrapper to run, in the background
230 #git_wrapper_background_command: git push github
231 # mode for git_wrapper (can safely be made suid)
232 git_wrappermode: 6755
233 # git pre-receive hook to generate
234 git_test_receive_wrapper: /home/b-ikiwiki/source.git/hooks/pre-receive
235 # unix users whose commits should be checked by the pre-receive hook
236 untrusted_committers:
238 # gitweb url to show file history ([[file]] substituted)
239 historyurl: http://source.ikiwiki.branchable.com/?p=source.git;a=history;f=doc/[[file]];hb=HEAD
240 # gitweb url to show a diff ([[file]], [[sha1_to]], [[sha1_from]], [[sha1_commit]], and [[sha1_parent]] substituted)
241 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]]
242 # where to pull and push changes (set to empty string to disable)
243 gitorigin_branch: origin
244 # branch that the wiki is stored in
245 gitmaster_branch: master
248 # git repository urls that changes are pushed to
250 - git@github.com:joeyh/ikiwiki.git
251 - joey@git.kitenet.net:/srv/git/ikiwiki.git
253 # htmlscrubber plugin
254 # PageSpec specifying pages not to scrub
255 htmlscrubber_skip: tipjar
257 # ikiwikihosting plugin
258 # list of urls that alias to the main url
260 - http://ikiwiki.branchable.com/
261 - http://ikiwiki.branchable.com/
262 - http://git.ikiwiki.info/
263 - http://www.ikiwiki.info/
264 # openid of primary site owner
265 owner: http://joey.kitenet.net/
266 # optional hostname of site this one was branched from
268 # internal hostname of this site
269 hostname: ikiwiki.branchable.com
270 # site creation datestamp
272 # how many days to retain logs
278 # enable rss feeds by default?
280 # enable atom feeds by default?
282 # allow rss feeds to be used?
284 # allow atom feeds to be used?
286 # urls to ping (using XML-RPC) on feed update
289 ######################################################################
291 # (anonok, blogspam, httpauth, lockedit, moderatedcomments,
292 # opendiscussion, openid, passwordauth, signinedit)
293 ######################################################################
296 # PageSpec to limit which pages anonymous users can edit
297 #anonok_pagespec: '*/discussion'
300 # PageSpec of pages to check for spam
301 blogspam_pagespec: '*'
302 # options to send to blogspam server
303 #blogspam_options: blacklist=1.2.3.4,blacklist=8.7.6.5,max-links=10
304 # blogspam server XML-RPC url
308 # url to redirect to when authentication is needed
309 #cgiauthurl: http://example.com/wiki/auth/ikiwiki.cgi
310 # PageSpec of pages where only httpauth will be used for authentication
311 #httpauth_pagespec: '!*/Discussion'
314 # PageSpec controlling which pages are locked
315 locked_pages: tipjar or tips/DreamHost
317 # moderatedcomments plugin
318 # PageSpec matching users or comment locations to moderate
319 #moderate_pagespec: '*'
322 # url pattern of openid realm (default is cgiurl)
324 # url to ikiwiki cgi to use for openid authentication (default is cgiurl)
327 # passwordauth plugin
328 # a password that must be entered when signing up for an account
329 #account_creation_password: s3cr1t
330 # cost of generating a password using Authen::Passphrase::BlowfishCrypt
333 ######################################################################
335 # (creole, highlight, hnb, html, mdwn, otl, po, rawhtml, rst, textile,
337 ######################################################################
340 # types of source files to syntax highlight
341 tohighlight: .c .h .cpp .pl .py Makefile:make
342 # location of highlight's filetypes.conf
343 filetypes_conf: /etc/highlight/filetypes.conf
344 # location of highlight's langDefs directory
345 langdefdir: /usr/share/highlight/langDefs
348 # enable multimarkdown features?
350 # disable use of markdown discount?
354 # master language (non-PO files)
355 #po_master_language: en|English
356 # slave languages (translated via PO files) format: ll|Langname
361 # PageSpec controlling which pages are translatable
362 po_translatable_pages: ''
363 # internal linking behavior (default/current/negotiated)
366 ######################################################################
367 # special-purpose plugins
369 ######################################################################
372 # the default zoom when you click on the map link
373 #osm_default_zoom: 15
374 # the icon shown on links and on the main map
375 #osm_default_icon: ikiwiki/images/osm.png
376 # the alt tag of links, defaults to empty
378 # the output format for waypoints, can be KML, GeoJSON or CSV (one or many, comma-separated)
380 # the icon attached to a tag, displayed on the map for tagged pages
381 #osm_tag_default_icon: icon.png
382 # Url for the OpenLayers.js file
383 #osm_openlayers_url: http://www.openlayers.org/api/OpenLayers.js
384 # 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.
386 # OSM: GoogleSatellite
387 # Google maps API key, Google layer not used if missing, see https://code.google.com/apis/console/ to get an API key
388 #osm_google_apikey: ''
391 # extra underlay directories to add
393 #- /home/b-ikiwiki/wiki.underlay
395 ######################################################################
397 # (404, attachment, comments, editdiff, edittemplate, getsource, google,
398 # goto, mirrorlist, remove, rename, repolist, search, theme, userlist,
400 ######################################################################
403 # enhanced PageSpec specifying what attachments are allowed
404 allowed_attachments: admin() and virusfree()
405 # virus checker program (reads STDIN, returns nonzero if virus found)
406 virus_checker: clamdscan -
409 # PageSpec of pages where comments are allowed
410 comments_pagespec: forum/* and !*/Discussion
411 # PageSpec of pages where posting new comments is not allowed
412 comments_closed_pagespec: ''
413 # Base name for comments, e.g. "comment_" for pages like "sandbox/comment_12"
414 comments_pagename: comment_
415 # Interpret directives in comments?
416 #comments_allowdirectives: 0
417 # Allow anonymous commenters to set an author name?
418 comments_allowauthor: 0
419 # commit comments to the VCS
421 # Restrict formats for comments to (no restriction if empty)
422 comments_allowformats: ''
425 # Mime type for returned source.
426 #getsource_mimetype: text/plain; charset=utf-8
431 # generate links that point to the mirrors' ikiwiki CGI
432 #mirrorlist_use_cgi: 1
435 # URIs of repositories containing the wiki's source
437 - ssh://b-ikiwiki@ikiwiki.branchable.com/
438 - git://ikiwiki.branchable.com/
441 # path to the omega cgi program
442 omega_cgi: /usr/lib/cgi-bin/omega/omega
443 # use google site search rather than internal xapian index?
447 # name of theme to enable
451 # list of plugins that cannot be enabled/disabled via the web interface
452 websetup_force_plugins:
457 # list of additional setup field keys to treat as unsafe
468 # show unsafe settings, read-only, in web interface?
469 websetup_show_unsafe: 0
471 ######################################################################
473 # (calendar, color, conditional, cutpaste, date, format, fortune,
474 # graphviz, haiku, headinganchors, img, linkmap, listdirectives, map,
475 # more, orphans, pagecount, pagestats, poll, polygen, postsparkline,
476 # progress, shortcut, sparkline, table, template, teximg, toc, toggle,
478 ######################################################################
481 # base of the archives hierarchy
482 #archivebase: archives
483 # PageSpec of pages to include in the archives; used by ikiwiki-calendar command
484 #archive_pagespec: page(posts/*) and !*/Discussion
486 # listdirectives plugin
487 # directory in srcdir that contains directive descriptions
488 directive_description_dir: ikiwiki/directive
491 # Should teximg use dvipng to render, or dvips and convert?
493 # LaTeX prefix for teximg plugin
494 #teximg_prefix: '\documentclass{article}
496 # \usepackage[utf8]{inputenc}
498 # \usepackage{amsmath}
500 # \usepackage{amsfonts}
502 # \usepackage{amssymb}
509 # LaTeX postfix for teximg plugin
510 #teximg_postfix: \end{document}
512 ######################################################################
514 # (aggregate, autoindex, brokenlinks, camelcase, ddate, embed, favicon,
515 # filecheck, flattr, goodstuff, htmlbalance, localstyle, missingsite,
516 # notifyemail, pagetemplate, parked, pingee, pinger, prettydate,
517 # recentchanges, recentchangesdiff, relativedate, rsync, sidebar,
518 # smiley, sortnaturally, tag, testpagespec, trail, transient, typography)
519 ######################################################################
522 # enable aggregation to internal pages?
524 # allow aggregation to be triggered via the web?
525 #aggregate_webtrigger: 0
528 # commit autocreated index pages
532 # list of words to not turn into links
533 #camelcase_ignore: []
536 # userid or user name to use by default for Flattr buttons
537 #flattr_userid: joeyh
540 # An optional message explaining why this site is parked.
544 # how many seconds to try pinging before timing out
548 # format to use to display date
549 prettydateformat: '%X, %B %o, %Y'
551 # recentchanges plugin
552 # name of the recentchanges page
553 recentchangespage: recentchanges
554 # number of changes to track
555 recentchangesnum: 100
558 # command to run to sync updated pages
559 #rsync_command: rsync -qa --delete . user@host:/path/to/docroot/
562 # show sidebar page on all pages?
566 # parent page tags are located under
568 # autocreate new tag pages?
570 # commit autocreated tag pages
571 tag_autocreate_commit: 1
574 # Text::Typography attributes value
575 #typographyattributes: 3