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