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=AItOawkaL6e6GtpyD7gJyqHphon_5ES1ACDLJgg
21 - https://www.google.com/accounts/o8/id?id=AItOawnv-w7GplWln2P55lnzc6Ds-ltzk6sNxDY
22 - https://me.yahoo.com/a/3hUnH9Qi24uk3RwCwHATJBWKVyqc#7d8b8
24 - https://me.yahoo.com/a/2.Pjpm0G0Z6F9LiGW4cYO84pIrb.Lg--#137de
25 - https://www.google.com/accounts/o8/id?id=AItOawkuR0eo_HO1s1hs49h0Y_4Bzm08l9evMEc
26 - https://www.google.com/accounts/o8/id?id=AItOawlYXeKSEBoSCzES7o5VYiSratG5RfNucL0
27 - https://www.google.com/accounts/o8/id?id=AItOawl_wuvPHDhkuMVnEOP5jLrZyd3nnBs8YRw
48 - http://cmelbye.myopenid.com/
61 - https://www.google.com/accounts/o8/id?id=AItOawkJHb27RVmw93kqyzfoxZWNKjqR8MEVt3A
63 - https://www.google.com/accounts/o8/id?id=AItOawkljravtnjpauReS81ng5zVurZx_thpse8
66 # where the source of the wiki is located
67 srcdir: /home/b-ikiwiki/source/doc
68 # where to build the wiki
69 destdir: /home/b-ikiwiki/public_html
70 # base url to the wiki
71 url: http://ikiwiki.info
72 # url to the ikiwiki.cgi
73 cgiurl: http://ikiwiki.info/ikiwiki.cgi
74 # filename of cgi wrapper to generate
75 cgi_wrapper: /var/www/b-ikiwiki/ikiwiki.cgi
76 # mode for cgi_wrapper (can safely be made suid)
80 # plugins to add to the default configuration
125 # additional directory to search for template files
126 templatedir: /usr/share/ikiwiki/templates
127 # base wiki source location
128 underlaydir: /usr/share/ikiwiki/basewiki
129 # display verbose messages?
133 # create output files named page/index.html?
135 # use '!'-prefixed preprocessor directives?
137 # use page/index.mdwn source files
139 # enable Discussion pages?
141 # name of Discussion pages
142 discussionpage: Discussion
145 # only send cookies over SSL connections?
147 # extension to use for new pages
148 default_pageext: mdwn
149 # extension to use for html files
151 # strftime format string to display date
153 # UTF-8 locale to use
155 # put user pages below specified page
157 # how many backlinks to show before hiding excess (0 to show all)
159 # attempt to hardlink source files? (optimisation for large files)
161 # force ikiwiki to use a particular umask
163 # group for wrappers to run in
164 #wrappergroup: ikiwiki
165 # extra library and plugin directory
166 libdir: /home/b-ikiwiki/.ikiwiki
167 # environment variables
169 TMPDIR: /home/b-ikiwiki/tmp
172 # regexp of normally excluded files to include
173 #include: '^\.htaccess$'
174 # regexp of files that should be skipped
175 #exclude: '^(*\.private|Makefile)$'
176 # specifies the characters that are allowed in source filenames
177 wiki_file_chars: '-[:alnum:]+/.:_'
178 # allow symlinks in the path leading to the srcdir (potentially insecure)
179 allow_symlinks_before_srcdir: 0
181 ######################################################################
183 # (branchable, editpage, git, gitpush, htmlscrubber, ikiwikihosting,
184 # inline, link, meta, parentlinks)
185 ######################################################################
188 # Allow anyone to branch, check out, and copy this site?
190 # Allow anyone to git push verified changes to this site?
192 # Display "Branchable" link on action bar?
196 # git hook to generate
197 git_wrapper: /home/b-ikiwiki/source.git/hooks/post-update
198 # shell command for git_wrapper to run, in the background
199 #git_wrapper_background_command: git push github
200 # mode for git_wrapper (can safely be made suid)
201 git_wrappermode: 6755
202 # git pre-receive hook to generate
203 git_test_receive_wrapper: /home/b-ikiwiki/source.git/hooks/pre-receive
204 # unix users whose commits should be checked by the pre-receive hook
205 untrusted_committers:
207 # gitweb url to show file history ([[file]] substituted)
208 historyurl: 'http://source.ikiwiki.branchable.com/?p=source.git;a=history;f=doc/[[file]];hb=HEAD'
209 # gitweb url to show a diff ([[file]], [[sha1_to]], [[sha1_from]], [[sha1_commit]], and [[sha1_parent]] substituted)
210 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]]'
211 # where to pull and push changes (set to empty string to disable)
212 gitorigin_branch: origin
213 # branch that the wiki is stored in
214 gitmaster_branch: master
217 # git repository urls that changes are pushed to
219 - git@github.com:joeyh/ikiwiki.git
220 - joey@git.kitenet.net:/srv/git/ikiwiki.git
222 # htmlscrubber plugin
223 # PageSpec specifying pages not to scrub
224 htmlscrubber_skip: tipjar
226 # ikiwikihosting plugin
227 # list of urls that alias to the main url
229 - http://ikiwiki.branchable.com/
230 - http://ikiwiki.branchable.com/
231 - http://git.ikiwiki.info/
232 - http://www.ikiwiki.info/
233 # openid of primary site owner
234 owner: http://joey.kitenet.net/
235 # optional hostname of site this one was branched from
237 # internal hostname of this site
238 hostname: ikiwiki.branchable.com
239 # site creation datestamp
241 # how many days to retain logs
247 # enable rss feeds by default?
249 # enable atom feeds by default?
251 # allow rss feeds to be used?
253 # allow atom feeds to be used?
255 # urls to ping (using XML-RPC) on feed update
258 ######################################################################
260 # (anonok, blogspam, httpauth, lockedit, moderatedcomments,
261 # opendiscussion, openid, passwordauth, signinedit)
262 ######################################################################
265 # PageSpec to limit which pages anonymous users can edit
266 #anonok_pagespec: '*/discussion'
269 # PageSpec of pages to check for spam
270 #blogspam_pagespec: postcomment(*)
271 # options to send to blogspam server
272 #blogspam_options: 'blacklist=1.2.3.4,blacklist=8.7.6.5,max-links=10'
273 # blogspam server XML-RPC url
277 # url to redirect to when authentication is needed
278 #cgiauthurl: http://example.com/wiki/auth/ikiwiki.cgi
279 # PageSpec of pages where only httpauth will be used for authentication
280 #httpauth_pagespec: '!*/Discussion'
283 # PageSpec controlling which pages are locked
286 # moderatedcomments plugin
287 # PageSpec matching users or comment locations to moderate
288 #moderate_pagespec: '*'
291 # url pattern of openid realm (default is cgiurl)
292 openid_realm: http://*.branchable.com/
293 # url to ikiwiki cgi to use for openid authentication (default is cgiurl)
294 openid_cgiurl: http://ikiwiki.branchable.com/ikiwiki.cgi
296 # passwordauth plugin
297 # a password that must be entered when signing up for an account
298 #account_creation_password: s3cr1t
299 # cost of generating a password using Authen::Passphrase::BlowfishCrypt
302 ######################################################################
304 # (creole, highlight, hnb, html, mdwn, otl, po, rawhtml, rst, textile,
306 ######################################################################
309 # types of source files to syntax highlight
310 tohighlight: .c .h .cpp .pl .py Makefile:make
311 # location of highlight's filetypes.conf
312 filetypes_conf: /etc/highlight/filetypes.conf
313 # location of highlight's langDefs directory
314 langdefdir: /usr/share/highlight/langDefs
317 # enable multimarkdown features?
321 # master language (non-PO files)
322 #po_master_language: en|English
323 # slave languages (translated via PO files) format: ll|Langname
328 # PageSpec controlling which pages are translatable
329 po_translatable_pages: ''
330 # internal linking behavior (default/current/negotiated)
333 ######################################################################
336 ######################################################################
338 ######################################################################
340 # (404, attachment, comments, editdiff, edittemplate, getsource, google,
341 # goto, mirrorlist, remove, rename, repolist, search, theme, userlist,
343 ######################################################################
346 # enhanced PageSpec specifying what attachments are allowed
347 allowed_attachments: admin() and virusfree()
348 # virus checker program (reads STDIN, returns nonzero if virus found)
349 virus_checker: clamdscan -
352 # PageSpec of pages where comments are allowed
353 comments_pagespec: forum/* and !*/Discussion
354 # PageSpec of pages where posting new comments is not allowed
355 comments_closed_pagespec: ''
356 # Base name for comments, e.g. "comment_" for pages like "sandbox/comment_12"
357 comments_pagename: comment_
358 # Interpret directives in comments?
359 #comments_allowdirectives: 0
360 # Allow anonymous commenters to set an author name?
361 comments_allowauthor: 0
362 # commit comments to the VCS
366 # Mime type for returned source.
367 #getsource_mimetype: text/plain; charset=utf-8
374 # URIs of repositories containing the wiki's source
376 - ssh://b-ikiwiki@ikiwiki.branchable.com/
377 - git://ikiwiki.branchable.com/
380 # path to the omega cgi program
381 omega_cgi: /usr/lib/cgi-bin/omega/omega
384 # name of theme to enable
388 # list of plugins that cannot be enabled/disabled via the web interface
389 websetup_force_plugins:
394 # list of additional setup field keys to treat as unsafe
405 # show unsafe settings, read-only, in web interface?
406 websetup_show_unsafe: 0
408 ######################################################################
410 # (calendar, color, conditional, cutpaste, date, format, fortune,
411 # graphviz, haiku, headinganchors, img, linkmap, listdirectives, map,
412 # more, orphans, pagecount, pagestats, poll, polygen, postsparkline,
413 # progress, shortcut, sparkline, table, template, teximg, toc, toggle,
415 ######################################################################
418 # base of the archives hierarchy
419 #archivebase: archives
420 # PageSpec of pages to include in the archives; used by ikiwiki-calendar command
421 #archive_pagespec: page(posts/*) and !*/Discussion
423 # listdirectives plugin
424 # directory in srcdir that contains directive descriptions
425 directive_description_dir: ikiwiki/directive
428 # Should teximg use dvipng to render, or dvips and convert?
430 # LaTeX prefix for teximg plugin
432 # \documentclass{article}
433 # \usepackage[utf8]{inputenc}
434 # \usepackage{amsmath}
435 # \usepackage{amsfonts}
436 # \usepackage{amssymb}
439 # LaTeX postfix for teximg plugin
440 #teximg_postfix: '\end{document}'
442 ######################################################################
444 # (aggregate, autoindex, brokenlinks, camelcase, ddate, embed, favicon,
445 # flattr, goodstuff, htmlbalance, localstyle, missingsite, pagetemplate,
446 # parked, pingee, pinger, prettydate, recentchanges, recentchangesdiff,
447 # relativedate, rsync, sidebar, smiley, sortnaturally, tag,
448 # testpagespec, transient, typography, underlay)
449 ######################################################################
452 # enable aggregation to internal pages?
454 # allow aggregation to be triggered via the web?
455 #aggregate_webtrigger: 0
458 file: /home/b-ikiwiki/.ikiwiki/cookies
461 # commit autocreated index pages
465 # list of words to not turn into links
466 #camelcase_ignore: []
469 # userid or user name to use by default for Flattr buttons
470 #flattr_userid: joeyh
473 # An optional message explaining why this site is parked.
477 # how many seconds to try pinging before timing out
481 # format to use to display date
482 prettydateformat: '%X, %B %o, %Y'
484 # recentchanges plugin
485 # name of the recentchanges page
486 recentchangespage: recentchanges
487 # number of changes to track
488 recentchangesnum: 100
491 # command to run to sync updated pages
492 #rsync_command: rsync -qa --delete . user@host:/path/to/docroot/
495 # show sidebar page on all pages?
499 # parent page tags are located under
501 # autocreate new tag pages?
503 # commit autocreated tag pages
504 tag_autocreate_commit: 1
507 # Text::Typography attributes value
508 #typographyattributes: 3
511 # extra underlay directories to add
513 # - /home/b-ikiwiki/wiki.underlay