]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blob - ikiwiki.setup
38f10573921fbf5d4098df5e6d70579fd7dc90bc
[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: admin@branchable.com
14 # users who are wiki admins
15 adminuser:
16 - http://joey.kitenet.net/
17 - http://joeyh.name/
18 - smcv
19 # users who are banned from the wiki
20 banned_users:
21 - http://tonyguards.myopenid.com/
22 - http://butoijoh.myopenid.com/
23 - ip(62.219.8.238)
24 - ip(184.105.146.11)
25 - ip(184.105.146.6)
26 - ip(149.135.147.88)
27 - https://www.google.com/accounts/o8/id?id=AItOawnAq_X98v6qKJFwl-MyLb440vC8laTdiMg
28 - https://www.google.com/accounts/o8/id?id=AItOawm_nWF_tPw8mLI7rMxfykA_d3FehQNvWpI
29 - https://www.google.com/accounts/o8/id?id=AItOawkTn3HixU2KJIvvLXLqwYUzlDGDtYf43GE
30 - https://www.google.com/accounts/o8/id?id=AItOawkDOCT-KTCLpieip-2W0N51gZwF7nGLaS0
31 - https://www.google.com/accounts/o8/id?id=AItOawl8-V-Yp0F5ZWRmDb7j4ul1gsbMXjghDIU
32 - https://www.google.com/accounts/o8/id?id=AItOawkaL6e6GtpyD7gJyqHphon_5ES1ACDLJgg
33 - https://www.google.com/accounts/o8/id?id=AItOawnv-w7GplWln2P55lnzc6Ds-ltzk6sNxDY
34 - https://me.yahoo.com/a/3hUnH9Qi24uk3RwCwHATJBWKVyqc#7d8b8
35 - ip(95.65.50.150)
36 - https://me.yahoo.com/a/2.Pjpm0G0Z6F9LiGW4cYO84pIrb.Lg--#137de
37 - https://www.google.com/accounts/o8/id?id=AItOawkuR0eo_HO1s1hs49h0Y_4Bzm08l9evMEc
38 - https://www.google.com/accounts/o8/id?id=AItOawlYXeKSEBoSCzES7o5VYiSratG5RfNucL0
39 - https://www.google.com/accounts/o8/id?id=AItOawl_wuvPHDhkuMVnEOP5jLrZyd3nnBs8YRw
40 - ip(115.43.30.149)
41 - ikiwikiweb
42 - webkatalog
43 - ip(117.201.35.183)
44 - adrianna
45 - ip(94.179.251.118)
46 - capitaine
47 - ip(74.63.117.196)
48 - ip(74.63.117.195)
49 - testerer
50 - ip(86.103.200.90)
51 - AlbertF
52 - ip(71.132.208.155)
53 - MariaJackson
54 - ip(208.75.10.42)
55 - HelenOliver
56 - ip(222.127.197.140)
57 - GraceTemplman46
58 - diannetyron
59 - ip(119.111.124.194)
60 - http://cmelbye.myopenid.com/
61 - autobahnned
62 - icerain321
63 - shoesorder
64 - AdamMeyars
65 - essaywriter
66 - blahgrad
67 - alicia.warner
68 - WikiJeanHawkins
69 - nicole.adams
70 - Smith
71 - quentin
72 - quentinfudge
73 - https://www.google.com/accounts/o8/id?id=AItOawkJHb27RVmw93kqyzfoxZWNKjqR8MEVt3A
74 - ip(123.26.115.218)
75 - https://www.google.com/accounts/o8/id?id=AItOawkljravtnjpauReS81ng5zVurZx_thpse8
76 - ip(123.26.124.157)
77 - KataMutiara
78 - tekschen
79 - webschen1
80 - ip(79.228.*.*)
81 - soman81
82 - ip(31.17.11.19)
83 - spain1001
84 - ip(80.187.*.*)
85 - Toni
86 - ip(124.105.173.121)
87 - domtheo9110
88 - https://www.google.com/accounts/o8/id?id=AItOawnO6NxsiqDMNHCMugqNKPwCWmTAQ7v_2Fs
89 - ip(58.186.127.104)
90 - https://pypi.python.org/id/tlevine
91 - ip(82.153.13.48)
92 - https://me.yahoo.com/a/FQMi.N5i0IzdnUgI0Ite4hPzi5Teukf.wOGAiQ--#4e81f
93 - https://www.google.com/accounts/o8/id?id=AItOawlowX5C5dCp9CmqRAUSMhjaRcDEqZrLZ5M
94 - spalax.
95 - ip(122.173.*.*)
96 - https://www.google.com/accounts/o8/id?id=AItOawlyeMDnU_eaFpTAKNEyeZJJIcWPdLyz3js
97 - ip(187.209.217.54)
98 - https://me.yahoo.com/a/7bUPkZg.gdHGMU8azO0bnVfS23aU5iT7h263LhiVB3r9j6W_yUR9lX1Ia6UJfs247nNtKGg-*
99 - ip(136.0.0.90)
100 - jhakasbaba76
101 - jhakasbaba76@c741fb7726e8ce4a230bc1a0d48fbeb496e46f89
102 - ip(110.172.140.98)
103 - arachni_name
104 - SlodreDalk
105 - 360boom720
106 # where the source of the wiki is located
107 srcdir: /home/b-ikiwiki/source/doc
108 # where to build the wiki
109 destdir: /home/b-ikiwiki/public_html
110 # base url to the wiki
111 url: http://ikiwiki.info
112 # url to the ikiwiki.cgi
113 cgiurl: http://ikiwiki.info/ikiwiki.cgi
114 # do not adjust cgiurl if CGI is accessed via different URL
115 reverse_proxy: 0
116 # filename of cgi wrapper to generate
117 cgi_wrapper: /var/www/b-ikiwiki/ikiwiki.cgi
118 # mode for cgi_wrapper (can safely be made suid)
119 cgi_wrappermode: 0755
120 # number of seconds to delay CGI requests when overloaded
121 cgi_overload_delay: ''
122 # message to display when overloaded (may contain html)
123 cgi_overload_message: Please wait..
124 # enable optimization of only refreshing committed changes?
125 only_committed_changes: 0
126 # rcs backend to use
127 rcs: git
128 # plugins to add to the default configuration
129 add_plugins:
130 - sidebar
131 - goodstuff
132 - websetup
133 - table
134 - haiku
135 - html
136 - polygen
137 - fortune
138 - linkmap
139 - favicon
140 - poll
141 - postsparkline
142 - sparkline
143 - version
144 - testpagespec
145 - edittemplate
146 - recentchangesdiff
147 - 404
148 - ikiwikihosting
149 - branchable
150 - recentchangesdiff
151 - attachment
152 - remove
153 - rename
154 - edittemplate
155 - favicon
156 - format
157 - fortune
158 - highlight
159 - listdirectives
160 - poll
161 - progress
162 - relativedate
163 - search
164 - testpagespec
165 - version
166 - theme
167 - repolist
168 - highlight
169 - comments
170 - gitpush
171 - blogspam
172 # plugins to disable
173 disable_plugins: []
174 # additional directory to search for template files
175 templatedir: /usr/share/ikiwiki/templates
176 # base wiki source location
177 underlaydir: /usr/share/ikiwiki/basewiki
178 # display verbose messages?
179 #verbose: 1
180 # log to syslog?
181 syslog: 1
182 # create output files named page/index.html?
183 usedirs: 1
184 # use '!'-prefixed preprocessor directives?
185 prefix_directives: 1
186 # use page/index.mdwn source files
187 indexpages: 0
188 # enable Discussion pages?
189 discussion: 1
190 # name of Discussion pages
191 discussionpage: Discussion
192 # use elements new in HTML5 like <section>?
193 html5: 0
194 # only send cookies over SSL connections?
195 sslcookie: 0
196 # extension to use for new pages
197 default_pageext: mdwn
198 # extension to use for html files
199 htmlext: html
200 # strftime format string to display date
201 timeformat: '%c'
202 # UTF-8 locale to use
203 #locale: en_US.UTF-8
204 # put user pages below specified page
205 userdir: users
206 # how many backlinks to show before hiding excess (0 to show all)
207 numbacklinks: 10
208 # attempt to hardlink source files? (optimisation for large files)
209 hardlink: 1
210 # force ikiwiki to use a particular umask (keywords public, group or private, or a number)
211 #umask: public
212 # group for wrappers to run in
213 #wrappergroup: ikiwiki
214 # extra library and plugin directories
215 libdirs: []
216 # extra library and plugin directory (searched after libdirs)
217 libdir: /home/b-ikiwiki/.ikiwiki
218 # environment variables
219 ENV:
220   TMPDIR: /home/b-ikiwiki/tmp
221 # time zone name
222 timezone: JEST+4
223 # regexp of normally excluded files to include
224 #include: ^\.htaccess$
225 # regexp of files that should be skipped
226 #exclude: ^(*\.private|Makefile)$
227 # specifies the characters that are allowed in source filenames
228 wiki_file_chars: -[:alnum:]+/.:_
229 # allow symlinks in the path leading to the srcdir (potentially insecure)
230 allow_symlinks_before_srcdir: 0
231 # cookie control
232 cookiejar:
233   file: /home/b-ikiwiki/.ikiwiki/cookies
234 # set custom user agent string for outbound HTTP requests e.g. when fetching aggregated RSS feeds
235 useragent: ikiwiki/3.20150330
236 # theme has a responsive layout? (mobile-optimized)
237 responsive_layout: 1
238 # try harder to produce deterministic output
239 deterministic: 0
241 ######################################################################
242 # core plugins
243 #   (branchable, editpage, git, gitpush, htmlscrubber, ikiwikihosting,
244 #    inline, link, meta, parentlinks, templatebody)
245 ######################################################################
247 # branchable plugin
248 # Allow anyone to branch, check out, and copy this site?
249 branchable: 1
250 # Allow anyone to git push verified changes to this site?
251 anonpush: 1
252 # Display "Branchable" link on action bar?
253 branchable_action: 1
255 # git plugin
256 # git hook to generate
257 git_wrapper: /home/b-ikiwiki/source.git/hooks/post-update
258 # shell command for git_wrapper to run, in the background
259 #git_wrapper_background_command: git push github
260 # mode for git_wrapper (can safely be made suid)
261 git_wrappermode: 6755
262 # git pre-receive hook to generate
263 git_test_receive_wrapper: /home/b-ikiwiki/source.git/hooks/pre-receive
264 # unix users whose commits should be checked by the pre-receive hook
265 untrusted_committers:
266 - ikiwiki-anon
267 # gitweb url to show file history ([[file]] substituted)
268 historyurl: http://source.ikiwiki.branchable.com/?p=source.git;a=history;f=doc/[[file]];hb=HEAD
269 # gitweb url to show a diff ([[file]], [[sha1_to]], [[sha1_from]], [[sha1_commit]], and [[sha1_parent]] substituted)
270 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]]
271 # where to pull and push changes (set to empty string to disable)
272 gitorigin_branch: origin
273 # branch that the wiki is stored in
274 gitmaster_branch: master
276 # gitpush plugin
277 # git repository urls that changes are pushed to
278 git_push_to:
279 - git@github.com:joeyh/ikiwiki.git
280 - joey@git.kitenet.net:/srv/git/ikiwiki.git
282 # htmlscrubber plugin
283 # PageSpec specifying pages not to scrub
284 htmlscrubber_skip: tipjar
286 # ikiwikihosting plugin
287 # list of urls that alias to the main url
288 urlalias:
289 - http://ikiwiki.branchable.com/
290 - http://ikiwiki.branchable.com/
291 - http://git.ikiwiki.info/
292 - http://www.ikiwiki.info/
293 # openid or email of primary site owner
294 owner: http://joey.kitenet.net/
295 # optional hostname of site this one was branched from
296 #parent: ''
297 # internal hostname of this site
298 hostname: ikiwiki.branchable.com
299 # site creation datestamp
300 created: 1305836524
301 # how many days to retain logs
302 #log_period: 7
303 # disable IPv6?
304 ipv6_disabled: 0
305 # redirect from http to https?
306 redirect_to_https: 0
307 # use Lets Encrypt to generate https certificate?
308 use_letsencrypt: 1
310 # inline plugin
311 # enable rss feeds by default?
312 rss: 1
313 # enable atom feeds by default?
314 atom: 0
315 # allow rss feeds to be used?
316 #allowrss: 0
317 # allow atom feeds to be used?
318 allowatom: 1
319 # urls to ping (using XML-RPC) on feed update
320 pingurl: []
322 ######################################################################
323 # auth plugins
324 #   (anonok, blogspam, emailauth, httpauth, lockedit, moderatedcomments,
325 #    opendiscussion, openid, passwordauth, signinedit)
326 ######################################################################
328 # anonok plugin
329 # PageSpec to limit which pages anonymous users can edit
330 #anonok_pagespec: '*/discussion'
332 # blogspam plugin
333 # PageSpec of pages to check for spam
334 blogspam_pagespec: '*'
335 # options to send to blogspam server
336 #blogspam_options: blacklist=1.2.3.4,blacklist=8.7.6.5,max-links=10
337 # blogspam server JSON url
338 #blogspam_server: ''
340 # emailauth plugin
341 # email address to send emailauth mails as (default: adminemail)
342 emailauth_sender: login@branchable.com
344 # httpauth plugin
345 # url to redirect to when authentication is needed
346 #cgiauthurl: http://example.com/wiki/auth/ikiwiki.cgi
347 # PageSpec of pages where only httpauth will be used for authentication
348 #httpauth_pagespec: '!*/Discussion'
350 # lockedit plugin
351 # PageSpec controlling which pages are locked
352 locked_pages: tipjar or tips/DreamHost
354 # moderatedcomments plugin
355 # PageSpec matching users or comment locations to moderate
356 #moderate_pagespec: '*'
358 # openid plugin
359 # url pattern of openid realm (default is cgiurl)
360 #openid_realm: ''
361 # url to ikiwiki cgi to use for openid authentication (default is cgiurl)
362 #openid_cgiurl: ''
364 # passwordauth plugin
365 # a password that must be entered when signing up for an account
366 #account_creation_password: s3cr1t
367 # cost of generating a password using Authen::Passphrase::BlowfishCrypt
368 #password_cost: 8
370 ######################################################################
371 # format plugins
372 #   (creole, highlight, hnb, html, mdwn, otl, po, rawhtml, rst, textile,
373 #    txt)
374 ######################################################################
376 # highlight plugin
377 # types of source files to syntax highlight
378 tohighlight: .c .h .cpp .pl .py Makefile:make
379 # location of highlight's filetypes.conf
380 filetypes_conf: /etc/highlight/filetypes.conf
381 # location of highlight's langDefs directory
382 langdefdir: /usr/share/highlight/langDefs
384 # mdwn plugin
385 # enable multimarkdown features?
386 #multimarkdown: 0
387 # disable use of markdown discount?
388 #nodiscount: 0
390 # po plugin
391 # master language (non-PO files)
392 #po_master_language: en|English
393 # slave languages (translated via PO files) format: ll|Langname
394 #po_slave_languages:
395 #- fr|Français
396 #- es|Español
397 #- de|Deutsch
398 # PageSpec controlling which pages are translatable
399 po_translatable_pages: ''
400 # internal linking behavior (default/current/negotiated)
401 po_link_to: default
403 ######################################################################
404 # special-purpose plugins
405 #   (osm, underlay)
406 ######################################################################
408 # osm plugin
409 # the default zoom when you click on the map link
410 #osm_default_zoom: 15
411 # the icon shown on links and on the main map
412 #osm_default_icon: ikiwiki/images/osm.png
413 # the alt tag of links, defaults to empty
414 #osm_alt: ''
415 # the output format for waypoints, can be KML, GeoJSON or CSV (one or many, comma-separated)
416 #osm_format: KML
417 # the icon attached to a tag, displayed on the map for tagged pages
418 #osm_tag_default_icon: icon.png
419 # Url for the OpenLayers.js file
420 #osm_openlayers_url: http://www.openlayers.org/api/OpenLayers.js
421 # Layers to use in the map. Can be either the 'OSM' string or a type option for Google maps (GoogleNormal, GoogleSatellite, GoogleHybrid or GooglePhysical). It can also be an arbitrary URL in a syntax acceptable for OpenLayers.Layer.OSM.url parameter.
422 #osm_layers:
423 #  OSM: GoogleSatellite
424 # Google maps API key, Google layer not used if missing, see https://code.google.com/apis/console/ to get an API key
425 #osm_google_apikey: ''
427 # underlay plugin
428 # extra underlay directories to add
429 #add_underlays:
430 #- /home/b-ikiwiki/wiki.underlay
432 ######################################################################
433 # web plugins
434 #   (404, attachment, comments, editdiff, edittemplate, getsource, google,
435 #    goto, mirrorlist, remove, rename, repolist, search, theme, userlist,
436 #    websetup, wmd)
437 ######################################################################
439 # attachment plugin
440 # enhanced PageSpec specifying what attachments are allowed
441 allowed_attachments: admin() and virusfree()
442 # virus checker program (reads STDIN, returns nonzero if virus found)
443 virus_checker: clamdscan -
445 # comments plugin
446 # PageSpec of pages where comments are allowed
447 comments_pagespec: forum/* and !*/Discussion
448 # PageSpec of pages where posting new comments is not allowed
449 comments_closed_pagespec: ''
450 # Base name for comments, e.g. "comment_" for pages like "sandbox/comment_12"
451 comments_pagename: comment_
452 # Interpret directives in comments?
453 #comments_allowdirectives: 0
454 # Allow anonymous commenters to set an author name?
455 comments_allowauthor: 0
456 # commit comments to the VCS
457 comments_commit: 1
458 # Restrict formats for comments to (no restriction if empty)
459 comments_allowformats: ''
461 # getsource plugin
462 # Mime type for returned source.
463 #getsource_mimetype: text/plain; charset=utf-8
465 # mirrorlist plugin
466 # list of mirrors
467 #mirrorlist: {}
468 # generate links that point to the mirrors' ikiwiki CGI
469 #mirrorlist_use_cgi: 1
471 # repolist plugin
472 # URIs of repositories containing the wiki's source
473 repositories:
474 - ssh://b-ikiwiki@ikiwiki.branchable.com/
475 - git://ikiwiki.branchable.com/
477 # search plugin
478 # path to the omega cgi program
479 omega_cgi: /usr/lib/cgi-bin/omega/omega
480 # use google site search rather than internal xapian index?
481 google_search: 1
483 # theme plugin
484 # name of theme to enable
485 #theme: actiontabs
487 # websetup plugin
488 # list of plugins that cannot be enabled/disabled via the web interface
489 websetup_force_plugins:
490 - httpauth
491 - openid
492 - mdwn
493 - wmd
494 # list of additional setup field keys to treat as unsafe
495 websetup_unsafe:
496 - url
497 - cgiurl
498 - verbose
499 - syslog
500 - usedirs
501 - prefix_directives
502 - indexpages
503 - repositories
504 - sslcookie
505 # show unsafe settings, read-only, in web interface?
506 websetup_show_unsafe: 0
508 ######################################################################
509 # widget plugins
510 #   (calendar, color, conditional, cutpaste, date, format, fortune,
511 #    graphviz, haiku, headinganchors, img, linkmap, listdirectives, map,
512 #    more, orphans, pagecount, pagestats, poll, polygen, postsparkline,
513 #    progress, shortcut, sparkline, table, template, teximg, toc, toggle,
514 #    version)
515 ######################################################################
517 # calendar plugin
518 # base of the archives hierarchy
519 #archivebase: archives
520 # PageSpec of pages to include in the archives, if option `calendar_autocreate` is true.
521 #archive_pagespec: page(posts/*) and !*/Discussion
522 # autocreate new calendar pages?
523 #calendar_autocreate: 1
524 # if set, when building calendar pages, also build pages of year and month when no pages were published (building empty calendars).
525 #calendar_fill_gaps: 1
527 # img plugin
528 # Image formats to process (jpeg, png, gif, svg, pdf or 'everything' to accept all)
529 #img_allowed_formats: ''
531 # listdirectives plugin
532 # directory in srcdir that contains directive descriptions
533 directive_description_dir: ikiwiki/directive
535 # teximg plugin
536 # Should teximg use dvipng to render, or dvips and convert?
537 #teximg_dvipng: ''
538 # LaTeX prefix for teximg plugin
539 #teximg_prefix: |
540 #  \documentclass{article}
541 #  \usepackage[utf8]{inputenc}
542 #  \usepackage{amsmath}
543 #  \usepackage{amsfonts}
544 #  \usepackage{amssymb}
545 #  \pagestyle{empty}
546 #  \begin{document}
547 # LaTeX postfix for teximg plugin
548 #teximg_postfix: \end{document}
550 ######################################################################
551 # other plugins
552 #   (aggregate, autoindex, brokenlinks, camelcase, ddate, embed, favicon,
553 #    filecheck, flattr, goodstuff, htmlbalance, localstyle, loginselector,
554 #    missingsite, notifyemail, pagetemplate, parked, pingee, pinger,
555 #    prettydate, recentchanges, recentchangesdiff, relativedate, rsync,
556 #    sidebar, smiley, sortnaturally, tag, testpagespec, trail, transient,
557 #    typography)
558 ######################################################################
560 # aggregate plugin
561 # enable aggregation to internal pages?
562 aggregateinternal: 1
563 # allow aggregation to be triggered via the web?
564 #aggregate_webtrigger: 0
566 # autoindex plugin
567 # commit autocreated index pages
568 autoindex_commit: 1
570 # camelcase plugin
571 # list of words to not turn into links
572 #camelcase_ignore: []
574 # flattr plugin
575 # userid or user name to use by default for Flattr buttons
576 #flattr_userid: joeyh
578 # parked plugin
579 # An optional message explaining why this site is parked.
580 #parked_message: ''
582 # pinger plugin
583 # how many seconds to try pinging before timing out
584 #pinger_timeout: 15
586 # prettydate plugin
587 # format to use to display date
588 prettydateformat: '%X, %B %o, %Y'
590 # recentchanges plugin
591 # name of the recentchanges page
592 recentchangespage: recentchanges
593 # number of changes to track
594 recentchangesnum: 100
596 # rsync plugin
597 # command to run to sync updated pages
598 #rsync_command: rsync -qa --delete . user@host:/path/to/docroot/
600 # sidebar plugin
601 # show sidebar page on all pages?
602 global_sidebars: 0
604 # tag plugin
605 # parent page tags are located under
606 #tagbase: tag
607 # autocreate new tag pages?
608 #tag_autocreate: 1
609 # commit autocreated tag pages
610 tag_autocreate_commit: 1
612 # typography plugin
613 # Text::Typography attributes value
614 #typographyattributes: 3