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