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