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
86 # where the source of the wiki is located
87 srcdir: /home/b-ikiwiki/source/doc
88 # where to build the wiki
89 destdir: /home/b-ikiwiki/public_html
90 # base url to the wiki
91 url: http://ikiwiki.info
92 # url to the ikiwiki.cgi
93 cgiurl: http://ikiwiki.info/ikiwiki.cgi
94 # filename of cgi wrapper to generate
95 cgi_wrapper: /var/www/b-ikiwiki/ikiwiki.cgi
96 # mode for cgi_wrapper (can safely be made suid)
98 # number of seconds to delay CGI requests when overloaded
99 cgi_overload_delay: ''
100 # message to display when overloaded (may contain html)
101 cgi_overload_message: ''
102 # enable optimization of only refreshing committed changes?
103 only_committed_changes: 0
106 # plugins to add to the default configuration
152 # additional directory to search for template files
153 templatedir: /usr/share/ikiwiki/templates
154 # base wiki source location
155 underlaydir: /usr/share/ikiwiki/basewiki
156 # display verbose messages?
160 # create output files named page/index.html?
162 # use '!'-prefixed preprocessor directives?
164 # use page/index.mdwn source files
166 # enable Discussion pages?
168 # name of Discussion pages
169 discussionpage: Discussion
172 # only send cookies over SSL connections?
174 # extension to use for new pages
175 default_pageext: mdwn
176 # extension to use for html files
178 # strftime format string to display date
180 # UTF-8 locale to use
182 # put user pages below specified page
184 # how many backlinks to show before hiding excess (0 to show all)
186 # attempt to hardlink source files? (optimisation for large files)
188 # force ikiwiki to use a particular umask (keywords public, group or private, or a number)
190 # group for wrappers to run in
191 #wrappergroup: ikiwiki
192 # extra library and plugin directory
193 libdir: /home/b-ikiwiki/.ikiwiki
194 # environment variables
196 TMPDIR: /home/b-ikiwiki/tmp
199 # regexp of normally excluded files to include
200 #include: ^\.htaccess$
201 # regexp of files that should be skipped
202 #exclude: ^(*\.private|Makefile)$
203 # specifies the characters that are allowed in source filenames
204 wiki_file_chars: -[:alnum:]+/.:_
205 # allow symlinks in the path leading to the srcdir (potentially insecure)
206 allow_symlinks_before_srcdir: 0
209 file: /home/b-ikiwiki/.ikiwiki/cookies
211 ######################################################################
213 # (branchable, editpage, git, gitpush, htmlscrubber, ikiwikihosting,
214 # inline, link, meta, parentlinks)
215 ######################################################################
218 # Allow anyone to branch, check out, and copy this site?
220 # Allow anyone to git push verified changes to this site?
222 # Display "Branchable" link on action bar?
226 # git hook to generate
227 git_wrapper: /home/b-ikiwiki/source.git/hooks/post-update
228 # shell command for git_wrapper to run, in the background
229 #git_wrapper_background_command: git push github
230 # mode for git_wrapper (can safely be made suid)
231 git_wrappermode: 6755
232 # git pre-receive hook to generate
233 git_test_receive_wrapper: /home/b-ikiwiki/source.git/hooks/pre-receive
234 # unix users whose commits should be checked by the pre-receive hook
235 untrusted_committers:
237 # gitweb url to show file history ([[file]] substituted)
238 historyurl: http://source.ikiwiki.branchable.com/?p=source.git;a=history;f=doc/[[file]];hb=HEAD
239 # gitweb url to show a diff ([[file]], [[sha1_to]], [[sha1_from]], [[sha1_commit]], and [[sha1_parent]] substituted)
240 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]]
241 # where to pull and push changes (set to empty string to disable)
242 gitorigin_branch: origin
243 # branch that the wiki is stored in
244 gitmaster_branch: master
247 # git repository urls that changes are pushed to
249 - git@github.com:joeyh/ikiwiki.git
250 - joey@git.kitenet.net:/srv/git/ikiwiki.git
252 # htmlscrubber plugin
253 # PageSpec specifying pages not to scrub
254 htmlscrubber_skip: tipjar
256 # ikiwikihosting plugin
257 # list of urls that alias to the main url
259 - http://ikiwiki.branchable.com/
260 - http://ikiwiki.branchable.com/
261 - http://git.ikiwiki.info/
262 - http://www.ikiwiki.info/
263 # openid of primary site owner
264 owner: http://joey.kitenet.net/
265 # optional hostname of site this one was branched from
267 # internal hostname of this site
268 hostname: ikiwiki.branchable.com
269 # site creation datestamp
271 # how many days to retain logs
277 # enable rss feeds by default?
279 # enable atom feeds by default?
281 # allow rss feeds to be used?
283 # allow atom feeds to be used?
285 # urls to ping (using XML-RPC) on feed update
288 ######################################################################
290 # (anonok, blogspam, httpauth, lockedit, moderatedcomments,
291 # opendiscussion, openid, passwordauth, signinedit)
292 ######################################################################
295 # PageSpec to limit which pages anonymous users can edit
296 #anonok_pagespec: '*/discussion'
299 # PageSpec of pages to check for spam
300 blogspam_pagespec: '*'
301 # options to send to blogspam server
302 #blogspam_options: blacklist=1.2.3.4,blacklist=8.7.6.5,max-links=10
303 # blogspam server XML-RPC url
307 # url to redirect to when authentication is needed
308 #cgiauthurl: http://example.com/wiki/auth/ikiwiki.cgi
309 # PageSpec of pages where only httpauth will be used for authentication
310 #httpauth_pagespec: '!*/Discussion'
313 # PageSpec controlling which pages are locked
314 locked_pages: tipjar or tips/DreamHost
316 # moderatedcomments plugin
317 # PageSpec matching users or comment locations to moderate
318 #moderate_pagespec: '*'
321 # url pattern of openid realm (default is cgiurl)
323 # url to ikiwiki cgi to use for openid authentication (default is cgiurl)
326 # passwordauth plugin
327 # a password that must be entered when signing up for an account
328 #account_creation_password: s3cr1t
329 # cost of generating a password using Authen::Passphrase::BlowfishCrypt
332 ######################################################################
334 # (creole, highlight, hnb, html, mdwn, otl, po, rawhtml, rst, textile,
336 ######################################################################
339 # types of source files to syntax highlight
340 tohighlight: .c .h .cpp .pl .py Makefile:make
341 # location of highlight's filetypes.conf
342 filetypes_conf: /etc/highlight/filetypes.conf
343 # location of highlight's langDefs directory
344 langdefdir: /usr/share/highlight/langDefs
347 # enable multimarkdown features?
349 # disable use of markdown discount?
353 # master language (non-PO files)
354 #po_master_language: en|English
355 # slave languages (translated via PO files) format: ll|Langname
360 # PageSpec controlling which pages are translatable
361 po_translatable_pages: ''
362 # internal linking behavior (default/current/negotiated)
365 ######################################################################
366 # special-purpose plugins
368 ######################################################################
371 # the default zoom when you click on the map link
372 #osm_default_zoom: 15
373 # the icon shown on links and on the main map
374 #osm_default_icon: ikiwiki/images/osm.png
375 # the alt tag of links, defaults to empty
377 # the output format for waypoints, can be KML, GeoJSON or CSV (one or many, comma-separated)
379 # the icon attached to a tag, displayed on the map for tagged pages
380 #osm_tag_default_icon: icon.png
381 # Url for the OpenLayers.js file
382 #osm_openlayers_url: http://www.openlayers.org/api/OpenLayers.js
383 # 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.
385 # OSM: GoogleSatellite
386 # Google maps API key, Google layer not used if missing, see https://code.google.com/apis/console/ to get an API key
387 #osm_google_apikey: ''
390 # extra underlay directories to add
392 #- /home/b-ikiwiki/wiki.underlay
394 ######################################################################
396 # (404, attachment, comments, editdiff, edittemplate, getsource, google,
397 # goto, mirrorlist, remove, rename, repolist, search, theme, userlist,
399 ######################################################################
402 # enhanced PageSpec specifying what attachments are allowed
403 allowed_attachments: admin() and virusfree()
404 # virus checker program (reads STDIN, returns nonzero if virus found)
405 virus_checker: clamdscan -
408 # PageSpec of pages where comments are allowed
409 comments_pagespec: forum/* and !*/Discussion
410 # PageSpec of pages where posting new comments is not allowed
411 comments_closed_pagespec: ''
412 # Base name for comments, e.g. "comment_" for pages like "sandbox/comment_12"
413 comments_pagename: comment_
414 # Interpret directives in comments?
415 #comments_allowdirectives: 0
416 # Allow anonymous commenters to set an author name?
417 comments_allowauthor: 0
418 # commit comments to the VCS
420 # Restrict formats for comments to (no restriction if empty)
421 comments_allowformats: ''
424 # Mime type for returned source.
425 #getsource_mimetype: text/plain; charset=utf-8
430 # generate links that point to the mirrors' ikiwiki CGI
431 #mirrorlist_use_cgi: 1
434 # URIs of repositories containing the wiki's source
436 - ssh://b-ikiwiki@ikiwiki.branchable.com/
437 - git://ikiwiki.branchable.com/
440 # path to the omega cgi program
441 omega_cgi: /usr/lib/cgi-bin/omega/omega
442 # use google site search rather than internal xapian index?
446 # name of theme to enable
450 # list of plugins that cannot be enabled/disabled via the web interface
451 websetup_force_plugins:
456 # list of additional setup field keys to treat as unsafe
467 # show unsafe settings, read-only, in web interface?
468 websetup_show_unsafe: 0
470 ######################################################################
472 # (calendar, color, conditional, cutpaste, date, format, fortune,
473 # graphviz, haiku, headinganchors, img, linkmap, listdirectives, map,
474 # more, orphans, pagecount, pagestats, poll, polygen, postsparkline,
475 # progress, shortcut, sparkline, table, template, teximg, toc, toggle,
477 ######################################################################
480 # base of the archives hierarchy
481 #archivebase: archives
482 # PageSpec of pages to include in the archives; used by ikiwiki-calendar command
483 #archive_pagespec: page(posts/*) and !*/Discussion
485 # listdirectives plugin
486 # directory in srcdir that contains directive descriptions
487 directive_description_dir: ikiwiki/directive
490 # Should teximg use dvipng to render, or dvips and convert?
492 # LaTeX prefix for teximg plugin
493 #teximg_prefix: '\documentclass{article}
495 # \usepackage[utf8]{inputenc}
497 # \usepackage{amsmath}
499 # \usepackage{amsfonts}
501 # \usepackage{amssymb}
508 # LaTeX postfix for teximg plugin
509 #teximg_postfix: \end{document}
511 ######################################################################
513 # (aggregate, autoindex, brokenlinks, camelcase, ddate, embed, favicon,
514 # filecheck, flattr, goodstuff, htmlbalance, localstyle, missingsite,
515 # notifyemail, pagetemplate, parked, pingee, pinger, prettydate,
516 # recentchanges, recentchangesdiff, relativedate, rsync, sidebar,
517 # smiley, sortnaturally, tag, testpagespec, trail, transient, typography)
518 ######################################################################
521 # enable aggregation to internal pages?
523 # allow aggregation to be triggered via the web?
524 #aggregate_webtrigger: 0
527 # commit autocreated index pages
531 # list of words to not turn into links
532 #camelcase_ignore: []
535 # userid or user name to use by default for Flattr buttons
536 #flattr_userid: joeyh
539 # An optional message explaining why this site is parked.
543 # how many seconds to try pinging before timing out
547 # format to use to display date
548 prettydateformat: '%X, %B %o, %Y'
550 # recentchanges plugin
551 # name of the recentchanges page
552 recentchangespage: recentchanges
553 # number of changes to track
554 recentchangesnum: 100
557 # command to run to sync updated pages
558 #rsync_command: rsync -qa --delete . user@host:/path/to/docroot/
561 # show sidebar page on all pages?
565 # parent page tags are located under
567 # autocreate new tag pages?
569 # commit autocreated tag pages
570 tag_autocreate_commit: 1
573 # Text::Typography attributes value
574 #typographyattributes: 3