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