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