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