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 - https://me.yahoo.com/a/7bUPkZg.gdHGMU8azO0bnVfS23aU5iT7h263LhiVB3r9j6W_yUR9lX1Ia6UJfs247nNtKGg-*
100 # where the source of the wiki is located
101 srcdir: /home/b-ikiwiki/source/doc
102 # where to build the wiki
103 destdir: /home/b-ikiwiki/public_html
104 # base url to the wiki
105 url: http://ikiwiki.info
106 # url to the ikiwiki.cgi
107 cgiurl: http://ikiwiki.info/ikiwiki.cgi
108 # do not adjust cgiurl if CGI is accessed via different URL
110 # filename of cgi wrapper to generate
111 cgi_wrapper: /var/www/b-ikiwiki/ikiwiki.cgi
112 # mode for cgi_wrapper (can safely be made suid)
113 cgi_wrappermode: 0755
114 # number of seconds to delay CGI requests when overloaded
115 cgi_overload_delay: ''
116 # message to display when overloaded (may contain html)
117 cgi_overload_message: Please wait..
118 # enable optimization of only refreshing committed changes?
119 only_committed_changes: 0
122 # plugins to add to the default configuration
168 # additional directory to search for template files
169 templatedir: /usr/share/ikiwiki/templates
170 # base wiki source location
171 underlaydir: /usr/share/ikiwiki/basewiki
172 # display verbose messages?
176 # create output files named page/index.html?
178 # use '!'-prefixed preprocessor directives?
180 # use page/index.mdwn source files
182 # enable Discussion pages?
184 # name of Discussion pages
185 discussionpage: Discussion
186 # use elements new in HTML5 like <section>?
188 # only send cookies over SSL connections?
190 # extension to use for new pages
191 default_pageext: mdwn
192 # extension to use for html files
194 # strftime format string to display date
196 # UTF-8 locale to use
198 # put user pages below specified page
200 # how many backlinks to show before hiding excess (0 to show all)
202 # attempt to hardlink source files? (optimisation for large files)
204 # force ikiwiki to use a particular umask (keywords public, group or private, or a number)
206 # group for wrappers to run in
207 #wrappergroup: ikiwiki
208 # extra library and plugin directories
210 # extra library and plugin directory (searched after libdirs)
211 libdir: /home/b-ikiwiki/.ikiwiki
212 # environment variables
214 TMPDIR: /home/b-ikiwiki/tmp
217 # regexp of normally excluded files to include
218 #include: ^\.htaccess$
219 # regexp of files that should be skipped
220 #exclude: ^(*\.private|Makefile)$
221 # specifies the characters that are allowed in source filenames
222 wiki_file_chars: -[:alnum:]+/.:_
223 # allow symlinks in the path leading to the srcdir (potentially insecure)
224 allow_symlinks_before_srcdir: 0
227 file: /home/b-ikiwiki/.ikiwiki/cookies
228 # set custom user agent string for outbound HTTP requests e.g. when fetching aggregated RSS feeds
229 useragent: ikiwiki/3.20150330
230 # theme has a responsive layout? (mobile-optimized)
232 # try harder to produce deterministic output
235 ######################################################################
237 # (branchable, editpage, git, gitpush, htmlscrubber, ikiwikihosting,
238 # inline, link, meta, parentlinks, templatebody)
239 ######################################################################
242 # Allow anyone to branch, check out, and copy this site?
244 # Allow anyone to git push verified changes to this site?
246 # Display "Branchable" link on action bar?
250 # git hook to generate
251 git_wrapper: /home/b-ikiwiki/source.git/hooks/post-update
252 # shell command for git_wrapper to run, in the background
253 #git_wrapper_background_command: git push github
254 # mode for git_wrapper (can safely be made suid)
255 git_wrappermode: 6755
256 # git pre-receive hook to generate
257 git_test_receive_wrapper: /home/b-ikiwiki/source.git/hooks/pre-receive
258 # unix users whose commits should be checked by the pre-receive hook
259 untrusted_committers:
261 # gitweb url to show file history ([[file]] substituted)
262 historyurl: http://source.ikiwiki.branchable.com/?p=source.git;a=history;f=doc/[[file]];hb=HEAD
263 # gitweb url to show a diff ([[file]], [[sha1_to]], [[sha1_from]], [[sha1_commit]], and [[sha1_parent]] substituted)
264 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]]
265 # where to pull and push changes (set to empty string to disable)
266 gitorigin_branch: origin
267 # branch that the wiki is stored in
268 gitmaster_branch: master
271 # git repository urls that changes are pushed to
273 - git@github.com:joeyh/ikiwiki.git
274 - joey@git.kitenet.net:/srv/git/ikiwiki.git
276 # htmlscrubber plugin
277 # PageSpec specifying pages not to scrub
278 htmlscrubber_skip: tipjar
280 # ikiwikihosting plugin
281 # list of urls that alias to the main url
283 - http://ikiwiki.branchable.com/
284 - http://ikiwiki.branchable.com/
285 - http://git.ikiwiki.info/
286 - http://www.ikiwiki.info/
287 # openid or email of primary site owner
288 owner: http://joey.kitenet.net/
289 # optional hostname of site this one was branched from
291 # internal hostname of this site
292 hostname: ikiwiki.branchable.com
293 # site creation datestamp
295 # how many days to retain logs
299 # redirect from http to https?
303 # enable rss feeds by default?
305 # enable atom feeds by default?
307 # allow rss feeds to be used?
309 # allow atom feeds to be used?
311 # urls to ping (using XML-RPC) on feed update
314 ######################################################################
316 # (anonok, blogspam, emailauth, httpauth, lockedit, moderatedcomments,
317 # opendiscussion, openid, passwordauth, signinedit)
318 ######################################################################
321 # PageSpec to limit which pages anonymous users can edit
322 #anonok_pagespec: '*/discussion'
325 # PageSpec of pages to check for spam
326 blogspam_pagespec: '*'
327 # options to send to blogspam server
328 #blogspam_options: blacklist=1.2.3.4,blacklist=8.7.6.5,max-links=10
329 # blogspam server JSON url
333 # email address to send emailauth mails as (default: adminemail)
334 emailauth_sender: login@branchable.com
337 # url to redirect to when authentication is needed
338 #cgiauthurl: http://example.com/wiki/auth/ikiwiki.cgi
339 # PageSpec of pages where only httpauth will be used for authentication
340 #httpauth_pagespec: '!*/Discussion'
343 # PageSpec controlling which pages are locked
344 locked_pages: tipjar or tips/DreamHost
346 # moderatedcomments plugin
347 # PageSpec matching users or comment locations to moderate
348 #moderate_pagespec: '*'
351 # url pattern of openid realm (default is cgiurl)
353 # url to ikiwiki cgi to use for openid authentication (default is cgiurl)
356 # passwordauth plugin
357 # a password that must be entered when signing up for an account
358 #account_creation_password: s3cr1t
359 # cost of generating a password using Authen::Passphrase::BlowfishCrypt
362 ######################################################################
364 # (creole, highlight, hnb, html, mdwn, otl, po, rawhtml, rst, textile,
366 ######################################################################
369 # types of source files to syntax highlight
370 tohighlight: .c .h .cpp .pl .py Makefile:make
371 # location of highlight's filetypes.conf
372 filetypes_conf: /etc/highlight/filetypes.conf
373 # location of highlight's langDefs directory
374 langdefdir: /usr/share/highlight/langDefs
377 # enable multimarkdown features?
379 # disable use of markdown discount?
383 # master language (non-PO files)
384 #po_master_language: en|English
385 # slave languages (translated via PO files) format: ll|Langname
390 # PageSpec controlling which pages are translatable
391 po_translatable_pages: ''
392 # internal linking behavior (default/current/negotiated)
395 ######################################################################
396 # special-purpose plugins
398 ######################################################################
401 # the default zoom when you click on the map link
402 #osm_default_zoom: 15
403 # the icon shown on links and on the main map
404 #osm_default_icon: ikiwiki/images/osm.png
405 # the alt tag of links, defaults to empty
407 # the output format for waypoints, can be KML, GeoJSON or CSV (one or many, comma-separated)
409 # the icon attached to a tag, displayed on the map for tagged pages
410 #osm_tag_default_icon: icon.png
411 # Url for the OpenLayers.js file
412 #osm_openlayers_url: http://www.openlayers.org/api/OpenLayers.js
413 # 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.
415 # OSM: GoogleSatellite
416 # Google maps API key, Google layer not used if missing, see https://code.google.com/apis/console/ to get an API key
417 #osm_google_apikey: ''
420 # extra underlay directories to add
422 #- /home/b-ikiwiki/wiki.underlay
424 ######################################################################
426 # (404, attachment, comments, editdiff, edittemplate, getsource, google,
427 # goto, mirrorlist, remove, rename, repolist, search, theme, userlist,
429 ######################################################################
432 # enhanced PageSpec specifying what attachments are allowed
433 allowed_attachments: admin() and virusfree()
434 # virus checker program (reads STDIN, returns nonzero if virus found)
435 virus_checker: clamdscan -
438 # PageSpec of pages where comments are allowed
439 comments_pagespec: forum/* and !*/Discussion
440 # PageSpec of pages where posting new comments is not allowed
441 comments_closed_pagespec: ''
442 # Base name for comments, e.g. "comment_" for pages like "sandbox/comment_12"
443 comments_pagename: comment_
444 # Interpret directives in comments?
445 #comments_allowdirectives: 0
446 # Allow anonymous commenters to set an author name?
447 comments_allowauthor: 0
448 # commit comments to the VCS
450 # Restrict formats for comments to (no restriction if empty)
451 comments_allowformats: ''
454 # Mime type for returned source.
455 #getsource_mimetype: text/plain; charset=utf-8
460 # generate links that point to the mirrors' ikiwiki CGI
461 #mirrorlist_use_cgi: 1
464 # URIs of repositories containing the wiki's source
466 - ssh://b-ikiwiki@ikiwiki.branchable.com/
467 - git://ikiwiki.branchable.com/
470 # path to the omega cgi program
471 omega_cgi: /usr/lib/cgi-bin/omega/omega
472 # use google site search rather than internal xapian index?
476 # name of theme to enable
480 # list of plugins that cannot be enabled/disabled via the web interface
481 websetup_force_plugins:
486 # list of additional setup field keys to treat as unsafe
497 # show unsafe settings, read-only, in web interface?
498 websetup_show_unsafe: 0
500 ######################################################################
502 # (calendar, color, conditional, cutpaste, date, format, fortune,
503 # graphviz, haiku, headinganchors, img, linkmap, listdirectives, map,
504 # more, orphans, pagecount, pagestats, poll, polygen, postsparkline,
505 # progress, shortcut, sparkline, table, template, teximg, toc, toggle,
507 ######################################################################
510 # base of the archives hierarchy
511 #archivebase: archives
512 # PageSpec of pages to include in the archives, if option `calendar_autocreate` is true.
513 #archive_pagespec: page(posts/*) and !*/Discussion
514 # autocreate new calendar pages?
515 #calendar_autocreate: 1
516 # if set, when building calendar pages, also build pages of year and month when no pages were published (building empty calendars).
517 #calendar_fill_gaps: 1
519 # listdirectives plugin
520 # directory in srcdir that contains directive descriptions
521 directive_description_dir: ikiwiki/directive
524 # Should teximg use dvipng to render, or dvips and convert?
526 # LaTeX prefix for teximg plugin
527 #teximg_prefix: '\documentclass{article}
529 # \usepackage[utf8]{inputenc}
531 # \usepackage{amsmath}
533 # \usepackage{amsfonts}
535 # \usepackage{amssymb}
542 # LaTeX postfix for teximg plugin
543 #teximg_postfix: \end{document}
545 ######################################################################
547 # (aggregate, autoindex, brokenlinks, camelcase, ddate, embed, favicon,
548 # filecheck, flattr, goodstuff, htmlbalance, localstyle, loginselector,
549 # missingsite, notifyemail, pagetemplate, parked, pingee, pinger,
550 # prettydate, recentchanges, recentchangesdiff, relativedate, rsync,
551 # sidebar, smiley, sortnaturally, tag, testpagespec, trail, transient,
553 ######################################################################
556 # enable aggregation to internal pages?
558 # allow aggregation to be triggered via the web?
559 #aggregate_webtrigger: 0
562 # commit autocreated index pages
566 # list of words to not turn into links
567 #camelcase_ignore: []
570 # userid or user name to use by default for Flattr buttons
571 #flattr_userid: joeyh
574 # An optional message explaining why this site is parked.
578 # how many seconds to try pinging before timing out
582 # format to use to display date
583 prettydateformat: '%X, %B %o, %Y'
585 # recentchanges plugin
586 # name of the recentchanges page
587 recentchangespage: recentchanges
588 # number of changes to track
589 recentchangesnum: 100
592 # command to run to sync updated pages
593 #rsync_command: rsync -qa --delete . user@host:/path/to/docroot/
596 # show sidebar page on all pages?
600 # parent page tags are located under
602 # autocreate new tag pages?
604 # commit autocreated tag pages
605 tag_autocreate_commit: 1
608 # Text::Typography attributes value
609 #typographyattributes: 3