added printer config to FSF class
[fai-configs.git] / files / etc / ikiwiki / ikiwiki.setup / DEFAULT
CommitLineData
ef7cdb34 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
11wikiname: gluestick
12# contact email for wiki
a9aba143 13adminemail: sysadmin-nonrt@fsf.org
ef7cdb34 14# users who are wiki admins
15adminuser:
16- admin
17# users who are banned from the wiki
18banned_users: []
19# where the source of the wiki is located
a9aba143 20srcdir: /srv/ikiwiki/wiki
ef7cdb34 21# where to build the wiki
a9aba143 22destdir: /var/www/html/wiki
ef7cdb34 23# base url to the wiki
a9aba143 24url: http://gluestick.office.fsf.org
ef7cdb34 25# url to the ikiwiki.cgi
a9aba143 26cgiurl: http://gluestick.office.fsf.org/ikiwiki.cgi
ef7cdb34 27# filename of cgi wrapper to generate
a9aba143 28cgi_wrapper: /var/www/html/wiki/ikiwiki.cgi
ef7cdb34 29# mode for cgi_wrapper (can safely be made suid)
30cgi_wrappermode: 06755
31# number of seconds to delay CGI requests when overloaded
32cgi_overload_delay: ''
33# message to display when overloaded (may contain html)
34cgi_overload_message: ''
35# rcs backend to use
36rcs: git
37# plugins to add to the default configuration
38add_plugins:
39- goodstuff
40- websetup
a9aba143
LMM
41- search
42- httpauth
43- pagecount
44- attachment
45- autoindex
46- toc
47- brokenlinks
48- edittemplate
49- rename
50- remove
ef7cdb34 51# plugins to disable
a9aba143
LMM
52disable_plugins:
53- passwordauth
54- rst
ef7cdb34 55# additional directory to search for template files
56templatedir: /usr/share/ikiwiki/templates
57# base wiki source location
58underlaydir: /usr/share/ikiwiki/basewiki
59# display verbose messages?
60#verbose: 1
61# log to syslog?
62syslog: 1
63# create output files named page/index.html?
64usedirs: 1
65# use '!'-prefixed preprocessor directives?
66prefix_directives: 1
67# use page/index.mdwn source files
68indexpages: 0
69# enable Discussion pages?
70discussion: 1
71# name of Discussion pages
72discussionpage: Discussion
73# generate HTML5?
74html5: 0
75# only send cookies over SSL connections?
76sslcookie: 0
77# extension to use for new pages
78default_pageext: mdwn
79# extension to use for html files
80htmlext: html
81# strftime format string to display date
82timeformat: '%c'
83# UTF-8 locale to use
84#locale: en_US.UTF-8
85# put user pages below specified page
86userdir: ''
87# how many backlinks to show before hiding excess (0 to show all)
88numbacklinks: 10
89# attempt to hardlink source files? (optimisation for large files)
90hardlink: 0
91# force ikiwiki to use a particular umask (keywords public, group or private, or a number)
92#umask: public
93# group for wrappers to run in
94#wrappergroup: ikiwiki
95# extra library and plugin directory
a9aba143 96libdir: /usr/share/perl5/IkiWiki/Plugin
ef7cdb34 97# environment variables
98ENV: {}
99# time zone name
100#timezone: US/Eastern
101# regexp of normally excluded files to include
102#include: ^\.htaccess$
103# regexp of files that should be skipped
104#exclude: ^(*\.private|Makefile)$
105# specifies the characters that are allowed in source filenames
106wiki_file_chars: -[:alnum:]+/.:_
107# allow symlinks in the path leading to the srcdir (potentially insecure)
108allow_symlinks_before_srcdir: 0
109# cookie control
110cookiejar:
7afb1158 111 file: /srv/ikiwiki/wiki/.ikiwiki/cookies
ef7cdb34 112
113######################################################################
114# core plugins
115# (editpage, git, htmlscrubber, inline, link, meta, parentlinks)
116######################################################################
117
118# git plugin
119# git hook to generate
a9aba143 120#git_wrapper: /srv/ikiwiki/wiki.git/hooks/post-update
ef7cdb34 121# shell command for git_wrapper to run, in the background
a9aba143 122git_wrapper_background_command: 'git push'
ef7cdb34 123# mode for git_wrapper (can safely be made suid)
124#git_wrappermode: 06755
125# git pre-receive hook to generate
126#git_test_receive_wrapper: /git/wiki.git/hooks/pre-receive
127# unix users whose commits should be checked by the pre-receive hook
128#untrusted_committers: []
129# gitweb url to show file history ([[file]] substituted)
130#historyurl: http://git.example.com/gitweb.cgi?p=wiki.git;a=history;f=[[file]];hb=HEAD
131# gitweb url to show a diff ([[file]], [[sha1_to]], [[sha1_from]], [[sha1_commit]], and [[sha1_parent]] substituted)
132#diffurl: http://git.example.com/gitweb.cgi?p=wiki.git;a=blobdiff;f=[[file]];h=[[sha1_to]];hp=[[sha1_from]];hb=[[sha1_commit]];hpb=[[sha1_parent]]
133# where to pull and push changes (set to empty string to disable)
a9aba143 134gitorigin_branch: origin
ef7cdb34 135# branch that the wiki is stored in
a9aba143 136gitmaster_branch: master
ef7cdb34 137
138# htmlscrubber plugin
139# PageSpec specifying pages not to scrub
140#htmlscrubber_skip: '!*/Discussion'
141
142# inline plugin
143# enable rss feeds by default?
144rss: 1
145# enable atom feeds by default?
146atom: 1
147# allow rss feeds to be used?
148#allowrss: 0
149# allow atom feeds to be used?
150#allowatom: 0
151# urls to ping (using XML-RPC) on feed update
a9aba143 152pingurl: []
ef7cdb34 153
154######################################################################
155# auth plugins
156# (anonok, blogspam, httpauth, lockedit, moderatedcomments,
157# opendiscussion, openid, passwordauth, signinedit)
158######################################################################
159
160# anonok plugin
161# PageSpec to limit which pages anonymous users can edit
162#anonok_pagespec: '*/discussion'
163
164# blogspam plugin
165# PageSpec of pages to check for spam
166#blogspam_pagespec: postcomment(*)
167# options to send to blogspam server
168#blogspam_options: blacklist=1.2.3.4,blacklist=8.7.6.5,max-links=10
169# blogspam server XML-RPC url
170#blogspam_server: ''
171
172# httpauth plugin
173# url to redirect to when authentication is needed
174#cgiauthurl: http://example.com/wiki/auth/ikiwiki.cgi
175# PageSpec of pages where only httpauth will be used for authentication
176#httpauth_pagespec: '!*/Discussion'
177
178# lockedit plugin
179# PageSpec controlling which pages are locked
180#locked_pages: '!*/Discussion'
181
182# moderatedcomments plugin
183# PageSpec matching users or comment locations to moderate
184#moderate_pagespec: '*'
185
186# openid plugin
187# url pattern of openid realm (default is cgiurl)
188#openid_realm: ''
189# url to ikiwiki cgi to use for openid authentication (default is cgiurl)
190#openid_cgiurl: ''
191
192# passwordauth plugin
193# a password that must be entered when signing up for an account
194#account_creation_password: s3cr1t
195# cost of generating a password using Authen::Passphrase::BlowfishCrypt
196#password_cost: 8
197
198######################################################################
199# format plugins
a9aba143 200# (creole, highlight, hnb, html, mdwn, otl, rawhtml, rst, textile, txt)
ef7cdb34 201######################################################################
202
203# highlight plugin
204# types of source files to syntax highlight
205#tohighlight: .c .h .cpp .pl .py Makefile:make
206# location of highlight's filetypes.conf
207#filetypes_conf: /etc/highlight/filetypes.conf
208# location of highlight's langDefs directory
209#langdefdir: /usr/share/highlight/langDefs
210
211# mdwn plugin
212# enable multimarkdown features?
213#multimarkdown: 0
214# disable use of markdown discount?
215#nodiscount: 0
216
217######################################################################
218# special-purpose plugins
219# (osm, underlay)
220######################################################################
221
222# osm plugin
223# the default zoom when you click on the map link
224#osm_default_zoom: 15
225# the icon shown on links and on the main map
226#osm_default_icon: ikiwiki/images/osm.png
227# the alt tag of links, defaults to empty
228#osm_alt: ''
229# the output format for waypoints, can be KML, GeoJSON or CSV (one or many, comma-separated)
230#osm_format: KML
231# the icon attached to a tag, displayed on the map for tagged pages
232#osm_tag_default_icon: icon.png
233# Url for the OpenLayers.js file
234#osm_openlayers_url: http://www.openlayers.org/api/OpenLayers.js
235# 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.
236#osm_layers:
237# OSM: GoogleSatellite
238# Google maps API key, Google layer not used if missing, see https://code.google.com/apis/console/ to get an API key
239#osm_google_apikey: ''
240
241# underlay plugin
242# extra underlay directories to add
243#add_underlays:
244#- /root/wiki.underlay
245
246######################################################################
247# web plugins
a9aba143
LMM
248# (404, attachment, comments, editdiff, edittemplate, google, goto,
249# mirrorlist, remove, rename, repolist, search, theme, userlist,
ef7cdb34 250# websetup, wmd)
251######################################################################
252
253# attachment plugin
254# enhanced PageSpec specifying what attachments are allowed
255#allowed_attachments: virusfree() and mimetype(image/*) and maxsize(50kb)
256# virus checker program (reads STDIN, returns nonzero if virus found)
257#virus_checker: clamdscan -
258
259# comments plugin
260# PageSpec of pages where comments are allowed
261#comments_pagespec: blog/* and !*/Discussion
262# PageSpec of pages where posting new comments is not allowed
263#comments_closed_pagespec: blog/controversial or blog/flamewar
264# Base name for comments, e.g. "comment_" for pages like "sandbox/comment_12"
265#comments_pagename: ''
266# Interpret directives in comments?
267#comments_allowdirectives: 0
268# Allow anonymous commenters to set an author name?
269#comments_allowauthor: 0
270# commit comments to the VCS
271#comments_commit: 1
272# Restrict formats for comments to (no restriction if empty)
273#comments_allowformats: mdwn txt
274
ef7cdb34 275# mirrorlist plugin
276# list of mirrors
277#mirrorlist: {}
278# generate links that point to the mirrors' ikiwiki CGI
279#mirrorlist_use_cgi: 1
280
281# repolist plugin
282# URIs of repositories containing the wiki's source
283#repositories:
284#- svn://svn.example.org/wiki/trunk
285
286# search plugin
287# path to the omega cgi program
a9aba143 288omega_cgi: /usr/lib/cgi-bin/omega/omega
ef7cdb34 289
290# theme plugin
291# name of theme to enable
292#theme: actiontabs
293
294# websetup plugin
295# list of plugins that cannot be enabled/disabled via the web interface
296#websetup_force_plugins: []
297# list of additional setup field keys to treat as unsafe
298#websetup_unsafe: []
299# show unsafe settings, read-only, in web interface?
a9aba143 300websetup_show_unsafe: 1
ef7cdb34 301
302######################################################################
303# widget plugins
304# (calendar, color, conditional, cutpaste, date, format, fortune,
305# graphviz, haiku, headinganchors, img, linkmap, listdirectives, map,
306# more, orphans, pagecount, pagestats, poll, polygen, postsparkline,
307# progress, shortcut, sparkline, table, template, teximg, toc, toggle,
308# version)
309######################################################################
310
311# calendar plugin
312# base of the archives hierarchy
313#archivebase: archives
314# PageSpec of pages to include in the archives; used by ikiwiki-calendar command
315#archive_pagespec: page(posts/*) and !*/Discussion
316
317# listdirectives plugin
318# directory in srcdir that contains directive descriptions
319#directive_description_dir: ikiwiki/directive
320
321# teximg plugin
322# Should teximg use dvipng to render, or dvips and convert?
323#teximg_dvipng: ''
324# LaTeX prefix for teximg plugin
325#teximg_prefix: '\documentclass{article}
326#
327# \usepackage[utf8]{inputenc}
328#
329# \usepackage{amsmath}
330#
331# \usepackage{amsfonts}
332#
333# \usepackage{amssymb}
334#
335# \pagestyle{empty}
336#
337# \begin{document}
338#
339#'
340# LaTeX postfix for teximg plugin
341#teximg_postfix: \end{document}
342
343######################################################################
344# other plugins
345# (aggregate, autoindex, brokenlinks, camelcase, ddate, embed, favicon,
346# filecheck, flattr, goodstuff, htmlbalance, localstyle, notifyemail,
347# pagetemplate, pingee, pinger, prettydate, recentchanges,
348# recentchangesdiff, relativedate, rsync, sidebar, smiley,
349# sortnaturally, tag, testpagespec, trail, transient)
350######################################################################
351
352# aggregate plugin
353# enable aggregation to internal pages?
354#aggregateinternal: 1
355# allow aggregation to be triggered via the web?
356#aggregate_webtrigger: 0
357
358# autoindex plugin
359# commit autocreated index pages
a9aba143 360autoindex_commit: 1
ef7cdb34 361
362# camelcase plugin
363# list of words to not turn into links
364#camelcase_ignore: []
365
366# flattr plugin
367# userid or user name to use by default for Flattr buttons
368#flattr_userid: joeyh
369
370# pinger plugin
371# how many seconds to try pinging before timing out
372#pinger_timeout: 15
373
374# prettydate plugin
375# format to use to display date
376#prettydateformat: '%X, %B %o, %Y'
377
378# recentchanges plugin
379# name of the recentchanges page
a9aba143 380recentchangespage: recentchanges
ef7cdb34 381# number of changes to track
a9aba143 382recentchangesnum: 100
ef7cdb34 383
384# rsync plugin
385# command to run to sync updated pages
386#rsync_command: rsync -qa --delete . user@host:/path/to/docroot/
387
388# sidebar plugin
389# show sidebar page on all pages?
390#global_sidebars: 1
391
392# tag plugin
393# parent page tags are located under
394#tagbase: tag
395# autocreate new tag pages?
396#tag_autocreate: 1
397# commit autocreated tag pages
a9aba143 398tag_autocreate_commit: 1