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