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