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