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