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