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