1 # IkiWiki::Setup::Yaml - YAML formatted setup file
3 # Setup file for ikiwiki.
5 # Passing this to ikiwiki --setup will make ikiwiki generate
6 # wrappers and build the wiki.
8 # Remember to re-run ikiwiki --setup any time you edit this file.
12 # contact email for wiki
13 adminemail: sojkam1@fel.cvut.cz
14 # users who are wiki admins
16 # users who are banned from the wiki
18 # where the source of the wiki is located
20 # where to build the wiki
22 # base url to the wiki
23 url: 'http://lintarget.sourceforge.net/'
24 # url to the ikiwiki.cgi
26 # filename of cgi wrapper to generate
28 # mode for cgi_wrapper (can safely be made suid)
29 cgi_wrappermode: 06755
30 # number of seconds to delay CGI requests when overloaded
31 cgi_overload_delay: ''
32 # message to display when overloaded (may contain html)
33 cgi_overload_message: ''
34 # enable optimization of only refreshing committed changes?
35 only_committed_changes: 0
38 # plugins to add to the default configuration
44 # additional directory to search for template files
45 templatedir: /usr/share/ikiwiki/templates
46 # base wiki source location
47 underlaydir: /usr/share/ikiwiki/basewiki
48 # display verbose messages?
52 # create output files named page/index.html?
54 # use '!'-prefixed preprocessor directives?
56 # use page/index.mdwn source files
58 # enable Discussion pages?
60 # name of Discussion pages
61 discussionpage: Discussion
64 # only send cookies over SSL connections?
66 # extension to use for new pages
68 # extension to use for html files
70 # strftime format string to display date
74 # put user pages below specified page
76 # how many backlinks to show before hiding excess (0 to show all)
78 # attempt to hardlink source files? (optimisation for large files)
80 # force ikiwiki to use a particular umask (keywords public, group or private, or a number)
82 # group for wrappers to run in
83 #wrappergroup: ikiwiki
84 # extra library and plugin directory
86 # environment variables
90 # regexp of normally excluded files to include
91 #include: ^\.htaccess$
92 # regexp of files that should be skipped
93 #exclude: ^(*\.private|Makefile)$
94 # specifies the characters that are allowed in source filenames
95 wiki_file_chars: -[:alnum:]+/.:_
96 # allow symlinks in the path leading to the srcdir (potentially insecure)
97 allow_symlinks_before_srcdir: 0
100 file: /home/wsh/.ikiwiki/cookies
101 # set custom user agent string for outbound HTTP requests e.g. when fetching aggregated RSS feeds
102 #useragent: Wget/1.13.4 (linux-gnu)
104 ######################################################################
106 # (editpage, htmlscrubber, inline, link, meta, parentlinks)
107 ######################################################################
109 # htmlscrubber plugin
110 # PageSpec specifying pages not to scrub
111 #htmlscrubber_skip: '!*/Discussion'
114 # enable rss feeds by default?
116 # enable atom feeds by default?
118 # allow rss feeds to be used?
120 # allow atom feeds to be used?
122 # urls to ping (using XML-RPC) on feed update
125 ######################################################################
127 # (anonok, blogspam, httpauth, lockedit, moderatedcomments,
128 # opendiscussion, openid, passwordauth, signinedit)
129 ######################################################################
132 # PageSpec to limit which pages anonymous users can edit
133 #anonok_pagespec: '*/discussion'
136 # PageSpec of pages to check for spam
137 #blogspam_pagespec: postcomment(*)
138 # options to send to blogspam server
139 #blogspam_options: blacklist=1.2.3.4,blacklist=8.7.6.5,max-links=10
140 # blogspam server XML-RPC url
144 # url to redirect to when authentication is needed
145 #cgiauthurl: http://example.com/wiki/auth/ikiwiki.cgi
146 # PageSpec of pages where only httpauth will be used for authentication
147 #httpauth_pagespec: '!*/Discussion'
150 # PageSpec controlling which pages are locked
151 #locked_pages: '!*/Discussion'
153 # moderatedcomments plugin
154 # PageSpec matching users or comment locations to moderate
155 #moderate_pagespec: '*'
158 # url pattern of openid realm (default is cgiurl)
160 # url to ikiwiki cgi to use for openid authentication (default is cgiurl)
163 # passwordauth plugin
164 # a password that must be entered when signing up for an account
165 #account_creation_password: s3cr1t
166 # cost of generating a password using Authen::Passphrase::BlowfishCrypt
169 ######################################################################
171 # (creole, highlight, hnb, html, mdwn, otl, po, rawhtml, rst, textile,
173 ######################################################################
176 # types of source files to syntax highlight
177 #tohighlight: .c .h .cpp .pl .py Makefile:make
178 # location of highlight's filetypes.conf
179 #filetypes_conf: /etc/highlight/filetypes.conf
180 # location of highlight's langDefs directory
181 #langdefdir: /usr/share/highlight/langDefs
184 # enable multimarkdown features?
186 # disable use of markdown discount?
190 # master language (non-PO files)
191 #po_master_language: en|English
192 # slave languages (translated via PO files) format: ll|Langname
197 # PageSpec controlling which pages are translatable
198 #po_translatable_pages: '* and !*/Discussion'
199 # internal linking behavior (default/current/negotiated)
202 ######################################################################
203 # special-purpose plugins
205 ######################################################################
208 # the default zoom when you click on the map link
209 #osm_default_zoom: 15
210 # the icon shown on links and on the main map
211 #osm_default_icon: ikiwiki/images/osm.png
212 # the alt tag of links, defaults to empty
214 # the output format for waypoints, can be KML, GeoJSON or CSV (one or many, comma-separated)
216 # the icon attached to a tag, displayed on the map for tagged pages
217 #osm_tag_default_icon: icon.png
218 # Url for the OpenLayers.js file
219 #osm_openlayers_url: http://www.openlayers.org/api/OpenLayers.js
220 # 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.
222 # OSM: GoogleSatellite
223 # Google maps API key, Google layer not used if missing, see https://code.google.com/apis/console/ to get an API key
224 #osm_google_apikey: ''
227 # extra underlay directories to add
229 #- /home/wsh/wiki.underlay
231 ######################################################################
233 # (404, attachment, comments, editdiff, edittemplate, getsource, google,
234 # goto, mirrorlist, remove, rename, repolist, search, theme, userlist,
236 ######################################################################
239 # enhanced PageSpec specifying what attachments are allowed
240 #allowed_attachments: virusfree() and mimetype(image/*) and maxsize(50kb)
241 # virus checker program (reads STDIN, returns nonzero if virus found)
242 #virus_checker: clamdscan -
245 # PageSpec of pages where comments are allowed
246 #comments_pagespec: blog/* and !*/Discussion
247 # PageSpec of pages where posting new comments is not allowed
248 #comments_closed_pagespec: blog/controversial or blog/flamewar
249 # Base name for comments, e.g. "comment_" for pages like "sandbox/comment_12"
250 #comments_pagename: ''
251 # Interpret directives in comments?
252 #comments_allowdirectives: 0
253 # Allow anonymous commenters to set an author name?
254 #comments_allowauthor: 0
255 # commit comments to the VCS
257 # Restrict formats for comments to (no restriction if empty)
258 #comments_allowformats: mdwn txt
261 # Mime type for returned source.
262 #getsource_mimetype: text/plain; charset=utf-8
267 # generate links that point to the mirrors' ikiwiki CGI
268 #mirrorlist_use_cgi: 1
271 # URIs of repositories containing the wiki's source
273 #- svn://svn.example.org/wiki/trunk
276 # path to the omega cgi program
277 #omega_cgi: /usr/lib/cgi-bin/omega/omega
278 # use google site search rather than internal xapian index?
282 # name of theme to enable
286 # list of plugins that cannot be enabled/disabled via the web interface
287 #websetup_force_plugins: []
288 # list of additional setup field keys to treat as unsafe
290 # show unsafe settings, read-only, in web interface?
291 #websetup_show_unsafe: 1
293 ######################################################################
295 # (calendar, color, conditional, cutpaste, date, format, fortune,
296 # graphviz, haiku, headinganchors, img, linkmap, listdirectives, map,
297 # more, orphans, pagecount, pagestats, poll, polygen, postsparkline,
298 # progress, shortcut, sparkline, table, template, teximg, toc, toggle,
300 ######################################################################
303 # base of the archives hierarchy
304 #archivebase: archives
305 # PageSpec of pages to include in the archives; used by ikiwiki-calendar command
306 #archive_pagespec: page(posts/*) and !*/Discussion
308 # listdirectives plugin
309 # directory in srcdir that contains directive descriptions
310 #directive_description_dir: ikiwiki/directive
313 # Should teximg use dvipng to render, or dvips and convert?
315 # LaTeX prefix for teximg plugin
316 #teximg_prefix: '\documentclass{article}
318 # \usepackage[utf8]{inputenc}
320 # \usepackage{amsmath}
322 # \usepackage{amsfonts}
324 # \usepackage{amssymb}
331 # LaTeX postfix for teximg plugin
332 #teximg_postfix: \end{document}
334 ######################################################################
336 # (aggregate, autoindex, brokenlinks, camelcase, ddate, embed, favicon,
337 # filecheck, flattr, goodstuff, htmlbalance, localstyle, notifyemail,
338 # pagetemplate, pingee, pinger, prettydate, recentchanges,
339 # recentchangesdiff, relativedate, rsync, sidebar, smiley,
340 # sortnaturally, tag, testpagespec, trail, transient, typography)
341 ######################################################################
344 # enable aggregation to internal pages?
345 #aggregateinternal: 1
346 # allow aggregation to be triggered via the web?
347 #aggregate_webtrigger: 0
350 # commit autocreated index pages
354 # list of words to not turn into links
355 #camelcase_ignore: []
358 # userid or user name to use by default for Flattr buttons
359 #flattr_userid: joeyh
362 # how many seconds to try pinging before timing out
366 # format to use to display date
367 #prettydateformat: '%X, %B %o, %Y'
369 # recentchanges plugin
370 # name of the recentchanges page
371 recentchangespage: recentchanges
372 # number of changes to track
373 recentchangesnum: 100
376 # command to run to sync updated pages
377 #rsync_command: rsync -qa --delete . user@host:/path/to/docroot/
380 # show sidebar page on all pages?
384 # parent page tags are located under
386 # autocreate new tag pages?
388 # commit autocreated tag pages
389 #tag_autocreate_commit: 1
392 # Text::Typography attributes value
393 #typographyattributes: 3