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/
59 - https://www.google.com/accounts/o8/id?id=AItOawkJHb27RVmw93kqyzfoxZWNKjqR8MEVt3A
61 - https://www.google.com/accounts/o8/id?id=AItOawkljravtnjpauReS81ng5zVurZx_thpse8
63 # where the source of the wiki is located
64 srcdir: /home/b-ikiwiki/source/doc
65 # where to build the wiki
66 destdir: /home/b-ikiwiki/public_html
67 # base url to the wiki
68 url: http://ikiwiki.info
69 # url to the ikiwiki.cgi
70 cgiurl: http://ikiwiki.info/ikiwiki.cgi
71 # filename of cgi wrapper to generate
72 cgi_wrapper: /var/www/b-ikiwiki/ikiwiki.cgi
73 # mode for cgi_wrapper (can safely be made suid)
77 # plugins to add to the default configuration
122 # additional directory to search for template files
123 templatedir: /usr/share/ikiwiki/templates
124 # base wiki source location
125 underlaydir: /usr/share/ikiwiki/basewiki
126 # display verbose messages?
130 # create output files named page/index.html?
132 # use '!'-prefixed preprocessor directives?
134 # use page/index.mdwn source files
136 # enable Discussion pages?
138 # name of Discussion pages
139 discussionpage: Discussion
142 # only send cookies over SSL connections?
144 # extension to use for new pages
145 default_pageext: mdwn
146 # extension to use for html files
148 # strftime format string to display date
150 # UTF-8 locale to use
152 # put user pages below specified page
154 # how many backlinks to show before hiding excess (0 to show all)
156 # attempt to hardlink source files? (optimisation for large files)
158 # force ikiwiki to use a particular umask
160 # group for wrappers to run in
161 #wrappergroup: ikiwiki
162 # extra library and plugin directory
163 libdir: /home/b-ikiwiki/.ikiwiki
164 # environment variables
166 TMPDIR: /home/b-ikiwiki/tmp
169 # regexp of normally excluded files to include
170 #include: '^\.htaccess$'
171 # regexp of files that should be skipped
172 #exclude: '^(*\.private|Makefile)$'
173 # specifies the characters that are allowed in source filenames
174 wiki_file_chars: '-[:alnum:]+/.:_'
175 # allow symlinks in the path leading to the srcdir (potentially insecure)
176 allow_symlinks_before_srcdir: 0
178 ######################################################################
180 # (branchable, editpage, git, gitpush, htmlscrubber, ikiwikihosting,
181 # inline, link, meta, parentlinks)
182 ######################################################################
185 # Allow anyone to branch, check out, and copy this site?
187 # Allow anyone to git push verified changes to this site?
189 # Display "Branchable" link on action bar?
193 # git hook to generate
194 git_wrapper: /home/b-ikiwiki/source.git/hooks/post-update
195 # shell command for git_wrapper to run, in the background
196 #git_wrapper_background_command: git push github
197 # mode for git_wrapper (can safely be made suid)
198 git_wrappermode: 6755
199 # git pre-receive hook to generate
200 git_test_receive_wrapper: /home/b-ikiwiki/source.git/hooks/pre-receive
201 # unix users whose commits should be checked by the pre-receive hook
202 untrusted_committers:
204 # gitweb url to show file history ([[file]] substituted)
205 historyurl: 'http://source.ikiwiki.branchable.com/?p=source.git;a=history;f=doc/[[file]];hb=HEAD'
206 # gitweb url to show a diff ([[file]], [[sha1_to]], [[sha1_from]], [[sha1_commit]], and [[sha1_parent]] substituted)
207 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]]'
208 # where to pull and push changes (set to empty string to disable)
209 gitorigin_branch: origin
210 # branch that the wiki is stored in
211 gitmaster_branch: master
214 # git repository urls that changes are pushed to
216 - git@github.com:joeyh/ikiwiki.git
217 - joey@git.kitenet.net:/srv/git/ikiwiki.git
219 # htmlscrubber plugin
220 # PageSpec specifying pages not to scrub
221 htmlscrubber_skip: tipjar
223 # ikiwikihosting plugin
224 # list of urls that alias to the main url
226 - http://ikiwiki.branchable.com/
227 - http://ikiwiki.branchable.com/
228 - http://git.ikiwiki.info/
229 - http://www.ikiwiki.info/
230 # openid of primary site owner
231 owner: http://joey.kitenet.net/
232 # optional hostname of site this one was branched from
234 # internal hostname of this site
235 hostname: ikiwiki.branchable.com
236 # site creation datestamp
238 # how many days to retain logs
244 # enable rss feeds by default?
246 # enable atom feeds by default?
248 # allow rss feeds to be used?
250 # allow atom feeds to be used?
252 # urls to ping (using XML-RPC) on feed update
255 ######################################################################
257 # (anonok, blogspam, httpauth, lockedit, moderatedcomments,
258 # opendiscussion, openid, passwordauth, signinedit)
259 ######################################################################
262 # PageSpec to limit which pages anonymous users can edit
263 #anonok_pagespec: '*/discussion'
266 # PageSpec of pages to check for spam
267 #blogspam_pagespec: postcomment(*)
268 # options to send to blogspam server
269 #blogspam_options: 'blacklist=1.2.3.4,blacklist=8.7.6.5,max-links=10'
270 # blogspam server XML-RPC url
274 # url to redirect to when authentication is needed
275 #cgiauthurl: http://example.com/wiki/auth/ikiwiki.cgi
276 # PageSpec of pages where only httpauth will be used for authentication
277 #httpauth_pagespec: '!*/Discussion'
280 # PageSpec controlling which pages are locked
283 # moderatedcomments plugin
284 # PageSpec matching users or comment locations to moderate
285 #moderate_pagespec: '*'
288 # url pattern of openid realm (default is cgiurl)
289 openid_realm: http://*.branchable.com/
290 # url to ikiwiki cgi to use for openid authentication (default is cgiurl)
291 openid_cgiurl: http://ikiwiki.branchable.com/ikiwiki.cgi
293 # passwordauth plugin
294 # a password that must be entered when signing up for an account
295 #account_creation_password: s3cr1t
296 # cost of generating a password using Authen::Passphrase::BlowfishCrypt
299 ######################################################################
301 # (creole, highlight, hnb, html, mdwn, otl, po, rawhtml, rst, textile,
303 ######################################################################
306 # types of source files to syntax highlight
307 tohighlight: .c .h .cpp .pl .py Makefile:make
308 # location of highlight's filetypes.conf
309 filetypes_conf: /etc/highlight/filetypes.conf
310 # location of highlight's langDefs directory
311 langdefdir: /usr/share/highlight/langDefs
314 # enable multimarkdown features?
318 # master language (non-PO files)
319 #po_master_language: en|English
320 # slave languages (translated via PO files) format: ll|Langname
325 # PageSpec controlling which pages are translatable
326 po_translatable_pages: ''
327 # internal linking behavior (default/current/negotiated)
330 ######################################################################
333 ######################################################################
335 ######################################################################
337 # (404, attachment, comments, editdiff, edittemplate, getsource, google,
338 # goto, mirrorlist, remove, rename, repolist, search, theme, userlist,
340 ######################################################################
343 # enhanced PageSpec specifying what attachments are allowed
344 allowed_attachments: admin() and virusfree()
345 # virus checker program (reads STDIN, returns nonzero if virus found)
346 virus_checker: clamdscan -
349 # PageSpec of pages where comments are allowed
350 comments_pagespec: forum/* and !*/Discussion
351 # PageSpec of pages where posting new comments is not allowed
352 comments_closed_pagespec: ''
353 # Base name for comments, e.g. "comment_" for pages like "sandbox/comment_12"
354 comments_pagename: comment_
355 # Interpret directives in comments?
356 #comments_allowdirectives: 0
357 # Allow anonymous commenters to set an author name?
358 comments_allowauthor: 0
359 # commit comments to the VCS
363 # Mime type for returned source.
364 #getsource_mimetype: text/plain; charset=utf-8
371 # URIs of repositories containing the wiki's source
373 - ssh://b-ikiwiki@ikiwiki.branchable.com/
374 - git://ikiwiki.branchable.com/
377 # path to the omega cgi program
378 omega_cgi: /usr/lib/cgi-bin/omega/omega
381 # name of theme to enable
385 # list of plugins that cannot be enabled/disabled via the web interface
386 websetup_force_plugins:
391 # list of additional setup field keys to treat as unsafe
402 # show unsafe settings, read-only, in web interface?
403 websetup_show_unsafe: 0
405 ######################################################################
407 # (calendar, color, conditional, cutpaste, date, format, fortune,
408 # graphviz, haiku, headinganchors, img, linkmap, listdirectives, map,
409 # more, orphans, pagecount, pagestats, poll, polygen, postsparkline,
410 # progress, shortcut, sparkline, table, template, teximg, toc, toggle,
412 ######################################################################
415 # base of the archives hierarchy
416 #archivebase: archives
417 # PageSpec of pages to include in the archives; used by ikiwiki-calendar command
418 #archive_pagespec: page(posts/*) and !*/Discussion
420 # listdirectives plugin
421 # directory in srcdir that contains directive descriptions
422 directive_description_dir: ikiwiki/directive
425 # Should teximg use dvipng to render, or dvips and convert?
427 # LaTeX prefix for teximg plugin
429 # \documentclass{article}
430 # \usepackage[utf8]{inputenc}
431 # \usepackage{amsmath}
432 # \usepackage{amsfonts}
433 # \usepackage{amssymb}
436 # LaTeX postfix for teximg plugin
437 #teximg_postfix: '\end{document}'
439 ######################################################################
441 # (aggregate, autoindex, brokenlinks, camelcase, ddate, embed, favicon,
442 # flattr, goodstuff, htmlbalance, localstyle, missingsite, pagetemplate,
443 # parked, pingee, pinger, prettydate, recentchanges, recentchangesdiff,
444 # relativedate, rsync, sidebar, smiley, sortnaturally, tag,
445 # testpagespec, transient, typography, underlay)
446 ######################################################################
449 # enable aggregation to internal pages?
451 # allow aggregation to be triggered via the web?
452 #aggregate_webtrigger: 0
455 file: /home/b-ikiwiki/.ikiwiki/cookies
458 # commit autocreated index pages
462 # list of words to not turn into links
463 #camelcase_ignore: []
466 # userid or user name to use by default for Flattr buttons
467 #flattr_userid: joeyh
470 # An optional message explaining why this site is parked.
474 # how many seconds to try pinging before timing out
478 # format to use to display date
479 prettydateformat: '%X, %B %o, %Y'
481 # recentchanges plugin
482 # name of the recentchanges page
483 recentchangespage: recentchanges
484 # number of changes to track
485 recentchangesnum: 100
488 # command to run to sync updated pages
489 #rsync_command: rsync -qa --delete . user@host:/path/to/docroot/
492 # show sidebar page on all pages?
496 # parent page tags are located under
498 # autocreate new tag pages?
500 # commit autocreated tag pages
501 tag_autocreate_commit: 1
504 # Text::Typography attributes value
505 #typographyattributes: 3
508 # extra underlay directories to add
510 # - /home/b-ikiwiki/wiki.underlay