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/
17 # users who are banned from the wiki
19 - https://www.google.com/accounts/o8/id?id=AItOawkaL6e6GtpyD7gJyqHphon_5ES1ACDLJgg
20 - https://www.google.com/accounts/o8/id?id=AItOawnv-w7GplWln2P55lnzc6Ds-ltzk6sNxDY
21 - https://me.yahoo.com/a/3hUnH9Qi24uk3RwCwHATJBWKVyqc#7d8b8
23 - https://me.yahoo.com/a/2.Pjpm0G0Z6F9LiGW4cYO84pIrb.Lg--#137de
24 - https://www.google.com/accounts/o8/id?id=AItOawkuR0eo_HO1s1hs49h0Y_4Bzm08l9evMEc
25 - https://www.google.com/accounts/o8/id?id=AItOawlYXeKSEBoSCzES7o5VYiSratG5RfNucL0
26 - https://www.google.com/accounts/o8/id?id=AItOawl_wuvPHDhkuMVnEOP5jLrZyd3nnBs8YRw
47 - http://cmelbye.myopenid.com/
60 - https://www.google.com/accounts/o8/id?id=AItOawkJHb27RVmw93kqyzfoxZWNKjqR8MEVt3A
62 - https://www.google.com/accounts/o8/id?id=AItOawkljravtnjpauReS81ng5zVurZx_thpse8
64 # where the source of the wiki is located
65 srcdir: /home/b-ikiwiki/source/doc
66 # where to build the wiki
67 destdir: /home/b-ikiwiki/public_html
68 # base url to the wiki
69 url: http://ikiwiki.info
70 # url to the ikiwiki.cgi
71 cgiurl: http://ikiwiki.info/ikiwiki.cgi
72 # filename of cgi wrapper to generate
73 cgi_wrapper: /var/www/b-ikiwiki/ikiwiki.cgi
74 # mode for cgi_wrapper (can safely be made suid)
78 # plugins to add to the default configuration
123 # additional directory to search for template files
124 templatedir: /usr/share/ikiwiki/templates
125 # base wiki source location
126 underlaydir: /usr/share/ikiwiki/basewiki
127 # display verbose messages?
131 # create output files named page/index.html?
133 # use '!'-prefixed preprocessor directives?
135 # use page/index.mdwn source files
137 # enable Discussion pages?
139 # name of Discussion pages
140 discussionpage: Discussion
143 # only send cookies over SSL connections?
145 # extension to use for new pages
146 default_pageext: mdwn
147 # extension to use for html files
149 # strftime format string to display date
151 # UTF-8 locale to use
153 # put user pages below specified page
155 # how many backlinks to show before hiding excess (0 to show all)
157 # attempt to hardlink source files? (optimisation for large files)
159 # force ikiwiki to use a particular umask
161 # group for wrappers to run in
162 #wrappergroup: ikiwiki
163 # extra library and plugin directory
164 libdir: /home/b-ikiwiki/.ikiwiki
165 # environment variables
167 TMPDIR: /home/b-ikiwiki/tmp
170 # regexp of normally excluded files to include
171 #include: '^\.htaccess$'
172 # regexp of files that should be skipped
173 #exclude: '^(*\.private|Makefile)$'
174 # specifies the characters that are allowed in source filenames
175 wiki_file_chars: '-[:alnum:]+/.:_'
176 # allow symlinks in the path leading to the srcdir (potentially insecure)
177 allow_symlinks_before_srcdir: 0
179 ######################################################################
181 # (branchable, editpage, git, gitpush, htmlscrubber, ikiwikihosting,
182 # inline, link, meta, parentlinks)
183 ######################################################################
186 # Allow anyone to branch, check out, and copy this site?
188 # Allow anyone to git push verified changes to this site?
190 # Display "Branchable" link on action bar?
194 # git hook to generate
195 git_wrapper: /home/b-ikiwiki/source.git/hooks/post-update
196 # shell command for git_wrapper to run, in the background
197 #git_wrapper_background_command: git push github
198 # mode for git_wrapper (can safely be made suid)
199 git_wrappermode: 6755
200 # git pre-receive hook to generate
201 git_test_receive_wrapper: /home/b-ikiwiki/source.git/hooks/pre-receive
202 # unix users whose commits should be checked by the pre-receive hook
203 untrusted_committers:
205 # gitweb url to show file history ([[file]] substituted)
206 historyurl: 'http://source.ikiwiki.branchable.com/?p=source.git;a=history;f=doc/[[file]];hb=HEAD'
207 # gitweb url to show a diff ([[file]], [[sha1_to]], [[sha1_from]], [[sha1_commit]], and [[sha1_parent]] substituted)
208 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]]'
209 # where to pull and push changes (set to empty string to disable)
210 gitorigin_branch: origin
211 # branch that the wiki is stored in
212 gitmaster_branch: master
215 # git repository urls that changes are pushed to
217 - git@github.com:joeyh/ikiwiki.git
218 - joey@git.kitenet.net:/srv/git/ikiwiki.git
220 # htmlscrubber plugin
221 # PageSpec specifying pages not to scrub
222 htmlscrubber_skip: tipjar
224 # ikiwikihosting plugin
225 # list of urls that alias to the main url
227 - http://ikiwiki.branchable.com/
228 - http://ikiwiki.branchable.com/
229 - http://git.ikiwiki.info/
230 - http://www.ikiwiki.info/
231 # openid of primary site owner
232 owner: http://joey.kitenet.net/
233 # optional hostname of site this one was branched from
235 # internal hostname of this site
236 hostname: ikiwiki.branchable.com
237 # site creation datestamp
239 # how many days to retain logs
245 # enable rss feeds by default?
247 # enable atom feeds by default?
249 # allow rss feeds to be used?
251 # allow atom feeds to be used?
253 # urls to ping (using XML-RPC) on feed update
256 ######################################################################
258 # (anonok, blogspam, httpauth, lockedit, moderatedcomments,
259 # opendiscussion, openid, passwordauth, signinedit)
260 ######################################################################
263 # PageSpec to limit which pages anonymous users can edit
264 #anonok_pagespec: '*/discussion'
267 # PageSpec of pages to check for spam
268 #blogspam_pagespec: postcomment(*)
269 # options to send to blogspam server
270 #blogspam_options: 'blacklist=1.2.3.4,blacklist=8.7.6.5,max-links=10'
271 # blogspam server XML-RPC url
275 # url to redirect to when authentication is needed
276 #cgiauthurl: http://example.com/wiki/auth/ikiwiki.cgi
277 # PageSpec of pages where only httpauth will be used for authentication
278 #httpauth_pagespec: '!*/Discussion'
281 # PageSpec controlling which pages are locked
284 # moderatedcomments plugin
285 # PageSpec matching users or comment locations to moderate
286 #moderate_pagespec: '*'
289 # url pattern of openid realm (default is cgiurl)
290 openid_realm: http://*.branchable.com/
291 # url to ikiwiki cgi to use for openid authentication (default is cgiurl)
292 openid_cgiurl: http://ikiwiki.branchable.com/ikiwiki.cgi
294 # passwordauth plugin
295 # a password that must be entered when signing up for an account
296 #account_creation_password: s3cr1t
297 # cost of generating a password using Authen::Passphrase::BlowfishCrypt
300 ######################################################################
302 # (creole, highlight, hnb, html, mdwn, otl, po, rawhtml, rst, textile,
304 ######################################################################
307 # types of source files to syntax highlight
308 tohighlight: .c .h .cpp .pl .py Makefile:make
309 # location of highlight's filetypes.conf
310 filetypes_conf: /etc/highlight/filetypes.conf
311 # location of highlight's langDefs directory
312 langdefdir: /usr/share/highlight/langDefs
315 # enable multimarkdown features?
319 # master language (non-PO files)
320 #po_master_language: en|English
321 # slave languages (translated via PO files) format: ll|Langname
326 # PageSpec controlling which pages are translatable
327 po_translatable_pages: ''
328 # internal linking behavior (default/current/negotiated)
331 ######################################################################
334 ######################################################################
336 ######################################################################
338 # (404, attachment, comments, editdiff, edittemplate, getsource, google,
339 # goto, mirrorlist, remove, rename, repolist, search, theme, userlist,
341 ######################################################################
344 # enhanced PageSpec specifying what attachments are allowed
345 allowed_attachments: admin() and virusfree()
346 # virus checker program (reads STDIN, returns nonzero if virus found)
347 virus_checker: clamdscan -
350 # PageSpec of pages where comments are allowed
351 comments_pagespec: forum/* and !*/Discussion
352 # PageSpec of pages where posting new comments is not allowed
353 comments_closed_pagespec: ''
354 # Base name for comments, e.g. "comment_" for pages like "sandbox/comment_12"
355 comments_pagename: comment_
356 # Interpret directives in comments?
357 #comments_allowdirectives: 0
358 # Allow anonymous commenters to set an author name?
359 comments_allowauthor: 0
360 # commit comments to the VCS
364 # Mime type for returned source.
365 #getsource_mimetype: text/plain; charset=utf-8
372 # URIs of repositories containing the wiki's source
374 - ssh://b-ikiwiki@ikiwiki.branchable.com/
375 - git://ikiwiki.branchable.com/
378 # path to the omega cgi program
379 omega_cgi: /usr/lib/cgi-bin/omega/omega
382 # name of theme to enable
386 # list of plugins that cannot be enabled/disabled via the web interface
387 websetup_force_plugins:
392 # list of additional setup field keys to treat as unsafe
403 # show unsafe settings, read-only, in web interface?
404 websetup_show_unsafe: 0
406 ######################################################################
408 # (calendar, color, conditional, cutpaste, date, format, fortune,
409 # graphviz, haiku, headinganchors, img, linkmap, listdirectives, map,
410 # more, orphans, pagecount, pagestats, poll, polygen, postsparkline,
411 # progress, shortcut, sparkline, table, template, teximg, toc, toggle,
413 ######################################################################
416 # base of the archives hierarchy
417 #archivebase: archives
418 # PageSpec of pages to include in the archives; used by ikiwiki-calendar command
419 #archive_pagespec: page(posts/*) and !*/Discussion
421 # listdirectives plugin
422 # directory in srcdir that contains directive descriptions
423 directive_description_dir: ikiwiki/directive
426 # Should teximg use dvipng to render, or dvips and convert?
428 # LaTeX prefix for teximg plugin
430 # \documentclass{article}
431 # \usepackage[utf8]{inputenc}
432 # \usepackage{amsmath}
433 # \usepackage{amsfonts}
434 # \usepackage{amssymb}
437 # LaTeX postfix for teximg plugin
438 #teximg_postfix: '\end{document}'
440 ######################################################################
442 # (aggregate, autoindex, brokenlinks, camelcase, ddate, embed, favicon,
443 # flattr, goodstuff, htmlbalance, localstyle, missingsite, pagetemplate,
444 # parked, pingee, pinger, prettydate, recentchanges, recentchangesdiff,
445 # relativedate, rsync, sidebar, smiley, sortnaturally, tag,
446 # testpagespec, transient, typography, underlay)
447 ######################################################################
450 # enable aggregation to internal pages?
452 # allow aggregation to be triggered via the web?
453 #aggregate_webtrigger: 0
456 file: /home/b-ikiwiki/.ikiwiki/cookies
459 # commit autocreated index pages
463 # list of words to not turn into links
464 #camelcase_ignore: []
467 # userid or user name to use by default for Flattr buttons
468 #flattr_userid: joeyh
471 # An optional message explaining why this site is parked.
475 # how many seconds to try pinging before timing out
479 # format to use to display date
480 prettydateformat: '%X, %B %o, %Y'
482 # recentchanges plugin
483 # name of the recentchanges page
484 recentchangespage: recentchanges
485 # number of changes to track
486 recentchangesnum: 100
489 # command to run to sync updated pages
490 #rsync_command: rsync -qa --delete . user@host:/path/to/docroot/
493 # show sidebar page on all pages?
497 # parent page tags are located under
499 # autocreate new tag pages?
501 # commit autocreated tag pages
502 tag_autocreate_commit: 1
505 # Text::Typography attributes value
506 #typographyattributes: 3
509 # extra underlay directories to add
511 # - /home/b-ikiwiki/wiki.underlay