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@kitenet.net
14 # users who are wiki admins
16 - http://joey.kitenet.net/
17 # users who are banned from the wiki
19 # where the source of the wiki is located
20 srcdir: /home/b-ikiwiki/source/doc
21 # where to build the wiki
22 destdir: /home/b-ikiwiki/public_html
23 # base url to the wiki
24 url: http://ikiwiki.branchable.com
25 # url to the ikiwiki.cgi
26 cgiurl: http://ikiwiki.branchable.com/ikiwiki.cgi
27 # filename of cgi wrapper to generate
28 cgi_wrapper: /var/www/b-ikiwiki/ikiwiki.cgi
29 # mode for cgi_wrapper (can safely be made suid)
33 # plugins to add to the default configuration
59 # additional directory to search for template files
60 templatedir: /usr/share/ikiwiki/templates
61 # base wiki source location
62 underlaydir: /usr/share/ikiwiki/basewiki
63 # display verbose messages?
67 # create output files named page/index.html?
69 # use '!'-prefixed preprocessor directives?
71 # use page/index.mdwn source files
73 # enable Discussion pages?
75 # name of Discussion pages
76 discussionpage: Discussion
77 # generate HTML5? (experimental)
79 # only send cookies over SSL connections?
81 # extension to use for new pages
83 # extension to use for html files
85 # strftime format string to display date
89 # put user pages below specified page
91 # how many backlinks to show before hiding excess (0 to show all)
93 # attempt to hardlink source files? (optimisation for large files)
95 # force ikiwiki to use a particular umask
97 # group for wrappers to run in
98 #wrappergroup: ikiwiki
99 # extra library and plugin directory
100 libdir: /home/b-ikiwiki/.ikiwiki
101 # environment variables
103 TMPDIR: /home/b-ikiwiki/tmp
105 #timezone: US/Eastern
106 # regexp of normally excluded files to include
107 #include: '^\.htaccess$'
108 # regexp of files that should be skipped
109 #exclude: '^(*\.private|Makefile)$'
110 # specifies the characters that are allowed in source filenames
111 wiki_file_chars: '-[:alnum:]+/.:_'
112 # allow symlinks in the path leading to the srcdir (potentially insecure)
113 allow_symlinks_before_srcdir: 0
115 ######################################################################
117 # (branchable, editpage, git, gitpush, htmlscrubber, ikiwikihosting,
118 # inline, link, meta, parentlinks)
119 ######################################################################
122 # Allow anyone to branch, check out, and copy this site?
124 # Allow anyone to git push verified changes to this site?
126 # Display "Branchable" link on action bar?
130 # git hook to generate
131 git_wrapper: /home/b-ikiwiki/source.git/hooks/post-update
132 # shell command for git_wrapper to run, in the background
133 #git_wrapper_background_command: git push github
134 # mode for git_wrapper (can safely be made suid)
135 git_wrappermode: 6755
136 # git pre-receive hook to generate
137 git_test_receive_wrapper: /home/b-ikiwiki/source.git/hooks/pre-receive
138 # unix users whose commits should be checked by the pre-receive hook
139 untrusted_committers:
141 # gitweb url to show file history ([[file]] substituted)
142 historyurl: 'http://source.ikiwiki.branchable.com/?p=source.git;a=history;f=doc/[[file]];hb=HEAD'
143 # gitweb url to show a diff ([[file]], [[sha1_to]], [[sha1_from]], [[sha1_commit]], and [[sha1_parent]] substituted)
144 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]]'
145 # where to pull and push changes (set to empty string to disable)
146 gitorigin_branch: origin
147 # branch that the wiki is stored in
148 gitmaster_branch: master
151 # git repository urls that changes are pushed to
154 # htmlscrubber plugin
155 # PageSpec specifying pages not to scrub
156 #htmlscrubber_skip: '!*/Discussion'
158 # ikiwikihosting plugin
159 # list of urls that alias to the main url
161 # openid of primary site owner
162 owner: http://joey.kitenet.net/
163 # optional hostname of site this one was branched from
165 # internal hostname of this site
166 hostname: ikiwiki.branchable.com
167 # site creation datestamp
169 # how many days to retain logs
175 # enable rss feeds by default?
177 # enable atom feeds by default?
179 # allow rss feeds to be used?
181 # allow atom feeds to be used?
183 # urls to ping (using XML-RPC) on feed update
186 ######################################################################
188 # (anonok, blogspam, httpauth, lockedit, moderatedcomments,
189 # opendiscussion, openid, passwordauth, signinedit)
190 ######################################################################
193 # PageSpec to limit which pages anonymous users can edit
194 #anonok_pagespec: '*/discussion'
197 # PageSpec of pages to check for spam
198 #blogspam_pagespec: postcomment(*)
199 # options to send to blogspam server
200 #blogspam_options: 'blacklist=1.2.3.4,blacklist=8.7.6.5,max-links=10'
201 # blogspam server XML-RPC url
205 # url to redirect to when authentication is needed
206 #cgiauthurl: http://example.com/wiki/auth/ikiwiki.cgi
207 # PageSpec of pages where only httpauth will be used for authentication
208 #httpauth_pagespec: '!*/Discussion'
211 # PageSpec controlling which pages are locked
212 #locked_pages: '!*/Discussion'
214 # moderatedcomments plugin
215 # PageSpec matching users or comment locations to moderate
216 #moderate_pagespec: '*'
219 # url pattern of openid realm (default is cgiurl)
220 openid_realm: http://*.branchable.com/
221 # url to ikiwiki cgi to use for openid authentication (default is cgiurl)
222 openid_cgiurl: http://ikiwiki.branchable.com/ikiwiki.cgi
224 # passwordauth plugin
225 # a password that must be entered when signing up for an account
226 #account_creation_password: s3cr1t
227 # cost of generating a password using Authen::Passphrase::BlowfishCrypt
230 ######################################################################
232 # (creole, highlight, hnb, html, mdwn, otl, po, rawhtml, rst, textile,
234 ######################################################################
237 # types of source files to syntax highlight
238 tohighlight: .c .h .cpp .pl .py Makefile:make
239 # location of highlight's filetypes.conf
240 filetypes_conf: /etc/highlight/filetypes.conf
241 # location of highlight's langDefs directory
242 langdefdir: /usr/share/highlight/langDefs
245 # enable multimarkdown features?
249 # master language (non-PO files)
250 #po_master_language: en|English
251 # slave languages (translated via PO files) format: ll|Langname
256 # PageSpec controlling which pages are translatable
257 #po_translatable_pages: '* and !*/Discussion'
258 # internal linking behavior (default/current/negotiated)
261 ######################################################################
264 ######################################################################
266 ######################################################################
268 # (404, attachment, comments, editdiff, edittemplate, getsource, google,
269 # goto, mirrorlist, remove, rename, repolist, search, theme, websetup,
271 ######################################################################
274 # enhanced PageSpec specifying what attachments are allowed
275 allowed_attachments: admin() and virusfree()
276 # virus checker program (reads STDIN, returns nonzero if virus found)
277 virus_checker: clamdscan -
280 # PageSpec of pages where comments are allowed
281 #comments_pagespec: blog/* and !*/Discussion
282 # PageSpec of pages where posting new comments is not allowed
283 #comments_closed_pagespec: blog/controversial or blog/flamewar
284 # Base name for comments, e.g. "comment_" for pages like "sandbox/comment_12"
285 #comments_pagename: ''
286 # Interpret directives in comments?
287 #comments_allowdirectives: 0
288 # Allow anonymous commenters to set an author name?
289 #comments_allowauthor: 0
290 # commit comments to the VCS
294 # Mime type for returned source.
295 #getsource_mimetype: text/plain; charset=utf-8
302 # URIs of repositories containing the wiki's source
304 - ssh://b-ikiwiki@ikiwiki.branchable.com/
305 - git://ikiwiki.branchable.com/
308 # path to the omega cgi program
309 omega_cgi: /usr/lib/cgi-bin/omega/omega
312 # name of theme to enable
316 # list of plugins that cannot be enabled/disabled via the web interface
317 websetup_force_plugins:
322 # list of additional setup field keys to treat as unsafe
332 # show unsafe settings, read-only, in web interface?
333 websetup_show_unsafe: 0
335 ######################################################################
337 # (calendar, color, conditional, cutpaste, date, format, fortune,
338 # graphviz, haiku, img, linkmap, listdirectives, map, more, orphans,
339 # pagecount, pagestats, poll, polygen, postsparkline, progress,
340 # shortcut, sparkline, table, template, teximg, toc, toggle, version)
341 ######################################################################
344 # base of the archives hierarchy
345 #archivebase: archives
346 # PageSpec of pages to include in the archives; used by ikiwiki-calendar command
347 #archive_pagespec: page(posts/*) and !*/Discussion
349 # listdirectives plugin
350 # directory in srcdir that contains directive descriptions
351 directive_description_dir: ikiwiki/directive
354 # Should teximg use dvipng to render, or dvips and convert?
356 # LaTeX prefix for teximg plugin
358 # \documentclass{article}
359 # \usepackage[utf8]{inputenc}
360 # \usepackage{amsmath}
361 # \usepackage{amsfonts}
362 # \usepackage{amssymb}
365 # LaTeX postfix for teximg plugin
366 #teximg_postfix: '\end{document}'
368 ######################################################################
370 # (aggregate, autoindex, brokenlinks, camelcase, ddate, embed, favicon,
371 # flattr, goodstuff, htmlbalance, localstyle, missingsite, pagetemplate,
372 # parked, pingee, pinger, prettydate, recentchanges, recentchangesdiff,
373 # relativedate, rsync, sidebar, smiley, sortnaturally, tag,
374 # testpagespec, transient, typography, underlay)
375 ######################################################################
378 # enable aggregation to internal pages?
379 #aggregateinternal: 1
380 # allow aggregation to be triggered via the web?
381 #aggregate_webtrigger: 0
384 # file: /home/b-ikiwiki/.ikiwiki/cookies
387 # commit autocreated index pages
391 # list of words to not turn into links
392 #camelcase_ignore: []
395 # userid or user name to use by default for Flattr buttons
396 #flattr_userid: joeyh
399 # An optional message explaining why this site is parked.
403 # how many seconds to try pinging before timing out
407 # format to use to display date
408 #prettydateformat: '%X, %B %o, %Y'
410 # recentchanges plugin
411 # name of the recentchanges page
412 recentchangespage: recentchanges
413 # number of changes to track
414 recentchangesnum: 100
417 # command to run to sync updated pages
418 #rsync_command: rsync -qa --delete . user@host:/path/to/docroot/
421 # show sidebar page on all pages?
425 # parent page tags are located under
427 # autocreate new tag pages?
429 # commit autocreated tag pages
430 tag_autocreate_commit: 1
433 # Text::Typography attributes value
434 #typographyattributes: 3
437 # extra underlay directories to add
439 # - /home/b-ikiwiki/wiki.underlay