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
57 # where to build the wiki
58 destdir: /home/b-ikiwiki/public_html
59 # base url to the wiki
60 url: http://ikiwiki.branchable.com
61 # url to the ikiwiki.cgi
62 cgiurl: http://ikiwiki.branchable.com/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
95 # additional directory to search for template files
96 templatedir: /usr/share/ikiwiki/templates
97 # base wiki source location
98 underlaydir: /usr/share/ikiwiki/basewiki
99 # display verbose messages?
103 # create output files named page/index.html?
105 # use '!'-prefixed preprocessor directives?
107 # use page/index.mdwn source files
109 # enable Discussion pages?
111 # name of Discussion pages
112 discussionpage: Discussion
113 # generate HTML5? (experimental)
115 # only send cookies over SSL connections?
117 # extension to use for new pages
118 default_pageext: mdwn
119 # extension to use for html files
121 # strftime format string to display date
123 # UTF-8 locale to use
125 # put user pages below specified page
127 # how many backlinks to show before hiding excess (0 to show all)
129 # attempt to hardlink source files? (optimisation for large files)
131 # force ikiwiki to use a particular umask
133 # group for wrappers to run in
134 #wrappergroup: ikiwiki
135 # extra library and plugin directory
136 libdir: /home/b-ikiwiki/.ikiwiki
137 # environment variables
139 TMPDIR: /home/b-ikiwiki/tmp
141 #timezone: US/Eastern
142 # regexp of normally excluded files to include
143 #include: '^\.htaccess$'
144 # regexp of files that should be skipped
145 #exclude: '^(*\.private|Makefile)$'
146 # specifies the characters that are allowed in source filenames
147 wiki_file_chars: '-[:alnum:]+/.:_'
148 # allow symlinks in the path leading to the srcdir (potentially insecure)
149 allow_symlinks_before_srcdir: 0
151 ######################################################################
153 # (branchable, editpage, git, gitpush, htmlscrubber, ikiwikihosting,
154 # inline, link, meta, parentlinks)
155 ######################################################################
158 # Allow anyone to branch, check out, and copy this site?
160 # Allow anyone to git push verified changes to this site?
162 # Display "Branchable" link on action bar?
166 # git hook to generate
167 git_wrapper: /home/b-ikiwiki/source.git/hooks/post-update
168 # shell command for git_wrapper to run, in the background
169 #git_wrapper_background_command: git push github
170 # mode for git_wrapper (can safely be made suid)
171 git_wrappermode: 6755
172 # git pre-receive hook to generate
173 git_test_receive_wrapper: /home/b-ikiwiki/source.git/hooks/pre-receive
174 # unix users whose commits should be checked by the pre-receive hook
175 untrusted_committers:
177 # gitweb url to show file history ([[file]] substituted)
178 historyurl: 'http://source.ikiwiki.branchable.com/?p=source.git;a=history;f=[[file]];hb=HEAD'
179 # gitweb url to show a diff ([[file]], [[sha1_to]], [[sha1_from]], [[sha1_commit]], and [[sha1_parent]] substituted)
180 diffurl: 'http://source.ikiwiki.branchable.com/?p=source.git;a=blobdiff;f=[[file]];h=[[sha1_to]];hp=[[sha1_from]];hb=[[sha1_commit]];hpb=[[sha1_parent]]'
181 # where to pull and push changes (set to empty string to disable)
182 gitorigin_branch: origin
183 # branch that the wiki is stored in
184 gitmaster_branch: master
187 # git repository urls that changes are pushed to
190 # htmlscrubber plugin
191 # PageSpec specifying pages not to scrub
192 #htmlscrubber_skip: '!*/Discussion'
194 # ikiwikihosting plugin
195 # list of urls that alias to the main url
197 # openid of primary site owner
198 owner: http://joey.kitenet.net/
199 # optional hostname of site this one was branched from
201 # internal hostname of this site
202 hostname: ikiwiki.branchable.com
203 # site creation datestamp
205 # how many days to retain logs
211 # enable rss feeds by default?
213 # enable atom feeds by default?
215 # allow rss feeds to be used?
217 # allow atom feeds to be used?
219 # urls to ping (using XML-RPC) on feed update
222 ######################################################################
224 # (anonok, blogspam, httpauth, lockedit, moderatedcomments,
225 # opendiscussion, openid, passwordauth, signinedit)
226 ######################################################################
229 # PageSpec to limit which pages anonymous users can edit
230 #anonok_pagespec: '*/discussion'
233 # PageSpec of pages to check for spam
234 #blogspam_pagespec: postcomment(*)
235 # options to send to blogspam server
236 #blogspam_options: 'blacklist=1.2.3.4,blacklist=8.7.6.5,max-links=10'
237 # blogspam server XML-RPC url
241 # url to redirect to when authentication is needed
242 #cgiauthurl: http://example.com/wiki/auth/ikiwiki.cgi
243 # PageSpec of pages where only httpauth will be used for authentication
244 #httpauth_pagespec: '!*/Discussion'
247 # PageSpec controlling which pages are locked
248 #locked_pages: '!*/Discussion'
250 # moderatedcomments plugin
251 # PageSpec matching users or comment locations to moderate
252 #moderate_pagespec: '*'
255 # url pattern of openid realm (default is cgiurl)
256 openid_realm: http://*.branchable.com/
257 # url to ikiwiki cgi to use for openid authentication (default is cgiurl)
258 openid_cgiurl: http://ikiwiki.branchable.com/ikiwiki.cgi
260 # passwordauth plugin
261 # a password that must be entered when signing up for an account
262 #account_creation_password: s3cr1t
263 # cost of generating a password using Authen::Passphrase::BlowfishCrypt
266 ######################################################################
268 # (creole, highlight, hnb, html, mdwn, otl, po, rawhtml, rst, textile,
270 ######################################################################
273 # types of source files to syntax highlight
274 tohighlight: .c .h .cpp .pl .py Makefile:make
275 # location of highlight's filetypes.conf
276 filetypes_conf: /etc/highlight/filetypes.conf
277 # location of highlight's langDefs directory
278 langdefdir: /usr/share/highlight/langDefs
281 # enable multimarkdown features?
285 # master language (non-PO files)
286 #po_master_language: en|English
287 # slave languages (translated via PO files) format: ll|Langname
292 # PageSpec controlling which pages are translatable
293 #po_translatable_pages: '* and !*/Discussion'
294 # internal linking behavior (default/current/negotiated)
297 ######################################################################
300 ######################################################################
302 ######################################################################
304 # (404, attachment, comments, editdiff, edittemplate, getsource, google,
305 # goto, mirrorlist, remove, rename, repolist, search, theme, websetup,
307 ######################################################################
310 # enhanced PageSpec specifying what attachments are allowed
311 allowed_attachments: admin() and virusfree()
312 # virus checker program (reads STDIN, returns nonzero if virus found)
313 virus_checker: clamdscan -
316 # PageSpec of pages where comments are allowed
317 #comments_pagespec: blog/* and !*/Discussion
318 # PageSpec of pages where posting new comments is not allowed
319 #comments_closed_pagespec: blog/controversial or blog/flamewar
320 # Base name for comments, e.g. "comment_" for pages like "sandbox/comment_12"
321 #comments_pagename: ''
322 # Interpret directives in comments?
323 #comments_allowdirectives: 0
324 # Allow anonymous commenters to set an author name?
325 #comments_allowauthor: 0
326 # commit comments to the VCS
330 # Mime type for returned source.
331 #getsource_mimetype: text/plain; charset=utf-8
338 # URIs of repositories containing the wiki's source
340 - ssh://b-ikiwiki@ikiwiki.branchable.com/
341 - git://ikiwiki.branchable.com/
344 # path to the omega cgi program
345 omega_cgi: /usr/lib/cgi-bin/omega/omega
348 # name of theme to enable
352 # list of plugins that cannot be enabled/disabled via the web interface
353 websetup_force_plugins:
358 # list of additional setup field keys to treat as unsafe
368 # show unsafe settings, read-only, in web interface?
369 websetup_show_unsafe: 0
371 ######################################################################
373 # (calendar, color, conditional, cutpaste, date, format, fortune,
374 # graphviz, haiku, img, linkmap, listdirectives, map, more, orphans,
375 # pagecount, pagestats, poll, polygen, postsparkline, progress,
376 # shortcut, sparkline, table, template, teximg, toc, toggle, version)
377 ######################################################################
380 # base of the archives hierarchy
381 #archivebase: archives
382 # PageSpec of pages to include in the archives; used by ikiwiki-calendar command
383 #archive_pagespec: page(posts/*) and !*/Discussion
385 # listdirectives plugin
386 # directory in srcdir that contains directive descriptions
387 directive_description_dir: ikiwiki/directive
390 # Should teximg use dvipng to render, or dvips and convert?
392 # LaTeX prefix for teximg plugin
394 # \documentclass{article}
395 # \usepackage[utf8]{inputenc}
396 # \usepackage{amsmath}
397 # \usepackage{amsfonts}
398 # \usepackage{amssymb}
401 # LaTeX postfix for teximg plugin
402 #teximg_postfix: '\end{document}'
404 ######################################################################
406 # (aggregate, autoindex, brokenlinks, camelcase, ddate, embed, favicon,
407 # flattr, goodstuff, htmlbalance, localstyle, missingsite, pagetemplate,
408 # parked, pingee, pinger, prettydate, recentchanges, recentchangesdiff,
409 # relativedate, rsync, sidebar, smiley, sortnaturally, tag,
410 # testpagespec, transient, typography, underlay)
411 ######################################################################
414 # enable aggregation to internal pages?
415 #aggregateinternal: 1
416 # allow aggregation to be triggered via the web?
417 #aggregate_webtrigger: 0
420 # file: /home/b-ikiwiki/.ikiwiki/cookies
423 # commit autocreated index pages
427 # list of words to not turn into links
428 #camelcase_ignore: []
431 # userid or user name to use by default for Flattr buttons
432 #flattr_userid: joeyh
435 # An optional message explaining why this site is parked.
439 # how many seconds to try pinging before timing out
443 # format to use to display date
444 #prettydateformat: '%X, %B %o, %Y'
446 # recentchanges plugin
447 # name of the recentchanges page
448 recentchangespage: recentchanges
449 # number of changes to track
450 recentchangesnum: 100
453 # command to run to sync updated pages
454 #rsync_command: rsync -qa --delete . user@host:/path/to/docroot/
457 # show sidebar page on all pages?
461 # parent page tags are located under
463 # autocreate new tag pages?
465 # commit autocreated tag pages
466 tag_autocreate_commit: 1
469 # Text::Typography attributes value
470 #typographyattributes: 3
473 # extra underlay directories to add
475 # - /home/b-ikiwiki/wiki.underlay