]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blob - ikiwiki.setup
b64b3cd525b2df8cc1c41b5264c8d8be6495c99d
[git.ikiwiki.info.git] / ikiwiki.setup
1 # IkiWiki::Setup::Yaml - YAML formatted setup file
2 #
3 # Setup file for ikiwiki.
4
5 # Passing this to ikiwiki --setup will make ikiwiki generate
6 # wrappers and build the wiki.
7
8 # Remember to re-run ikiwiki --setup any time you edit this file.
9 #
10 # name of the wiki
11 wikiname: ikiwiki
12 # contact email for wiki
13 adminemail: joey@ikiwiki.info
14 # users who are wiki admins
15 adminuser:
16 - http://joey.kitenet.net/
17 - http://joeyh.name/
18 # users who are banned from the wiki
19 banned_users:
20 - http://tonyguards.myopenid.com/
21 - http://butoijoh.myopenid.com/
22 - ip(62.219.8.238)
23 - ip(184.105.146.11)
24 - ip(184.105.146.6)
25 - ip(149.135.147.88)
26 - https://www.google.com/accounts/o8/id?id=AItOawnAq_X98v6qKJFwl-MyLb440vC8laTdiMg
27 - https://www.google.com/accounts/o8/id?id=AItOawm_nWF_tPw8mLI7rMxfykA_d3FehQNvWpI
28 - https://www.google.com/accounts/o8/id?id=AItOawkTn3HixU2KJIvvLXLqwYUzlDGDtYf43GE
29 - https://www.google.com/accounts/o8/id?id=AItOawkDOCT-KTCLpieip-2W0N51gZwF7nGLaS0
30 - https://www.google.com/accounts/o8/id?id=AItOawl8-V-Yp0F5ZWRmDb7j4ul1gsbMXjghDIU
31 - https://www.google.com/accounts/o8/id?id=AItOawkaL6e6GtpyD7gJyqHphon_5ES1ACDLJgg
32 - https://www.google.com/accounts/o8/id?id=AItOawnv-w7GplWln2P55lnzc6Ds-ltzk6sNxDY
33 - https://me.yahoo.com/a/3hUnH9Qi24uk3RwCwHATJBWKVyqc#7d8b8
34 - ip(95.65.50.150)
35 - https://me.yahoo.com/a/2.Pjpm0G0Z6F9LiGW4cYO84pIrb.Lg--#137de
36 - https://www.google.com/accounts/o8/id?id=AItOawkuR0eo_HO1s1hs49h0Y_4Bzm08l9evMEc
37 - https://www.google.com/accounts/o8/id?id=AItOawlYXeKSEBoSCzES7o5VYiSratG5RfNucL0
38 - https://www.google.com/accounts/o8/id?id=AItOawl_wuvPHDhkuMVnEOP5jLrZyd3nnBs8YRw
39 - ip(115.43.30.149)
40 - ikiwikiweb
41 - webkatalog
42 - ip(117.201.35.183)
43 - adrianna
44 - ip(94.179.251.118)
45 - capitaine
46 - ip(74.63.117.196)
47 - ip(74.63.117.195)
48 - testerer
49 - ip(86.103.200.90)
50 - AlbertF
51 - ip(71.132.208.155)
52 - MariaJackson
53 - ip(208.75.10.42)
54 - HelenOliver
55 - ip(222.127.197.140)
56 - GraceTemplman46
57 - diannetyron
58 - ip(119.111.124.194)
59 - http://cmelbye.myopenid.com/
60 - autobahnned
61 - icerain321
62 - shoesorder
63 - AdamMeyars
64 - essaywriter
65 - blahgrad
66 - alicia.warner
67 - WikiJeanHawkins
68 - nicole.adams
69 - Smith
70 - quentin
71 - quentinfudge
72 - https://www.google.com/accounts/o8/id?id=AItOawkJHb27RVmw93kqyzfoxZWNKjqR8MEVt3A
73 - ip(123.26.115.218)
74 - https://www.google.com/accounts/o8/id?id=AItOawkljravtnjpauReS81ng5zVurZx_thpse8
75 - ip(123.26.124.157)
76 - KataMutiara
77 - tekschen
78 - webschen1
79 - ip(79.228.*.*)
80 - soman81
81 - ip(31.17.11.19)
82 - spain1001
83 - ip(80.187.*.*)
84 - Toni
85 - ip(124.105.173.121)
86 - domtheo9110
87 - https://www.google.com/accounts/o8/id?id=AItOawnO6NxsiqDMNHCMugqNKPwCWmTAQ7v_2Fs
88 - ip(58.186.127.104)
89 - https://pypi.python.org/id/tlevine
90 - ip(82.153.13.48)
91 - https://me.yahoo.com/a/FQMi.N5i0IzdnUgI0Ite4hPzi5Teukf.wOGAiQ--#4e81f
92 - ip(122.173.219.54)
93 # where the source of the wiki is located
94 srcdir: /home/b-ikiwiki/source/doc
95 # where to build the wiki
96 destdir: /home/b-ikiwiki/public_html
97 # base url to the wiki
98 url: http://ikiwiki.info
99 # url to the ikiwiki.cgi
100 cgiurl: http://ikiwiki.info/ikiwiki.cgi
101 # filename of cgi wrapper to generate
102 cgi_wrapper: /var/www/b-ikiwiki/ikiwiki.cgi
103 # mode for cgi_wrapper (can safely be made suid)
104 cgi_wrappermode: 0755
105 # number of seconds to delay CGI requests when overloaded
106 cgi_overload_delay: ''
107 # message to display when overloaded (may contain html)
108 cgi_overload_message: ''
109 # enable optimization of only refreshing committed changes?
110 only_committed_changes: 0
111 # rcs backend to use
112 rcs: git
113 # plugins to add to the default configuration
114 add_plugins:
115 - sidebar
116 - goodstuff
117 - websetup
118 - table
119 - haiku
120 - html
121 - polygen
122 - fortune
123 - linkmap
124 - favicon
125 - poll
126 - postsparkline
127 - sparkline
128 - version
129 - testpagespec
130 - edittemplate
131 - recentchangesdiff
132 - 404
133 - ikiwikihosting
134 - branchable
135 - recentchangesdiff
136 - attachment
137 - remove
138 - rename
139 - edittemplate
140 - favicon
141 - format
142 - fortune
143 - highlight
144 - listdirectives
145 - poll
146 - progress
147 - relativedate
148 - search
149 - testpagespec
150 - version
151 - theme
152 - repolist
153 - highlight
154 - comments
155 - gitpush
156 - blogspam
157 # plugins to disable
158 disable_plugins: []
159 # additional directory to search for template files
160 templatedir: /usr/share/ikiwiki/templates
161 # base wiki source location
162 underlaydir: /usr/share/ikiwiki/basewiki
163 # display verbose messages?
164 #verbose: 1
165 # log to syslog?
166 syslog: 1
167 # create output files named page/index.html?
168 usedirs: 1
169 # use '!'-prefixed preprocessor directives?
170 prefix_directives: 1
171 # use page/index.mdwn source files
172 indexpages: 0
173 # enable Discussion pages?
174 discussion: 1
175 # name of Discussion pages
176 discussionpage: Discussion
177 # generate HTML5?
178 html5: 0
179 # only send cookies over SSL connections?
180 sslcookie: 0
181 # extension to use for new pages
182 default_pageext: mdwn
183 # extension to use for html files
184 htmlext: html
185 # strftime format string to display date
186 timeformat: '%c'
187 # UTF-8 locale to use
188 #locale: en_US.UTF-8
189 # put user pages below specified page
190 userdir: users
191 # how many backlinks to show before hiding excess (0 to show all)
192 numbacklinks: 10
193 # attempt to hardlink source files? (optimisation for large files)
194 hardlink: 1
195 # force ikiwiki to use a particular umask (keywords public, group or private, or a number)
196 #umask: public
197 # group for wrappers to run in
198 #wrappergroup: ikiwiki
199 # extra library and plugin directory
200 libdir: /home/b-ikiwiki/.ikiwiki
201 # environment variables
202 ENV:
203   TMPDIR: /home/b-ikiwiki/tmp
204 # time zone name
205 timezone: JEST+4
206 # regexp of normally excluded files to include
207 #include: ^\.htaccess$
208 # regexp of files that should be skipped
209 #exclude: ^(*\.private|Makefile)$
210 # specifies the characters that are allowed in source filenames
211 wiki_file_chars: -[:alnum:]+/.:_
212 # allow symlinks in the path leading to the srcdir (potentially insecure)
213 allow_symlinks_before_srcdir: 0
214 # cookie control
215 cookiejar:
216   file: /home/b-ikiwiki/.ikiwiki/cookies
218 ######################################################################
219 # core plugins
220 #   (branchable, editpage, git, gitpush, htmlscrubber, ikiwikihosting,
221 #    inline, link, meta, parentlinks)
222 ######################################################################
224 # branchable plugin
225 # Allow anyone to branch, check out, and copy this site?
226 branchable: 1
227 # Allow anyone to git push verified changes to this site?
228 anonpush: 1
229 # Display "Branchable" link on action bar?
230 branchable_action: 1
232 # git plugin
233 # git hook to generate
234 git_wrapper: /home/b-ikiwiki/source.git/hooks/post-update
235 # shell command for git_wrapper to run, in the background
236 #git_wrapper_background_command: git push github
237 # mode for git_wrapper (can safely be made suid)
238 git_wrappermode: 6755
239 # git pre-receive hook to generate
240 git_test_receive_wrapper: /home/b-ikiwiki/source.git/hooks/pre-receive
241 # unix users whose commits should be checked by the pre-receive hook
242 untrusted_committers:
243 - ikiwiki-anon
244 # gitweb url to show file history ([[file]] substituted)
245 historyurl: http://source.ikiwiki.branchable.com/?p=source.git;a=history;f=doc/[[file]];hb=HEAD
246 # gitweb url to show a diff ([[file]], [[sha1_to]], [[sha1_from]], [[sha1_commit]], and [[sha1_parent]] substituted)
247 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]]
248 # where to pull and push changes (set to empty string to disable)
249 gitorigin_branch: origin
250 # branch that the wiki is stored in
251 gitmaster_branch: master
253 # gitpush plugin
254 # git repository urls that changes are pushed to
255 git_push_to:
256 - git@github.com:joeyh/ikiwiki.git
257 - joey@git.kitenet.net:/srv/git/ikiwiki.git
259 # htmlscrubber plugin
260 # PageSpec specifying pages not to scrub
261 htmlscrubber_skip: tipjar
263 # ikiwikihosting plugin
264 # list of urls that alias to the main url
265 urlalias:
266 - http://ikiwiki.branchable.com/
267 - http://ikiwiki.branchable.com/
268 - http://git.ikiwiki.info/
269 - http://www.ikiwiki.info/
270 # openid of primary site owner
271 owner: http://joey.kitenet.net/
272 # optional hostname of site this one was branched from
273 #parent: ''
274 # internal hostname of this site
275 hostname: ikiwiki.branchable.com
276 # site creation datestamp
277 created: 1305836524
278 # how many days to retain logs
279 #log_period: 7
280 # disable IPv6?
281 ipv6_disabled: 0
283 # inline plugin
284 # enable rss feeds by default?
285 rss: 1
286 # enable atom feeds by default?
287 atom: 0
288 # allow rss feeds to be used?
289 #allowrss: 0
290 # allow atom feeds to be used?
291 allowatom: 1
292 # urls to ping (using XML-RPC) on feed update
293 pingurl: []
295 ######################################################################
296 # auth plugins
297 #   (anonok, blogspam, httpauth, lockedit, moderatedcomments,
298 #    opendiscussion, openid, passwordauth, signinedit)
299 ######################################################################
301 # anonok plugin
302 # PageSpec to limit which pages anonymous users can edit
303 #anonok_pagespec: '*/discussion'
305 # blogspam plugin
306 # PageSpec of pages to check for spam
307 blogspam_pagespec: '*'
308 # options to send to blogspam server
309 #blogspam_options: blacklist=1.2.3.4,blacklist=8.7.6.5,max-links=10
310 # blogspam server XML-RPC url
311 #blogspam_server: ''
313 # httpauth plugin
314 # url to redirect to when authentication is needed
315 #cgiauthurl: http://example.com/wiki/auth/ikiwiki.cgi
316 # PageSpec of pages where only httpauth will be used for authentication
317 #httpauth_pagespec: '!*/Discussion'
319 # lockedit plugin
320 # PageSpec controlling which pages are locked
321 locked_pages: tipjar or tips/DreamHost
323 # moderatedcomments plugin
324 # PageSpec matching users or comment locations to moderate
325 #moderate_pagespec: '*'
327 # openid plugin
328 # url pattern of openid realm (default is cgiurl)
329 #openid_realm: ''
330 # url to ikiwiki cgi to use for openid authentication (default is cgiurl)
331 #openid_cgiurl: ''
333 # passwordauth plugin
334 # a password that must be entered when signing up for an account
335 #account_creation_password: s3cr1t
336 # cost of generating a password using Authen::Passphrase::BlowfishCrypt
337 #password_cost: 8
339 ######################################################################
340 # format plugins
341 #   (creole, highlight, hnb, html, mdwn, otl, po, rawhtml, rst, textile,
342 #    txt)
343 ######################################################################
345 # highlight plugin
346 # types of source files to syntax highlight
347 tohighlight: .c .h .cpp .pl .py Makefile:make
348 # location of highlight's filetypes.conf
349 filetypes_conf: /etc/highlight/filetypes.conf
350 # location of highlight's langDefs directory
351 langdefdir: /usr/share/highlight/langDefs
353 # mdwn plugin
354 # enable multimarkdown features?
355 #multimarkdown: 0
356 # disable use of markdown discount?
357 #nodiscount: 0
359 # po plugin
360 # master language (non-PO files)
361 #po_master_language: en|English
362 # slave languages (translated via PO files) format: ll|Langname
363 #po_slave_languages:
364 #- fr|Français
365 #- es|Español
366 #- de|Deutsch
367 # PageSpec controlling which pages are translatable
368 po_translatable_pages: ''
369 # internal linking behavior (default/current/negotiated)
370 po_link_to: default
372 ######################################################################
373 # special-purpose plugins
374 #   (osm, underlay)
375 ######################################################################
377 # osm plugin
378 # the default zoom when you click on the map link
379 #osm_default_zoom: 15
380 # the icon shown on links and on the main map
381 #osm_default_icon: ikiwiki/images/osm.png
382 # the alt tag of links, defaults to empty
383 #osm_alt: ''
384 # the output format for waypoints, can be KML, GeoJSON or CSV (one or many, comma-separated)
385 #osm_format: KML
386 # the icon attached to a tag, displayed on the map for tagged pages
387 #osm_tag_default_icon: icon.png
388 # Url for the OpenLayers.js file
389 #osm_openlayers_url: http://www.openlayers.org/api/OpenLayers.js
390 # 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.
391 #osm_layers:
392 #  OSM: GoogleSatellite
393 # Google maps API key, Google layer not used if missing, see https://code.google.com/apis/console/ to get an API key
394 #osm_google_apikey: ''
396 # underlay plugin
397 # extra underlay directories to add
398 #add_underlays:
399 #- /home/b-ikiwiki/wiki.underlay
401 ######################################################################
402 # web plugins
403 #   (404, attachment, comments, editdiff, edittemplate, getsource, google,
404 #    goto, mirrorlist, remove, rename, repolist, search, theme, userlist,
405 #    websetup, wmd)
406 ######################################################################
408 # attachment plugin
409 # enhanced PageSpec specifying what attachments are allowed
410 allowed_attachments: admin() and virusfree()
411 # virus checker program (reads STDIN, returns nonzero if virus found)
412 virus_checker: clamdscan -
414 # comments plugin
415 # PageSpec of pages where comments are allowed
416 comments_pagespec: forum/* and !*/Discussion
417 # PageSpec of pages where posting new comments is not allowed
418 comments_closed_pagespec: ''
419 # Base name for comments, e.g. "comment_" for pages like "sandbox/comment_12"
420 comments_pagename: comment_
421 # Interpret directives in comments?
422 #comments_allowdirectives: 0
423 # Allow anonymous commenters to set an author name?
424 comments_allowauthor: 0
425 # commit comments to the VCS
426 comments_commit: 1
427 # Restrict formats for comments to (no restriction if empty)
428 comments_allowformats: ''
430 # getsource plugin
431 # Mime type for returned source.
432 #getsource_mimetype: text/plain; charset=utf-8
434 # mirrorlist plugin
435 # list of mirrors
436 #mirrorlist: {}
437 # generate links that point to the mirrors' ikiwiki CGI
438 #mirrorlist_use_cgi: 1
440 # repolist plugin
441 # URIs of repositories containing the wiki's source
442 repositories:
443 - ssh://b-ikiwiki@ikiwiki.branchable.com/
444 - git://ikiwiki.branchable.com/
446 # search plugin
447 # path to the omega cgi program
448 omega_cgi: /usr/lib/cgi-bin/omega/omega
449 # use google site search rather than internal xapian index?
450 google_search: 1
452 # theme plugin
453 # name of theme to enable
454 #theme: actiontabs
456 # websetup plugin
457 # list of plugins that cannot be enabled/disabled via the web interface
458 websetup_force_plugins:
459 - httpauth
460 - openid
461 - mdwn
462 - wmd
463 # list of additional setup field keys to treat as unsafe
464 websetup_unsafe:
465 - url
466 - cgiurl
467 - verbose
468 - syslog
469 - usedirs
470 - prefix_directives
471 - indexpages
472 - repositories
473 - sslcookie
474 # show unsafe settings, read-only, in web interface?
475 websetup_show_unsafe: 0
477 ######################################################################
478 # widget plugins
479 #   (calendar, color, conditional, cutpaste, date, format, fortune,
480 #    graphviz, haiku, headinganchors, img, linkmap, listdirectives, map,
481 #    more, orphans, pagecount, pagestats, poll, polygen, postsparkline,
482 #    progress, shortcut, sparkline, table, template, teximg, toc, toggle,
483 #    version)
484 ######################################################################
486 # calendar plugin
487 # base of the archives hierarchy
488 #archivebase: archives
489 # PageSpec of pages to include in the archives; used by ikiwiki-calendar command
490 #archive_pagespec: page(posts/*) and !*/Discussion
492 # listdirectives plugin
493 # directory in srcdir that contains directive descriptions
494 directive_description_dir: ikiwiki/directive
496 # teximg plugin
497 # Should teximg use dvipng to render, or dvips and convert?
498 #teximg_dvipng: ''
499 # LaTeX prefix for teximg plugin
500 #teximg_prefix: '\documentclass{article}
502 #  \usepackage[utf8]{inputenc}
504 #  \usepackage{amsmath}
506 #  \usepackage{amsfonts}
508 #  \usepackage{amssymb}
510 #  \pagestyle{empty}
512 #  \begin{document}
514 #'
515 # LaTeX postfix for teximg plugin
516 #teximg_postfix: \end{document}
518 ######################################################################
519 # other plugins
520 #   (aggregate, autoindex, brokenlinks, camelcase, ddate, embed, favicon,
521 #    filecheck, flattr, goodstuff, htmlbalance, localstyle, missingsite,
522 #    notifyemail, pagetemplate, parked, pingee, pinger, prettydate,
523 #    recentchanges, recentchangesdiff, relativedate, rsync, sidebar,
524 #    smiley, sortnaturally, tag, testpagespec, trail, transient, typography)
525 ######################################################################
527 # aggregate plugin
528 # enable aggregation to internal pages?
529 aggregateinternal: 1
530 # allow aggregation to be triggered via the web?
531 #aggregate_webtrigger: 0
533 # autoindex plugin
534 # commit autocreated index pages
535 autoindex_commit: 1
537 # camelcase plugin
538 # list of words to not turn into links
539 #camelcase_ignore: []
541 # flattr plugin
542 # userid or user name to use by default for Flattr buttons
543 #flattr_userid: joeyh
545 # parked plugin
546 # An optional message explaining why this site is parked.
547 #parked_message: ''
549 # pinger plugin
550 # how many seconds to try pinging before timing out
551 #pinger_timeout: 15
553 # prettydate plugin
554 # format to use to display date
555 prettydateformat: '%X, %B %o, %Y'
557 # recentchanges plugin
558 # name of the recentchanges page
559 recentchangespage: recentchanges
560 # number of changes to track
561 recentchangesnum: 100
563 # rsync plugin
564 # command to run to sync updated pages
565 #rsync_command: rsync -qa --delete . user@host:/path/to/docroot/
567 # sidebar plugin
568 # show sidebar page on all pages?
569 global_sidebars: 0
571 # tag plugin
572 # parent page tags are located under
573 #tagbase: tag
574 # autocreate new tag pages?
575 #tag_autocreate: 1
576 # commit autocreated tag pages
577 tag_autocreate_commit: 1
579 # typography plugin
580 # Text::Typography attributes value
581 #typographyattributes: 3