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