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 - https://www.google.com/accounts/o8/id?id=AItOawkTn3HixU2KJIvvLXLqwYUzlDGDtYf43GE
21 - https://www.google.com/accounts/o8/id?id=AItOawkDOCT-KTCLpieip-2W0N51gZwF7nGLaS0
22 - https://www.google.com/accounts/o8/id?id=AItOawl8-V-Yp0F5ZWRmDb7j4ul1gsbMXjghDIU
23 - https://www.google.com/accounts/o8/id?id=AItOawkaL6e6GtpyD7gJyqHphon_5ES1ACDLJgg
24 - https://www.google.com/accounts/o8/id?id=AItOawnv-w7GplWln2P55lnzc6Ds-ltzk6sNxDY
25 - https://me.yahoo.com/a/3hUnH9Qi24uk3RwCwHATJBWKVyqc#7d8b8
27 - https://me.yahoo.com/a/2.Pjpm0G0Z6F9LiGW4cYO84pIrb.Lg--#137de
28 - https://www.google.com/accounts/o8/id?id=AItOawkuR0eo_HO1s1hs49h0Y_4Bzm08l9evMEc
29 - https://www.google.com/accounts/o8/id?id=AItOawlYXeKSEBoSCzES7o5VYiSratG5RfNucL0
30 - https://www.google.com/accounts/o8/id?id=AItOawl_wuvPHDhkuMVnEOP5jLrZyd3nnBs8YRw
51 - http://cmelbye.myopenid.com/
64 - https://www.google.com/accounts/o8/id?id=AItOawkJHb27RVmw93kqyzfoxZWNKjqR8MEVt3A
66 - https://www.google.com/accounts/o8/id?id=AItOawkljravtnjpauReS81ng5zVurZx_thpse8
69 # where the source of the wiki is located
70 srcdir: /home/b-ikiwiki/source/doc
71 # where to build the wiki
72 destdir: /home/b-ikiwiki/public_html
73 # base url to the wiki
74 url: http://ikiwiki.info
75 # url to the ikiwiki.cgi
76 cgiurl: http://ikiwiki.info/ikiwiki.cgi
77 # filename of cgi wrapper to generate
78 cgi_wrapper: /var/www/b-ikiwiki/ikiwiki.cgi
79 # mode for cgi_wrapper (can safely be made suid)
83 # plugins to add to the default configuration
128 # additional directory to search for template files
129 templatedir: /usr/share/ikiwiki/templates
130 # base wiki source location
131 underlaydir: /usr/share/ikiwiki/basewiki
132 # display verbose messages?
136 # create output files named page/index.html?
138 # use '!'-prefixed preprocessor directives?
140 # use page/index.mdwn source files
142 # enable Discussion pages?
144 # name of Discussion pages
145 discussionpage: Discussion
148 # only send cookies over SSL connections?
150 # extension to use for new pages
151 default_pageext: mdwn
152 # extension to use for html files
154 # strftime format string to display date
156 # UTF-8 locale to use
158 # put user pages below specified page
160 # how many backlinks to show before hiding excess (0 to show all)
162 # attempt to hardlink source files? (optimisation for large files)
164 # force ikiwiki to use a particular umask
166 # group for wrappers to run in
167 #wrappergroup: ikiwiki
168 # extra library and plugin directory
169 libdir: /home/b-ikiwiki/.ikiwiki
170 # environment variables
172 TMPDIR: /home/b-ikiwiki/tmp
175 # regexp of normally excluded files to include
176 #include: '^\.htaccess$'
177 # regexp of files that should be skipped
178 #exclude: '^(*\.private|Makefile)$'
179 # specifies the characters that are allowed in source filenames
180 wiki_file_chars: '-[:alnum:]+/.:_'
181 # allow symlinks in the path leading to the srcdir (potentially insecure)
182 allow_symlinks_before_srcdir: 0
184 ######################################################################
186 # (branchable, editpage, git, gitpush, htmlscrubber, ikiwikihosting,
187 # inline, link, meta, parentlinks)
188 ######################################################################
191 # Allow anyone to branch, check out, and copy this site?
193 # Allow anyone to git push verified changes to this site?
195 # Display "Branchable" link on action bar?
199 # git hook to generate
200 git_wrapper: /home/b-ikiwiki/source.git/hooks/post-update
201 # shell command for git_wrapper to run, in the background
202 #git_wrapper_background_command: git push github
203 # mode for git_wrapper (can safely be made suid)
204 git_wrappermode: 6755
205 # git pre-receive hook to generate
206 git_test_receive_wrapper: /home/b-ikiwiki/source.git/hooks/pre-receive
207 # unix users whose commits should be checked by the pre-receive hook
208 untrusted_committers:
210 # gitweb url to show file history ([[file]] substituted)
211 historyurl: 'http://source.ikiwiki.branchable.com/?p=source.git;a=history;f=doc/[[file]];hb=HEAD'
212 # gitweb url to show a diff ([[file]], [[sha1_to]], [[sha1_from]], [[sha1_commit]], and [[sha1_parent]] substituted)
213 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]]'
214 # where to pull and push changes (set to empty string to disable)
215 gitorigin_branch: origin
216 # branch that the wiki is stored in
217 gitmaster_branch: master
220 # git repository urls that changes are pushed to
222 - git@github.com:joeyh/ikiwiki.git
223 - joey@git.kitenet.net:/srv/git/ikiwiki.git
225 # htmlscrubber plugin
226 # PageSpec specifying pages not to scrub
227 htmlscrubber_skip: tipjar
229 # ikiwikihosting plugin
230 # list of urls that alias to the main url
232 - http://ikiwiki.branchable.com/
233 - http://ikiwiki.branchable.com/
234 - http://git.ikiwiki.info/
235 - http://www.ikiwiki.info/
236 # openid of primary site owner
237 owner: http://joey.kitenet.net/
238 # optional hostname of site this one was branched from
240 # internal hostname of this site
241 hostname: ikiwiki.branchable.com
242 # site creation datestamp
244 # how many days to retain logs
250 # enable rss feeds by default?
252 # enable atom feeds by default?
254 # allow rss feeds to be used?
256 # allow atom feeds to be used?
258 # urls to ping (using XML-RPC) on feed update
261 ######################################################################
263 # (anonok, blogspam, httpauth, lockedit, moderatedcomments,
264 # opendiscussion, openid, passwordauth, signinedit)
265 ######################################################################
268 # PageSpec to limit which pages anonymous users can edit
269 #anonok_pagespec: '*/discussion'
272 # PageSpec of pages to check for spam
273 #blogspam_pagespec: postcomment(*)
274 # options to send to blogspam server
275 #blogspam_options: 'blacklist=1.2.3.4,blacklist=8.7.6.5,max-links=10'
276 # blogspam server XML-RPC url
280 # url to redirect to when authentication is needed
281 #cgiauthurl: http://example.com/wiki/auth/ikiwiki.cgi
282 # PageSpec of pages where only httpauth will be used for authentication
283 #httpauth_pagespec: '!*/Discussion'
286 # PageSpec controlling which pages are locked
289 # moderatedcomments plugin
290 # PageSpec matching users or comment locations to moderate
291 #moderate_pagespec: '*'
294 # url pattern of openid realm (default is cgiurl)
295 openid_realm: http://*.branchable.com/
296 # url to ikiwiki cgi to use for openid authentication (default is cgiurl)
297 openid_cgiurl: http://ikiwiki.branchable.com/ikiwiki.cgi
299 # passwordauth plugin
300 # a password that must be entered when signing up for an account
301 #account_creation_password: s3cr1t
302 # cost of generating a password using Authen::Passphrase::BlowfishCrypt
305 ######################################################################
307 # (creole, highlight, hnb, html, mdwn, otl, po, rawhtml, rst, textile,
309 ######################################################################
312 # types of source files to syntax highlight
313 tohighlight: .c .h .cpp .pl .py Makefile:make
314 # location of highlight's filetypes.conf
315 filetypes_conf: /etc/highlight/filetypes.conf
316 # location of highlight's langDefs directory
317 langdefdir: /usr/share/highlight/langDefs
320 # enable multimarkdown features?
324 # master language (non-PO files)
325 #po_master_language: en|English
326 # slave languages (translated via PO files) format: ll|Langname
331 # PageSpec controlling which pages are translatable
332 po_translatable_pages: ''
333 # internal linking behavior (default/current/negotiated)
336 ######################################################################
339 ######################################################################
341 ######################################################################
343 # (404, attachment, comments, editdiff, edittemplate, getsource, google,
344 # goto, mirrorlist, remove, rename, repolist, search, theme, userlist,
346 ######################################################################
349 # enhanced PageSpec specifying what attachments are allowed
350 allowed_attachments: admin() and virusfree()
351 # virus checker program (reads STDIN, returns nonzero if virus found)
352 virus_checker: clamdscan -
355 # PageSpec of pages where comments are allowed
356 comments_pagespec: forum/* and !*/Discussion
357 # PageSpec of pages where posting new comments is not allowed
358 comments_closed_pagespec: ''
359 # Base name for comments, e.g. "comment_" for pages like "sandbox/comment_12"
360 comments_pagename: comment_
361 # Interpret directives in comments?
362 #comments_allowdirectives: 0
363 # Allow anonymous commenters to set an author name?
364 comments_allowauthor: 0
365 # commit comments to the VCS
369 # Mime type for returned source.
370 #getsource_mimetype: text/plain; charset=utf-8
377 # URIs of repositories containing the wiki's source
379 - ssh://b-ikiwiki@ikiwiki.branchable.com/
380 - git://ikiwiki.branchable.com/
383 # path to the omega cgi program
384 omega_cgi: /usr/lib/cgi-bin/omega/omega
387 # name of theme to enable
391 # list of plugins that cannot be enabled/disabled via the web interface
392 websetup_force_plugins:
397 # list of additional setup field keys to treat as unsafe
408 # show unsafe settings, read-only, in web interface?
409 websetup_show_unsafe: 0
411 ######################################################################
413 # (calendar, color, conditional, cutpaste, date, format, fortune,
414 # graphviz, haiku, headinganchors, img, linkmap, listdirectives, map,
415 # more, orphans, pagecount, pagestats, poll, polygen, postsparkline,
416 # progress, shortcut, sparkline, table, template, teximg, toc, toggle,
418 ######################################################################
421 # base of the archives hierarchy
422 #archivebase: archives
423 # PageSpec of pages to include in the archives; used by ikiwiki-calendar command
424 #archive_pagespec: page(posts/*) and !*/Discussion
426 # listdirectives plugin
427 # directory in srcdir that contains directive descriptions
428 directive_description_dir: ikiwiki/directive
431 # Should teximg use dvipng to render, or dvips and convert?
433 # LaTeX prefix for teximg plugin
435 # \documentclass{article}
436 # \usepackage[utf8]{inputenc}
437 # \usepackage{amsmath}
438 # \usepackage{amsfonts}
439 # \usepackage{amssymb}
442 # LaTeX postfix for teximg plugin
443 #teximg_postfix: '\end{document}'
445 ######################################################################
447 # (aggregate, autoindex, brokenlinks, camelcase, ddate, embed, favicon,
448 # flattr, goodstuff, htmlbalance, localstyle, missingsite, pagetemplate,
449 # parked, pingee, pinger, prettydate, recentchanges, recentchangesdiff,
450 # relativedate, rsync, sidebar, smiley, sortnaturally, tag,
451 # testpagespec, transient, typography, underlay)
452 ######################################################################
455 # enable aggregation to internal pages?
457 # allow aggregation to be triggered via the web?
458 #aggregate_webtrigger: 0
461 file: /home/b-ikiwiki/.ikiwiki/cookies
464 # commit autocreated index pages
468 # list of words to not turn into links
469 #camelcase_ignore: []
472 # userid or user name to use by default for Flattr buttons
473 #flattr_userid: joeyh
476 # An optional message explaining why this site is parked.
480 # how many seconds to try pinging before timing out
484 # format to use to display date
485 prettydateformat: '%X, %B %o, %Y'
487 # recentchanges plugin
488 # name of the recentchanges page
489 recentchangespage: recentchanges
490 # number of changes to track
491 recentchangesnum: 100
494 # command to run to sync updated pages
495 #rsync_command: rsync -qa --delete . user@host:/path/to/docroot/
498 # show sidebar page on all pages?
502 # parent page tags are located under
504 # autocreate new tag pages?
506 # commit autocreated tag pages
507 tag_autocreate_commit: 1
510 # Text::Typography attributes value
511 #typographyattributes: 3
514 # extra underlay directories to add
516 # - /home/b-ikiwiki/wiki.underlay