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