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