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