]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blob - ikiwiki.setup
ef8348866f45b1486266caab183af084f58d9718
[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 # 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 - 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: http://*.branchable.com/
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
389 # enable footnotes in Markdown (where supported)?
390 mdwn_footnotes: 1
391 # interpret line like 'A. First item' as ordered list when using Discount?
392 mdwn_alpha_lists: 0
394 # po plugin
395 # master language (non-PO files)
396 #po_master_language: en|English
397 # slave languages (translated via PO files) format: ll|Langname
398 #po_slave_languages:
399 #- fr|Français
400 #- es|Español
401 #- de|Deutsch
402 # PageSpec controlling which pages are translatable
403 po_translatable_pages: ''
404 # internal linking behavior (default/current/negotiated)
405 po_link_to: default
407 ######################################################################
408 # special-purpose plugins
409 #   (osm, underlay)
410 ######################################################################
412 # osm plugin
413 # the default zoom when you click on the map link
414 #osm_default_zoom: 15
415 # the icon shown on links and on the main map
416 #osm_default_icon: ikiwiki/images/osm.png
417 # the alt tag of links, defaults to empty
418 #osm_alt: ''
419 # the output format for waypoints, can be KML, GeoJSON or CSV (one or many, comma-separated)
420 #osm_format: KML
421 # the icon attached to a tag, displayed on the map for tagged pages
422 #osm_tag_default_icon: icon.png
423 # Url for the OpenLayers.js file
424 #osm_openlayers_url: http://www.openlayers.org/api/OpenLayers.js
425 # 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.
426 #osm_layers:
427 #  OSM: GoogleSatellite
428 # Google maps API key, Google layer not used if missing, see https://code.google.com/apis/console/ to get an API key
429 #osm_google_apikey: ''
431 # underlay plugin
432 # extra underlay directories to add
433 #add_underlays:
434 #- /home/b-ikiwiki/wiki.underlay
436 ######################################################################
437 # web plugins
438 #   (404, attachment, comments, editdiff, edittemplate, google, goto,
439 #    mirrorlist, remove, rename, repolist, search, theme, userlist,
440 #    websetup, wmd)
441 ######################################################################
443 # attachment plugin
444 # enhanced PageSpec specifying what attachments are allowed
445 allowed_attachments: admin() and virusfree()
446 # virus checker program (reads STDIN, returns nonzero if virus found)
447 virus_checker: clamdscan -
449 # comments plugin
450 # PageSpec of pages where comments are allowed
451 comments_pagespec: forum/* and !*/Discussion
452 # PageSpec of pages where posting new comments is not allowed
453 comments_closed_pagespec: ''
454 # Base name for comments, e.g. "comment_" for pages like "sandbox/comment_12"
455 comments_pagename: comment_
456 # Interpret directives in comments?
457 #comments_allowdirectives: 0
458 # Allow anonymous commenters to set an author name?
459 comments_allowauthor: 0
460 # commit comments to the VCS
461 comments_commit: 1
462 # Restrict formats for comments to (no restriction if empty)
463 comments_allowformats: ''
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: '*'
522 # autocreate new calendar pages?
523 calendar_autocreate: ''
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