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
20 - https://me.yahoo.com/a/3hUnH9Qi24uk3RwCwHATJBWKVyqc#7d8b8
22 - https://me.yahoo.com/a/2.Pjpm0G0Z6F9LiGW4cYO84pIrb.Lg--#137de
23 - https://www.google.com/accounts/o8/id?id=AItOawkuR0eo_HO1s1hs49h0Y_4Bzm08l9evMEc
24 - https://www.google.com/accounts/o8/id?id=AItOawlYXeKSEBoSCzES7o5VYiSratG5RfNucL0
45 - http://cmelbye.myopenid.com/
56 # where the source of the wiki is located
57 srcdir: /home/b-ikiwiki/source/doc
58 # where to build the wiki
59 destdir: /home/b-ikiwiki/public_html
60 # base url to the wiki
61 url: http://ikiwiki.info
62 # url to the ikiwiki.cgi
63 cgiurl: http://ikiwiki.info/ikiwiki.cgi
64 # filename of cgi wrapper to generate
65 cgi_wrapper: /var/www/b-ikiwiki/ikiwiki.cgi
66 # mode for cgi_wrapper (can safely be made suid)
70 # plugins to add to the default configuration
115 # additional directory to search for template files
116 templatedir: /usr/share/ikiwiki/templates
117 # base wiki source location
118 underlaydir: /usr/share/ikiwiki/basewiki
119 # display verbose messages?
123 # create output files named page/index.html?
125 # use '!'-prefixed preprocessor directives?
127 # use page/index.mdwn source files
129 # enable Discussion pages?
131 # name of Discussion pages
132 discussionpage: Discussion
133 # generate HTML5? (experimental)
135 # only send cookies over SSL connections?
137 # extension to use for new pages
138 default_pageext: mdwn
139 # extension to use for html files
141 # strftime format string to display date
143 # UTF-8 locale to use
145 # put user pages below specified page
147 # how many backlinks to show before hiding excess (0 to show all)
149 # attempt to hardlink source files? (optimisation for large files)
151 # force ikiwiki to use a particular umask
153 # group for wrappers to run in
154 #wrappergroup: ikiwiki
155 # extra library and plugin directory
156 libdir: /home/b-ikiwiki/.ikiwiki
157 # environment variables
159 TMPDIR: /home/b-ikiwiki/tmp
161 #timezone: US/Eastern
162 # regexp of normally excluded files to include
163 #include: '^\.htaccess$'
164 # regexp of files that should be skipped
165 #exclude: '^(*\.private|Makefile)$'
166 # specifies the characters that are allowed in source filenames
167 wiki_file_chars: '-[:alnum:]+/.:_'
168 # allow symlinks in the path leading to the srcdir (potentially insecure)
169 allow_symlinks_before_srcdir: 0
171 ######################################################################
173 # (branchable, editpage, git, gitpush, htmlscrubber, ikiwikihosting,
174 # inline, link, meta, parentlinks)
175 ######################################################################
178 # Allow anyone to branch, check out, and copy this site?
180 # Allow anyone to git push verified changes to this site?
182 # Display "Branchable" link on action bar?
186 # git hook to generate
187 git_wrapper: /home/b-ikiwiki/source.git/hooks/post-update
188 # shell command for git_wrapper to run, in the background
189 #git_wrapper_background_command: git push github
190 # mode for git_wrapper (can safely be made suid)
191 git_wrappermode: 6755
192 # git pre-receive hook to generate
193 git_test_receive_wrapper: /home/b-ikiwiki/source.git/hooks/pre-receive
194 # unix users whose commits should be checked by the pre-receive hook
195 untrusted_committers:
197 # gitweb url to show file history ([[file]] substituted)
198 historyurl: 'http://source.ikiwiki.branchable.com/?p=source.git;a=history;f=doc/[[file]];hb=HEAD'
199 # gitweb url to show a diff ([[file]], [[sha1_to]], [[sha1_from]], [[sha1_commit]], and [[sha1_parent]] substituted)
200 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]]'
201 # where to pull and push changes (set to empty string to disable)
202 gitorigin_branch: origin
203 # branch that the wiki is stored in
204 gitmaster_branch: master
207 # git repository urls that changes are pushed to
209 - git@github.com:joeyh/ikiwiki.git
210 - joey@git.kitenet.net:/srv/git/ikiwiki.git
212 # htmlscrubber plugin
213 # PageSpec specifying pages not to scrub
214 htmlscrubber_skip: tipjar
216 # ikiwikihosting plugin
217 # list of urls that alias to the main url
219 - http://ikiwiki.branchable.com/
220 - http://ikiwiki.branchable.com/
221 - http://git.ikiwiki.info/
222 - http://www.ikiwiki.info/
223 # openid of primary site owner
224 owner: http://joey.kitenet.net/
225 # optional hostname of site this one was branched from
227 # internal hostname of this site
228 hostname: ikiwiki.branchable.com
229 # site creation datestamp
231 # how many days to retain logs
237 # enable rss feeds by default?
239 # enable atom feeds by default?
241 # allow rss feeds to be used?
243 # allow atom feeds to be used?
245 # urls to ping (using XML-RPC) on feed update
248 ######################################################################
250 # (anonok, blogspam, httpauth, lockedit, moderatedcomments,
251 # opendiscussion, openid, passwordauth, signinedit)
252 ######################################################################
255 # PageSpec to limit which pages anonymous users can edit
256 #anonok_pagespec: '*/discussion'
259 # PageSpec of pages to check for spam
260 #blogspam_pagespec: postcomment(*)
261 # options to send to blogspam server
262 #blogspam_options: 'blacklist=1.2.3.4,blacklist=8.7.6.5,max-links=10'
263 # blogspam server XML-RPC url
267 # url to redirect to when authentication is needed
268 #cgiauthurl: http://example.com/wiki/auth/ikiwiki.cgi
269 # PageSpec of pages where only httpauth will be used for authentication
270 #httpauth_pagespec: '!*/Discussion'
273 # PageSpec controlling which pages are locked
276 # moderatedcomments plugin
277 # PageSpec matching users or comment locations to moderate
278 #moderate_pagespec: '*'
281 # url pattern of openid realm (default is cgiurl)
282 openid_realm: http://*.branchable.com/
283 # url to ikiwiki cgi to use for openid authentication (default is cgiurl)
284 openid_cgiurl: http://ikiwiki.branchable.com/ikiwiki.cgi
286 # passwordauth plugin
287 # a password that must be entered when signing up for an account
288 #account_creation_password: s3cr1t
289 # cost of generating a password using Authen::Passphrase::BlowfishCrypt
292 ######################################################################
294 # (creole, highlight, hnb, html, mdwn, otl, po, rawhtml, rst, textile,
296 ######################################################################
299 # types of source files to syntax highlight
300 tohighlight: .c .h .cpp .pl .py Makefile:make
301 # location of highlight's filetypes.conf
302 filetypes_conf: /etc/highlight/filetypes.conf
303 # location of highlight's langDefs directory
304 langdefdir: /usr/share/highlight/langDefs
307 # enable multimarkdown features?
311 # master language (non-PO files)
312 #po_master_language: en|English
313 # slave languages (translated via PO files) format: ll|Langname
318 # PageSpec controlling which pages are translatable
319 po_translatable_pages: ''
320 # internal linking behavior (default/current/negotiated)
323 ######################################################################
326 ######################################################################
328 ######################################################################
330 # (404, attachment, comments, editdiff, edittemplate, google, goto,
331 # mirrorlist, remove, rename, repolist, search, theme, websetup, wmd)
332 ######################################################################
335 # enhanced PageSpec specifying what attachments are allowed
336 allowed_attachments: admin() and virusfree()
337 # virus checker program (reads STDIN, returns nonzero if virus found)
338 virus_checker: clamdscan -
341 # PageSpec of pages where comments are allowed
342 comments_pagespec: forum/* and !*/Discussion
343 # PageSpec of pages where posting new comments is not allowed
344 comments_closed_pagespec: ''
345 # Base name for comments, e.g. "comment_" for pages like "sandbox/comment_12"
346 comments_pagename: comment_
347 # Interpret directives in comments?
348 #comments_allowdirectives: 0
349 # Allow anonymous commenters to set an author name?
350 comments_allowauthor: 0
351 # commit comments to the VCS
359 # URIs of repositories containing the wiki's source
361 - ssh://b-ikiwiki@ikiwiki.branchable.com/
362 - git://ikiwiki.branchable.com/
365 # path to the omega cgi program
366 omega_cgi: /usr/lib/cgi-bin/omega/omega
369 # name of theme to enable
373 # list of plugins that cannot be enabled/disabled via the web interface
374 websetup_force_plugins:
379 # list of additional setup field keys to treat as unsafe
389 # show unsafe settings, read-only, in web interface?
390 websetup_show_unsafe: 0
392 ######################################################################
394 # (calendar, color, conditional, cutpaste, date, format, fortune,
395 # graphviz, haiku, img, linkmap, listdirectives, map, more, orphans,
396 # pagecount, pagestats, poll, polygen, postsparkline, progress,
397 # shortcut, sparkline, table, template, teximg, toc, toggle, version)
398 ######################################################################
401 # base of the archives hierarchy
402 #archivebase: archives
403 # PageSpec of pages to include in the archives; used by ikiwiki-calendar command
404 #archive_pagespec: page(posts/*) and !*/Discussion
406 # listdirectives plugin
407 # directory in srcdir that contains directive descriptions
408 directive_description_dir: ikiwiki/directive
411 # Should teximg use dvipng to render, or dvips and convert?
413 # LaTeX prefix for teximg plugin
415 # \documentclass{article}
416 # \usepackage[utf8]{inputenc}
417 # \usepackage{amsmath}
418 # \usepackage{amsfonts}
419 # \usepackage{amssymb}
422 # LaTeX postfix for teximg plugin
423 #teximg_postfix: '\end{document}'
425 ######################################################################
427 # (aggregate, autoindex, brokenlinks, camelcase, ddate, embed, favicon,
428 # flattr, goodstuff, htmlbalance, localstyle, missingsite, pagetemplate,
429 # parked, pingee, pinger, prettydate, recentchanges, recentchangesdiff,
430 # relativedate, rsync, sidebar, smiley, sortnaturally, tag,
431 # testpagespec, transient, typography, underlay)
432 ######################################################################
435 # enable aggregation to internal pages?
437 # allow aggregation to be triggered via the web?
438 #aggregate_webtrigger: 0
441 file: /home/b-ikiwiki/.ikiwiki/cookies
444 # commit autocreated index pages
448 # list of words to not turn into links
449 #camelcase_ignore: []
452 # userid or user name to use by default for Flattr buttons
453 #flattr_userid: joeyh
456 # An optional message explaining why this site is parked.
460 # how many seconds to try pinging before timing out
464 # format to use to display date
465 prettydateformat: '%X, %B %o, %Y'
467 # recentchanges plugin
468 # name of the recentchanges page
469 recentchangespage: recentchanges
470 # number of changes to track
471 recentchangesnum: 100
474 # command to run to sync updated pages
475 #rsync_command: rsync -qa --delete . user@host:/path/to/docroot/
478 # show sidebar page on all pages?
482 # parent page tags are located under
484 # autocreate new tag pages?
486 # commit autocreated tag pages
487 tag_autocreate_commit: 1
490 # Text::Typography attributes value
491 #typographyattributes: 3
494 # extra underlay directories to add
496 # - /home/b-ikiwiki/wiki.underlay