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: admin@branchable.com
14 # users who are wiki admins
16 - http://joey.kitenet.net/
19 # users who are banned from the wiki
21 - http://tonyguards.myopenid.com/
22 - http://butoijoh.myopenid.com/
27 - https://www.google.com/accounts/o8/id?id=AItOawnAq_X98v6qKJFwl-MyLb440vC8laTdiMg
28 - https://www.google.com/accounts/o8/id?id=AItOawm_nWF_tPw8mLI7rMxfykA_d3FehQNvWpI
29 - https://www.google.com/accounts/o8/id?id=AItOawkTn3HixU2KJIvvLXLqwYUzlDGDtYf43GE
30 - https://www.google.com/accounts/o8/id?id=AItOawkDOCT-KTCLpieip-2W0N51gZwF7nGLaS0
31 - https://www.google.com/accounts/o8/id?id=AItOawl8-V-Yp0F5ZWRmDb7j4ul1gsbMXjghDIU
32 - https://www.google.com/accounts/o8/id?id=AItOawkaL6e6GtpyD7gJyqHphon_5ES1ACDLJgg
33 - https://www.google.com/accounts/o8/id?id=AItOawnv-w7GplWln2P55lnzc6Ds-ltzk6sNxDY
34 - https://me.yahoo.com/a/3hUnH9Qi24uk3RwCwHATJBWKVyqc#7d8b8
36 - https://me.yahoo.com/a/2.Pjpm0G0Z6F9LiGW4cYO84pIrb.Lg--#137de
37 - https://www.google.com/accounts/o8/id?id=AItOawkuR0eo_HO1s1hs49h0Y_4Bzm08l9evMEc
38 - https://www.google.com/accounts/o8/id?id=AItOawlYXeKSEBoSCzES7o5VYiSratG5RfNucL0
39 - https://www.google.com/accounts/o8/id?id=AItOawl_wuvPHDhkuMVnEOP5jLrZyd3nnBs8YRw
60 - http://cmelbye.myopenid.com/
73 - https://www.google.com/accounts/o8/id?id=AItOawkJHb27RVmw93kqyzfoxZWNKjqR8MEVt3A
75 - https://www.google.com/accounts/o8/id?id=AItOawkljravtnjpauReS81ng5zVurZx_thpse8
88 - https://www.google.com/accounts/o8/id?id=AItOawnO6NxsiqDMNHCMugqNKPwCWmTAQ7v_2Fs
90 - https://pypi.python.org/id/tlevine
92 - https://me.yahoo.com/a/FQMi.N5i0IzdnUgI0Ite4hPzi5Teukf.wOGAiQ--#4e81f
93 - https://www.google.com/accounts/o8/id?id=AItOawlowX5C5dCp9CmqRAUSMhjaRcDEqZrLZ5M
96 - https://www.google.com/accounts/o8/id?id=AItOawlyeMDnU_eaFpTAKNEyeZJJIcWPdLyz3js
98 # where the source of the wiki is located
99 srcdir: /home/b-ikiwiki/source/doc
100 # where to build the wiki
101 destdir: /home/b-ikiwiki/public_html
102 # base url to the wiki
103 url: http://ikiwiki.info
104 # url to the ikiwiki.cgi
105 cgiurl: http://ikiwiki.info/ikiwiki.cgi
106 # do not adjust cgiurl if CGI is accessed via different URL
108 # filename of cgi wrapper to generate
109 cgi_wrapper: /var/www/b-ikiwiki/ikiwiki.cgi
110 # mode for cgi_wrapper (can safely be made suid)
111 cgi_wrappermode: 0755
112 # number of seconds to delay CGI requests when overloaded
113 cgi_overload_delay: ''
114 # message to display when overloaded (may contain html)
115 cgi_overload_message: Please wait..
116 # enable optimization of only refreshing committed changes?
117 only_committed_changes: 0
120 # plugins to add to the default configuration
166 # additional directory to search for template files
167 templatedir: /usr/share/ikiwiki/templates
168 # base wiki source location
169 underlaydir: /usr/share/ikiwiki/basewiki
170 # display verbose messages?
174 # create output files named page/index.html?
176 # use '!'-prefixed preprocessor directives?
178 # use page/index.mdwn source files
180 # enable Discussion pages?
182 # name of Discussion pages
183 discussionpage: Discussion
184 # use elements new in HTML5 like <section>?
186 # only send cookies over SSL connections?
188 # extension to use for new pages
189 default_pageext: mdwn
190 # extension to use for html files
192 # strftime format string to display date
194 # UTF-8 locale to use
196 # put user pages below specified page
198 # how many backlinks to show before hiding excess (0 to show all)
200 # attempt to hardlink source files? (optimisation for large files)
202 # force ikiwiki to use a particular umask (keywords public, group or private, or a number)
204 # group for wrappers to run in
205 #wrappergroup: ikiwiki
206 # extra library and plugin directories
208 # extra library and plugin directory (searched after libdirs)
209 libdir: /home/b-ikiwiki/.ikiwiki
210 # environment variables
212 TMPDIR: /home/b-ikiwiki/tmp
215 # regexp of normally excluded files to include
216 #include: ^\.htaccess$
217 # regexp of files that should be skipped
218 #exclude: ^(*\.private|Makefile)$
219 # specifies the characters that are allowed in source filenames
220 wiki_file_chars: -[:alnum:]+/.:_
221 # allow symlinks in the path leading to the srcdir (potentially insecure)
222 allow_symlinks_before_srcdir: 0
225 file: /home/b-ikiwiki/.ikiwiki/cookies
226 # set custom user agent string for outbound HTTP requests e.g. when fetching aggregated RSS feeds
227 useragent: ikiwiki/3.20150330
228 # theme has a responsive layout? (mobile-optimized)
231 ######################################################################
233 # (branchable, editpage, git, gitpush, htmlscrubber, ikiwikihosting,
234 # inline, link, meta, parentlinks, templatebody)
235 ######################################################################
238 # Allow anyone to branch, check out, and copy this site?
240 # Allow anyone to git push verified changes to this site?
242 # Display "Branchable" link on action bar?
246 # git hook to generate
247 git_wrapper: /home/b-ikiwiki/source.git/hooks/post-update
248 # shell command for git_wrapper to run, in the background
249 #git_wrapper_background_command: git push github
250 # mode for git_wrapper (can safely be made suid)
251 git_wrappermode: 6755
252 # git pre-receive hook to generate
253 git_test_receive_wrapper: /home/b-ikiwiki/source.git/hooks/pre-receive
254 # unix users whose commits should be checked by the pre-receive hook
255 untrusted_committers:
257 # gitweb url to show file history ([[file]] substituted)
258 historyurl: http://source.ikiwiki.branchable.com/?p=source.git;a=history;f=doc/[[file]];hb=HEAD
259 # gitweb url to show a diff ([[file]], [[sha1_to]], [[sha1_from]], [[sha1_commit]], and [[sha1_parent]] substituted)
260 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]]
261 # where to pull and push changes (set to empty string to disable)
262 gitorigin_branch: origin
263 # branch that the wiki is stored in
264 gitmaster_branch: master
267 # git repository urls that changes are pushed to
269 - git@github.com:joeyh/ikiwiki.git
270 - joey@git.kitenet.net:/srv/git/ikiwiki.git
272 # htmlscrubber plugin
273 # PageSpec specifying pages not to scrub
274 htmlscrubber_skip: tipjar
276 # ikiwikihosting plugin
277 # list of urls that alias to the main url
279 - http://ikiwiki.branchable.com/
280 - http://ikiwiki.branchable.com/
281 - http://git.ikiwiki.info/
282 - http://www.ikiwiki.info/
283 # openid or email of primary site owner
284 owner: http://joey.kitenet.net/
285 # optional hostname of site this one was branched from
287 # internal hostname of this site
288 hostname: ikiwiki.branchable.com
289 # site creation datestamp
291 # how many days to retain logs
295 # redirect from http to https?
299 # enable rss feeds by default?
301 # enable atom feeds by default?
303 # allow rss feeds to be used?
305 # allow atom feeds to be used?
307 # urls to ping (using XML-RPC) on feed update
310 ######################################################################
312 # (anonok, blogspam, emailauth, httpauth, lockedit, moderatedcomments,
313 # opendiscussion, openid, passwordauth, signinedit)
314 ######################################################################
317 # PageSpec to limit which pages anonymous users can edit
318 #anonok_pagespec: '*/discussion'
321 # PageSpec of pages to check for spam
322 blogspam_pagespec: '*'
323 # options to send to blogspam server
324 #blogspam_options: blacklist=1.2.3.4,blacklist=8.7.6.5,max-links=10
325 # blogspam server JSON url
329 # url to redirect to when authentication is needed
330 #cgiauthurl: http://example.com/wiki/auth/ikiwiki.cgi
331 # PageSpec of pages where only httpauth will be used for authentication
332 #httpauth_pagespec: '!*/Discussion'
335 # PageSpec controlling which pages are locked
336 locked_pages: tipjar or tips/DreamHost
338 # moderatedcomments plugin
339 # PageSpec matching users or comment locations to moderate
340 #moderate_pagespec: '*'
343 # url pattern of openid realm (default is cgiurl)
345 # url to ikiwiki cgi to use for openid authentication (default is cgiurl)
348 # passwordauth plugin
349 # a password that must be entered when signing up for an account
350 #account_creation_password: s3cr1t
351 # cost of generating a password using Authen::Passphrase::BlowfishCrypt
354 ######################################################################
356 # (creole, highlight, hnb, html, mdwn, otl, po, rawhtml, rst, textile,
358 ######################################################################
361 # types of source files to syntax highlight
362 tohighlight: .c .h .cpp .pl .py Makefile:make
363 # location of highlight's filetypes.conf
364 filetypes_conf: /etc/highlight/filetypes.conf
365 # location of highlight's langDefs directory
366 langdefdir: /usr/share/highlight/langDefs
369 # enable multimarkdown features?
371 # disable use of markdown discount?
375 # master language (non-PO files)
376 #po_master_language: en|English
377 # slave languages (translated via PO files) format: ll|Langname
382 # PageSpec controlling which pages are translatable
383 po_translatable_pages: ''
384 # internal linking behavior (default/current/negotiated)
387 ######################################################################
388 # special-purpose plugins
390 ######################################################################
393 # the default zoom when you click on the map link
394 #osm_default_zoom: 15
395 # the icon shown on links and on the main map
396 #osm_default_icon: ikiwiki/images/osm.png
397 # the alt tag of links, defaults to empty
399 # the output format for waypoints, can be KML, GeoJSON or CSV (one or many, comma-separated)
401 # the icon attached to a tag, displayed on the map for tagged pages
402 #osm_tag_default_icon: icon.png
403 # Url for the OpenLayers.js file
404 #osm_openlayers_url: http://www.openlayers.org/api/OpenLayers.js
405 # Layers to use in the map. Can be either the 'OSM' string or a type option for Google maps (GoogleNormal, GoogleSatellite, GoogleHybrid or GooglePhysical). It can also be an arbitrary URL in a syntax acceptable for OpenLayers.Layer.OSM.url parameter.
407 # OSM: GoogleSatellite
408 # Google maps API key, Google layer not used if missing, see https://code.google.com/apis/console/ to get an API key
409 #osm_google_apikey: ''
412 # extra underlay directories to add
414 #- /home/b-ikiwiki/wiki.underlay
416 ######################################################################
418 # (404, attachment, comments, editdiff, edittemplate, getsource, google,
419 # goto, mirrorlist, remove, rename, repolist, search, theme, userlist,
421 ######################################################################
424 # enhanced PageSpec specifying what attachments are allowed
425 allowed_attachments: admin() and virusfree()
426 # virus checker program (reads STDIN, returns nonzero if virus found)
427 virus_checker: clamdscan -
430 # PageSpec of pages where comments are allowed
431 comments_pagespec: forum/* and !*/Discussion
432 # PageSpec of pages where posting new comments is not allowed
433 comments_closed_pagespec: ''
434 # Base name for comments, e.g. "comment_" for pages like "sandbox/comment_12"
435 comments_pagename: comment_
436 # Interpret directives in comments?
437 #comments_allowdirectives: 0
438 # Allow anonymous commenters to set an author name?
439 comments_allowauthor: 0
440 # commit comments to the VCS
442 # Restrict formats for comments to (no restriction if empty)
443 comments_allowformats: ''
446 # Mime type for returned source.
447 #getsource_mimetype: text/plain; charset=utf-8
452 # generate links that point to the mirrors' ikiwiki CGI
453 #mirrorlist_use_cgi: 1
456 # URIs of repositories containing the wiki's source
458 - ssh://b-ikiwiki@ikiwiki.branchable.com/
459 - git://ikiwiki.branchable.com/
462 # path to the omega cgi program
463 omega_cgi: /usr/lib/cgi-bin/omega/omega
464 # use google site search rather than internal xapian index?
468 # name of theme to enable
472 # list of plugins that cannot be enabled/disabled via the web interface
473 websetup_force_plugins:
478 # list of additional setup field keys to treat as unsafe
489 # show unsafe settings, read-only, in web interface?
490 websetup_show_unsafe: 0
492 ######################################################################
494 # (calendar, color, conditional, cutpaste, date, format, fortune,
495 # graphviz, haiku, headinganchors, img, linkmap, listdirectives, map,
496 # more, orphans, pagecount, pagestats, poll, polygen, postsparkline,
497 # progress, shortcut, sparkline, table, template, teximg, toc, toggle,
499 ######################################################################
502 # base of the archives hierarchy
503 #archivebase: archives
504 # PageSpec of pages to include in the archives, if option `calendar_autocreate` is true.
505 #archive_pagespec: page(posts/*) and !*/Discussion
506 # autocreate new calendar pages?
507 #calendar_autocreate: 1
508 # if set, when building calendar pages, also build pages of year and month when no pages were published (building empty calendars).
509 #calendar_fill_gaps: 1
511 # listdirectives plugin
512 # directory in srcdir that contains directive descriptions
513 directive_description_dir: ikiwiki/directive
516 # Should teximg use dvipng to render, or dvips and convert?
518 # LaTeX prefix for teximg plugin
519 #teximg_prefix: '\documentclass{article}
521 # \usepackage[utf8]{inputenc}
523 # \usepackage{amsmath}
525 # \usepackage{amsfonts}
527 # \usepackage{amssymb}
534 # LaTeX postfix for teximg plugin
535 #teximg_postfix: \end{document}
537 ######################################################################
539 # (aggregate, autoindex, brokenlinks, camelcase, ddate, embed, favicon,
540 # filecheck, flattr, goodstuff, htmlbalance, localstyle, loginselector,
541 # missingsite, notifyemail, pagetemplate, parked, pingee, pinger,
542 # prettydate, recentchanges, recentchangesdiff, relativedate, rsync,
543 # sidebar, smiley, sortnaturally, tag, testpagespec, trail, transient,
545 ######################################################################
548 # enable aggregation to internal pages?
550 # allow aggregation to be triggered via the web?
551 #aggregate_webtrigger: 0
554 # commit autocreated index pages
558 # list of words to not turn into links
559 #camelcase_ignore: []
562 # userid or user name to use by default for Flattr buttons
563 #flattr_userid: joeyh
566 # An optional message explaining why this site is parked.
570 # how many seconds to try pinging before timing out
574 # format to use to display date
575 prettydateformat: '%X, %B %o, %Y'
577 # recentchanges plugin
578 # name of the recentchanges page
579 recentchangespage: recentchanges
580 # number of changes to track
581 recentchangesnum: 100
584 # command to run to sync updated pages
585 #rsync_command: rsync -qa --delete . user@host:/path/to/docroot/
588 # show sidebar page on all pages?
592 # parent page tags are located under
594 # autocreate new tag pages?
596 # commit autocreated tag pages
597 tag_autocreate_commit: 1
600 # Text::Typography attributes value
601 #typographyattributes: 3