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=AItOawm_nWF_tPw8mLI7rMxfykA_d3FehQNvWpI
21 - https://www.google.com/accounts/o8/id?id=AItOawkTn3HixU2KJIvvLXLqwYUzlDGDtYf43GE
22 - https://www.google.com/accounts/o8/id?id=AItOawkDOCT-KTCLpieip-2W0N51gZwF7nGLaS0
23 - https://www.google.com/accounts/o8/id?id=AItOawl8-V-Yp0F5ZWRmDb7j4ul1gsbMXjghDIU
24 - https://www.google.com/accounts/o8/id?id=AItOawkaL6e6GtpyD7gJyqHphon_5ES1ACDLJgg
25 - https://www.google.com/accounts/o8/id?id=AItOawnv-w7GplWln2P55lnzc6Ds-ltzk6sNxDY
26 - https://me.yahoo.com/a/3hUnH9Qi24uk3RwCwHATJBWKVyqc#7d8b8
28 - https://me.yahoo.com/a/2.Pjpm0G0Z6F9LiGW4cYO84pIrb.Lg--#137de
29 - https://www.google.com/accounts/o8/id?id=AItOawkuR0eo_HO1s1hs49h0Y_4Bzm08l9evMEc
30 - https://www.google.com/accounts/o8/id?id=AItOawlYXeKSEBoSCzES7o5VYiSratG5RfNucL0
31 - https://www.google.com/accounts/o8/id?id=AItOawl_wuvPHDhkuMVnEOP5jLrZyd3nnBs8YRw
52 - http://cmelbye.myopenid.com/
65 - https://www.google.com/accounts/o8/id?id=AItOawkJHb27RVmw93kqyzfoxZWNKjqR8MEVt3A
67 - https://www.google.com/accounts/o8/id?id=AItOawkljravtnjpauReS81ng5zVurZx_thpse8
70 # where the source of the wiki is located
71 srcdir: /home/b-ikiwiki/source/doc
72 # where to build the wiki
73 destdir: /home/b-ikiwiki/public_html
74 # base url to the wiki
75 url: http://ikiwiki.info
76 # url to the ikiwiki.cgi
77 cgiurl: http://ikiwiki.info/ikiwiki.cgi
78 # filename of cgi wrapper to generate
79 cgi_wrapper: /var/www/b-ikiwiki/ikiwiki.cgi
80 # mode for cgi_wrapper (can safely be made suid)
84 # plugins to add to the default configuration
129 # additional directory to search for template files
130 templatedir: /usr/share/ikiwiki/templates
131 # base wiki source location
132 underlaydir: /usr/share/ikiwiki/basewiki
133 # display verbose messages?
137 # create output files named page/index.html?
139 # use '!'-prefixed preprocessor directives?
141 # use page/index.mdwn source files
143 # enable Discussion pages?
145 # name of Discussion pages
146 discussionpage: Discussion
149 # only send cookies over SSL connections?
151 # extension to use for new pages
152 default_pageext: mdwn
153 # extension to use for html files
155 # strftime format string to display date
157 # UTF-8 locale to use
159 # put user pages below specified page
161 # how many backlinks to show before hiding excess (0 to show all)
163 # attempt to hardlink source files? (optimisation for large files)
165 # force ikiwiki to use a particular umask
167 # group for wrappers to run in
168 #wrappergroup: ikiwiki
169 # extra library and plugin directory
170 libdir: /home/b-ikiwiki/.ikiwiki
171 # environment variables
173 TMPDIR: /home/b-ikiwiki/tmp
176 # regexp of normally excluded files to include
177 #include: '^\.htaccess$'
178 # regexp of files that should be skipped
179 #exclude: '^(*\.private|Makefile)$'
180 # specifies the characters that are allowed in source filenames
181 wiki_file_chars: '-[:alnum:]+/.:_'
182 # allow symlinks in the path leading to the srcdir (potentially insecure)
183 allow_symlinks_before_srcdir: 0
185 ######################################################################
187 # (branchable, editpage, git, gitpush, htmlscrubber, ikiwikihosting,
188 # inline, link, meta, parentlinks)
189 ######################################################################
192 # Allow anyone to branch, check out, and copy this site?
194 # Allow anyone to git push verified changes to this site?
196 # Display "Branchable" link on action bar?
200 # git hook to generate
201 git_wrapper: /home/b-ikiwiki/source.git/hooks/post-update
202 # shell command for git_wrapper to run, in the background
203 #git_wrapper_background_command: git push github
204 # mode for git_wrapper (can safely be made suid)
205 git_wrappermode: 6755
206 # git pre-receive hook to generate
207 git_test_receive_wrapper: /home/b-ikiwiki/source.git/hooks/pre-receive
208 # unix users whose commits should be checked by the pre-receive hook
209 untrusted_committers:
211 # gitweb url to show file history ([[file]] substituted)
212 historyurl: 'http://source.ikiwiki.branchable.com/?p=source.git;a=history;f=doc/[[file]];hb=HEAD'
213 # gitweb url to show a diff ([[file]], [[sha1_to]], [[sha1_from]], [[sha1_commit]], and [[sha1_parent]] substituted)
214 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]]'
215 # where to pull and push changes (set to empty string to disable)
216 gitorigin_branch: origin
217 # branch that the wiki is stored in
218 gitmaster_branch: master
221 # git repository urls that changes are pushed to
223 - git@github.com:joeyh/ikiwiki.git
224 - joey@git.kitenet.net:/srv/git/ikiwiki.git
226 # htmlscrubber plugin
227 # PageSpec specifying pages not to scrub
228 htmlscrubber_skip: tipjar
230 # ikiwikihosting plugin
231 # list of urls that alias to the main url
233 - http://ikiwiki.branchable.com/
234 - http://ikiwiki.branchable.com/
235 - http://git.ikiwiki.info/
236 - http://www.ikiwiki.info/
237 # openid of primary site owner
238 owner: http://joey.kitenet.net/
239 # optional hostname of site this one was branched from
241 # internal hostname of this site
242 hostname: ikiwiki.branchable.com
243 # site creation datestamp
245 # how many days to retain logs
251 # enable rss feeds by default?
253 # enable atom feeds by default?
255 # allow rss feeds to be used?
257 # allow atom feeds to be used?
259 # urls to ping (using XML-RPC) on feed update
262 ######################################################################
264 # (anonok, blogspam, httpauth, lockedit, moderatedcomments,
265 # opendiscussion, openid, passwordauth, signinedit)
266 ######################################################################
269 # PageSpec to limit which pages anonymous users can edit
270 #anonok_pagespec: '*/discussion'
273 # PageSpec of pages to check for spam
274 #blogspam_pagespec: postcomment(*)
275 # options to send to blogspam server
276 #blogspam_options: 'blacklist=1.2.3.4,blacklist=8.7.6.5,max-links=10'
277 # blogspam server XML-RPC url
281 # url to redirect to when authentication is needed
282 #cgiauthurl: http://example.com/wiki/auth/ikiwiki.cgi
283 # PageSpec of pages where only httpauth will be used for authentication
284 #httpauth_pagespec: '!*/Discussion'
287 # PageSpec controlling which pages are locked
290 # moderatedcomments plugin
291 # PageSpec matching users or comment locations to moderate
292 #moderate_pagespec: '*'
295 # url pattern of openid realm (default is cgiurl)
296 openid_realm: http://*.branchable.com/
297 # url to ikiwiki cgi to use for openid authentication (default is cgiurl)
298 openid_cgiurl: http://ikiwiki.branchable.com/ikiwiki.cgi
300 # passwordauth plugin
301 # a password that must be entered when signing up for an account
302 #account_creation_password: s3cr1t
303 # cost of generating a password using Authen::Passphrase::BlowfishCrypt
306 ######################################################################
308 # (creole, highlight, hnb, html, mdwn, otl, po, rawhtml, rst, textile,
310 ######################################################################
313 # types of source files to syntax highlight
314 tohighlight: .c .h .cpp .pl .py Makefile:make
315 # location of highlight's filetypes.conf
316 filetypes_conf: /etc/highlight/filetypes.conf
317 # location of highlight's langDefs directory
318 langdefdir: /usr/share/highlight/langDefs
321 # enable multimarkdown features?
325 # master language (non-PO files)
326 #po_master_language: en|English
327 # slave languages (translated via PO files) format: ll|Langname
332 # PageSpec controlling which pages are translatable
333 po_translatable_pages: ''
334 # internal linking behavior (default/current/negotiated)
337 ######################################################################
340 ######################################################################
342 ######################################################################
344 # (404, attachment, comments, editdiff, edittemplate, getsource, google,
345 # goto, mirrorlist, remove, rename, repolist, search, theme, userlist,
347 ######################################################################
350 # enhanced PageSpec specifying what attachments are allowed
351 allowed_attachments: admin() and virusfree()
352 # virus checker program (reads STDIN, returns nonzero if virus found)
353 virus_checker: clamdscan -
356 # PageSpec of pages where comments are allowed
357 comments_pagespec: forum/* and !*/Discussion
358 # PageSpec of pages where posting new comments is not allowed
359 comments_closed_pagespec: ''
360 # Base name for comments, e.g. "comment_" for pages like "sandbox/comment_12"
361 comments_pagename: comment_
362 # Interpret directives in comments?
363 #comments_allowdirectives: 0
364 # Allow anonymous commenters to set an author name?
365 comments_allowauthor: 0
366 # commit comments to the VCS
370 # Mime type for returned source.
371 #getsource_mimetype: text/plain; charset=utf-8
378 # URIs of repositories containing the wiki's source
380 - ssh://b-ikiwiki@ikiwiki.branchable.com/
381 - git://ikiwiki.branchable.com/
384 # path to the omega cgi program
385 omega_cgi: /usr/lib/cgi-bin/omega/omega
388 # name of theme to enable
392 # list of plugins that cannot be enabled/disabled via the web interface
393 websetup_force_plugins:
398 # list of additional setup field keys to treat as unsafe
409 # show unsafe settings, read-only, in web interface?
410 websetup_show_unsafe: 0
412 ######################################################################
414 # (calendar, color, conditional, cutpaste, date, format, fortune,
415 # graphviz, haiku, headinganchors, img, linkmap, listdirectives, map,
416 # more, orphans, pagecount, pagestats, poll, polygen, postsparkline,
417 # progress, shortcut, sparkline, table, template, teximg, toc, toggle,
419 ######################################################################
422 # base of the archives hierarchy
423 #archivebase: archives
424 # PageSpec of pages to include in the archives; used by ikiwiki-calendar command
425 #archive_pagespec: page(posts/*) and !*/Discussion
427 # listdirectives plugin
428 # directory in srcdir that contains directive descriptions
429 directive_description_dir: ikiwiki/directive
432 # Should teximg use dvipng to render, or dvips and convert?
434 # LaTeX prefix for teximg plugin
436 # \documentclass{article}
437 # \usepackage[utf8]{inputenc}
438 # \usepackage{amsmath}
439 # \usepackage{amsfonts}
440 # \usepackage{amssymb}
443 # LaTeX postfix for teximg plugin
444 #teximg_postfix: '\end{document}'
446 ######################################################################
448 # (aggregate, autoindex, brokenlinks, camelcase, ddate, embed, favicon,
449 # flattr, goodstuff, htmlbalance, localstyle, missingsite, pagetemplate,
450 # parked, pingee, pinger, prettydate, recentchanges, recentchangesdiff,
451 # relativedate, rsync, sidebar, smiley, sortnaturally, tag,
452 # testpagespec, transient, typography, underlay)
453 ######################################################################
456 # enable aggregation to internal pages?
458 # allow aggregation to be triggered via the web?
459 #aggregate_webtrigger: 0
462 file: /home/b-ikiwiki/.ikiwiki/cookies
465 # commit autocreated index pages
469 # list of words to not turn into links
470 #camelcase_ignore: []
473 # userid or user name to use by default for Flattr buttons
474 #flattr_userid: joeyh
477 # An optional message explaining why this site is parked.
481 # how many seconds to try pinging before timing out
485 # format to use to display date
486 prettydateformat: '%X, %B %o, %Y'
488 # recentchanges plugin
489 # name of the recentchanges page
490 recentchangespage: recentchanges
491 # number of changes to track
492 recentchangesnum: 100
495 # command to run to sync updated pages
496 #rsync_command: rsync -qa --delete . user@host:/path/to/docroot/
499 # show sidebar page on all pages?
503 # parent page tags are located under
505 # autocreate new tag pages?
507 # commit autocreated tag pages
508 tag_autocreate_commit: 1
511 # Text::Typography attributes value
512 #typographyattributes: 3
515 # extra underlay directories to add
517 # - /home/b-ikiwiki/wiki.underlay