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