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
46 - http://cmelbye.myopenid.com/
61 # where the source of the wiki is located
62 srcdir: /home/b-ikiwiki/source/doc
63 # where to build the wiki
64 destdir: /home/b-ikiwiki/public_html
65 # base url to the wiki
66 url: http://ikiwiki.info
67 # url to the ikiwiki.cgi
68 cgiurl: http://ikiwiki.info/ikiwiki.cgi
69 # filename of cgi wrapper to generate
70 cgi_wrapper: /var/www/b-ikiwiki/ikiwiki.cgi
71 # mode for cgi_wrapper (can safely be made suid)
75 # plugins to add to the default configuration
120 # additional directory to search for template files
121 templatedir: /usr/share/ikiwiki/templates
122 # base wiki source location
123 underlaydir: /usr/share/ikiwiki/basewiki
124 # display verbose messages?
128 # create output files named page/index.html?
130 # use '!'-prefixed preprocessor directives?
132 # use page/index.mdwn source files
134 # enable Discussion pages?
136 # name of Discussion pages
137 discussionpage: Discussion
140 # only send cookies over SSL connections?
142 # extension to use for new pages
143 default_pageext: mdwn
144 # extension to use for html files
146 # strftime format string to display date
148 # UTF-8 locale to use
150 # put user pages below specified page
152 # how many backlinks to show before hiding excess (0 to show all)
154 # attempt to hardlink source files? (optimisation for large files)
156 # force ikiwiki to use a particular umask
158 # group for wrappers to run in
159 #wrappergroup: ikiwiki
160 # extra library and plugin directory
161 libdir: /home/b-ikiwiki/.ikiwiki
162 # environment variables
164 TMPDIR: /home/b-ikiwiki/tmp
167 # regexp of normally excluded files to include
168 #include: '^\.htaccess$'
169 # regexp of files that should be skipped
170 #exclude: '^(*\.private|Makefile)$'
171 # specifies the characters that are allowed in source filenames
172 wiki_file_chars: '-[:alnum:]+/.:_'
173 # allow symlinks in the path leading to the srcdir (potentially insecure)
174 allow_symlinks_before_srcdir: 0
176 ######################################################################
178 # (branchable, editpage, git, gitpush, htmlscrubber, ikiwikihosting,
179 # inline, link, meta, parentlinks)
180 ######################################################################
183 # Allow anyone to branch, check out, and copy this site?
185 # Allow anyone to git push verified changes to this site?
187 # Display "Branchable" link on action bar?
191 # git hook to generate
192 git_wrapper: /home/b-ikiwiki/source.git/hooks/post-update
193 # shell command for git_wrapper to run, in the background
194 #git_wrapper_background_command: git push github
195 # mode for git_wrapper (can safely be made suid)
196 git_wrappermode: 6755
197 # git pre-receive hook to generate
198 git_test_receive_wrapper: /home/b-ikiwiki/source.git/hooks/pre-receive
199 # unix users whose commits should be checked by the pre-receive hook
200 untrusted_committers:
202 # gitweb url to show file history ([[file]] substituted)
203 historyurl: 'http://source.ikiwiki.branchable.com/?p=source.git;a=history;f=doc/[[file]];hb=HEAD'
204 # gitweb url to show a diff ([[file]], [[sha1_to]], [[sha1_from]], [[sha1_commit]], and [[sha1_parent]] substituted)
205 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]]'
206 # where to pull and push changes (set to empty string to disable)
207 gitorigin_branch: origin
208 # branch that the wiki is stored in
209 gitmaster_branch: master
212 # git repository urls that changes are pushed to
214 - git@github.com:joeyh/ikiwiki.git
215 - joey@git.kitenet.net:/srv/git/ikiwiki.git
217 # htmlscrubber plugin
218 # PageSpec specifying pages not to scrub
219 htmlscrubber_skip: tipjar
221 # ikiwikihosting plugin
222 # list of urls that alias to the main url
224 - http://ikiwiki.branchable.com/
225 - http://ikiwiki.branchable.com/
226 - http://git.ikiwiki.info/
227 - http://www.ikiwiki.info/
228 # openid of primary site owner
229 owner: http://joey.kitenet.net/
230 # optional hostname of site this one was branched from
232 # internal hostname of this site
233 hostname: ikiwiki.branchable.com
234 # site creation datestamp
236 # how many days to retain logs
242 # enable rss feeds by default?
244 # enable atom feeds by default?
246 # allow rss feeds to be used?
248 # allow atom feeds to be used?
250 # urls to ping (using XML-RPC) on feed update
253 ######################################################################
255 # (anonok, blogspam, httpauth, lockedit, moderatedcomments,
256 # opendiscussion, openid, passwordauth, signinedit)
257 ######################################################################
260 # PageSpec to limit which pages anonymous users can edit
261 #anonok_pagespec: '*/discussion'
264 # PageSpec of pages to check for spam
265 #blogspam_pagespec: postcomment(*)
266 # options to send to blogspam server
267 #blogspam_options: 'blacklist=1.2.3.4,blacklist=8.7.6.5,max-links=10'
268 # blogspam server XML-RPC url
272 # url to redirect to when authentication is needed
273 #cgiauthurl: http://example.com/wiki/auth/ikiwiki.cgi
274 # PageSpec of pages where only httpauth will be used for authentication
275 #httpauth_pagespec: '!*/Discussion'
278 # PageSpec controlling which pages are locked
281 # moderatedcomments plugin
282 # PageSpec matching users or comment locations to moderate
283 #moderate_pagespec: '*'
286 # url pattern of openid realm (default is cgiurl)
287 openid_realm: http://*.branchable.com/
288 # url to ikiwiki cgi to use for openid authentication (default is cgiurl)
289 openid_cgiurl: http://ikiwiki.branchable.com/ikiwiki.cgi
291 # passwordauth plugin
292 # a password that must be entered when signing up for an account
293 #account_creation_password: s3cr1t
294 # cost of generating a password using Authen::Passphrase::BlowfishCrypt
297 ######################################################################
299 # (creole, highlight, hnb, html, mdwn, otl, po, rawhtml, rst, textile,
301 ######################################################################
304 # types of source files to syntax highlight
305 tohighlight: .c .h .cpp .pl .py Makefile:make
306 # location of highlight's filetypes.conf
307 filetypes_conf: /etc/highlight/filetypes.conf
308 # location of highlight's langDefs directory
309 langdefdir: /usr/share/highlight/langDefs
312 # enable multimarkdown features?
316 # master language (non-PO files)
317 #po_master_language: en|English
318 # slave languages (translated via PO files) format: ll|Langname
323 # PageSpec controlling which pages are translatable
324 po_translatable_pages: ''
325 # internal linking behavior (default/current/negotiated)
328 ######################################################################
331 ######################################################################
333 ######################################################################
335 # (404, attachment, comments, editdiff, edittemplate, getsource, google,
336 # goto, mirrorlist, remove, rename, repolist, search, theme, userlist,
338 ######################################################################
341 # enhanced PageSpec specifying what attachments are allowed
342 allowed_attachments: admin() and virusfree()
343 # virus checker program (reads STDIN, returns nonzero if virus found)
344 virus_checker: clamdscan -
347 # PageSpec of pages where comments are allowed
348 comments_pagespec: forum/* and !*/Discussion
349 # PageSpec of pages where posting new comments is not allowed
350 comments_closed_pagespec: ''
351 # Base name for comments, e.g. "comment_" for pages like "sandbox/comment_12"
352 comments_pagename: comment_
353 # Interpret directives in comments?
354 #comments_allowdirectives: 0
355 # Allow anonymous commenters to set an author name?
356 comments_allowauthor: 0
357 # commit comments to the VCS
361 # Mime type for returned source.
362 #getsource_mimetype: text/plain; charset=utf-8
369 # URIs of repositories containing the wiki's source
371 - ssh://b-ikiwiki@ikiwiki.branchable.com/
372 - git://ikiwiki.branchable.com/
375 # path to the omega cgi program
376 omega_cgi: /usr/lib/cgi-bin/omega/omega
379 # name of theme to enable
383 # list of plugins that cannot be enabled/disabled via the web interface
384 websetup_force_plugins:
389 # list of additional setup field keys to treat as unsafe
400 # show unsafe settings, read-only, in web interface?
401 websetup_show_unsafe: 0
403 ######################################################################
405 # (calendar, color, conditional, cutpaste, date, format, fortune,
406 # graphviz, haiku, headinganchors, img, linkmap, listdirectives, map,
407 # more, orphans, pagecount, pagestats, poll, polygen, postsparkline,
408 # progress, shortcut, sparkline, table, template, teximg, toc, toggle,
410 ######################################################################
413 # base of the archives hierarchy
414 #archivebase: archives
415 # PageSpec of pages to include in the archives; used by ikiwiki-calendar command
416 #archive_pagespec: page(posts/*) and !*/Discussion
418 # listdirectives plugin
419 # directory in srcdir that contains directive descriptions
420 directive_description_dir: ikiwiki/directive
423 # Should teximg use dvipng to render, or dvips and convert?
425 # LaTeX prefix for teximg plugin
427 # \documentclass{article}
428 # \usepackage[utf8]{inputenc}
429 # \usepackage{amsmath}
430 # \usepackage{amsfonts}
431 # \usepackage{amssymb}
434 # LaTeX postfix for teximg plugin
435 #teximg_postfix: '\end{document}'
437 ######################################################################
439 # (aggregate, autoindex, brokenlinks, camelcase, ddate, embed, favicon,
440 # flattr, goodstuff, htmlbalance, localstyle, missingsite, pagetemplate,
441 # parked, pingee, pinger, prettydate, recentchanges, recentchangesdiff,
442 # relativedate, rsync, sidebar, smiley, sortnaturally, tag,
443 # testpagespec, transient, typography, underlay)
444 ######################################################################
447 # enable aggregation to internal pages?
449 # allow aggregation to be triggered via the web?
450 #aggregate_webtrigger: 0
453 file: /home/b-ikiwiki/.ikiwiki/cookies
456 # commit autocreated index pages
460 # list of words to not turn into links
461 #camelcase_ignore: []
464 # userid or user name to use by default for Flattr buttons
465 #flattr_userid: joeyh
468 # An optional message explaining why this site is parked.
472 # how many seconds to try pinging before timing out
476 # format to use to display date
477 prettydateformat: '%X, %B %o, %Y'
479 # recentchanges plugin
480 # name of the recentchanges page
481 recentchangespage: recentchanges
482 # number of changes to track
483 recentchangesnum: 100
486 # command to run to sync updated pages
487 #rsync_command: rsync -qa --delete . user@host:/path/to/docroot/
490 # show sidebar page on all pages?
494 # parent page tags are located under
496 # autocreate new tag pages?
498 # commit autocreated tag pages
499 tag_autocreate_commit: 1
502 # Text::Typography attributes value
503 #typographyattributes: 3
506 # extra underlay directories to add
508 # - /home/b-ikiwiki/wiki.underlay