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