]> sipb.mit.edu Git - sipb-www.git/blob - ikiwiki.setup
Add cautionary comments to the plugins.
[sipb-www.git] / ikiwiki.setup
1 #!/usr/bin/perl
2 # Setup file for ikiwiki.
3 #
4 # Passing this to ikiwiki --setup will make ikiwiki generate
5 # wrappers and build the wiki.
6 #
7 # Remember to re-run ikiwiki --setup any time you edit this file.
8 use IkiWiki::Setup::Standard {
9         # name of the wiki
10         wikiname => 'SIPB',
11         # contact email for wiki
12         adminemail => 'sipb-www@mit.edu',
13         # users who are wiki admins
14         adminuser => [],
15         # users who are banned from the wiki
16         banned_users => [],
17         # where the source of the wiki is located
18         srcdir => '/afs/sipb.mit.edu/project/sipb-www/ikiwiki/src',
19         # where to build the wiki
20         destdir => '/afs/sipb.mit.edu/project/sipb-www/web_scripts/wiki/',
21         # base url to the wiki
22         url => 'http://sipb.mit.edu/wiki',
23         # url to the ikiwiki.cgi
24         cgiurl => 'https://sipb.mit.edu:444/wiki/ikiwiki.cgi',
25         # filename of cgi wrapper to generate
26         cgi_wrapper => '/afs/sipb.mit.edu/project/sipb-www/web_scripts/wiki/ikiwiki.cgi',
27         # mode for cgi_wrapper (can safely be made suid)
28         cgi_wrappermode => '06755',
29         # rcs backend to use
30         rcs => 'git',
31         # plugins to add to the default configuration
32         # IMPORTANT! If you add plugins that involve interface changes, you
33         # will need to modify our templates to allow this, as our custom
34         # template does not support them yet. See ~/src/ikiwiki/templates
35         add_plugins => [qw(goodstuff httpauth)],
36         # plugins to disable
37         # IMPORTANT! If you reenable passwordauth/openid, you need to
38         # do some modifications described in TODO.SIPB in the source-tree
39         disable_plugins => [qw(smiley passwordauth openid)],
40         # location of template files
41         templatedir => '/mit/sipb-www/share/ikiwiki/templates',
42         # base wiki source location
43         underlaydir => '/mit/sipb-www/share/ikiwiki/basewiki',
44         # display verbose messages when building?
45         verbose => 1,
46         # log to syslog?
47         #syslog => 1,
48         # create output files named page/index.html?
49         usedirs => 1,
50         # use '!'-prefixed preprocessor directives?
51         prefix_directives => 1,
52         # use page/index.mdwn source files
53         indexpages => 0,
54         # enable Discussion pages?
55         discussion => 0,
56         # only send cookies over SSL connections?
57         sslcookie => 0,
58         # extension to use for new pages
59         default_pageext => 'mdwn',
60         # extension to use for html files
61         htmlext => 'html',
62         # strftime format string to display date
63         timeformat => '%c',
64         # UTF-8 locale to use
65         #locale => 'en_US.UTF-8',
66         # put user pages below specified page
67         userdir => '',
68         # how many backlinks to show before hiding excess (0 to show all)
69         numbacklinks => 10,
70         # attempt to hardlink source files? (optimisation for large files)
71         hardlink => 0,
72         # force ikiwiki to use a particular umask
73         #umask => 022,
74         # group for wrappers to run in
75         #wrappergroup => 'ikiwiki',
76         # extra library and plugin directory
77         libdir => '',
78         # environment variables
79         ENV => {},
80         # regexp of source files to ignore
81         #exclude => '\\.wav$',
82         # specifies the characters that are allowed in source filenames
83         wiki_file_chars => '-[:alnum:]+/.:_',
84         # allow symlinks in the path leading to the srcdir (potentially insecure)
85         allow_symlinks_before_srcdir => 0,
86
87         # aggregate plugin
88         # enable aggregation to internal pages?
89         #aggregateinternal => 1,
90         # allow aggregation to be triggered via the web?
91         #aggregate_webtrigger => 0,
92
93         # anonok plugin
94         # PageSpec to limit which pages anonymous users can edit
95         #anonok_pagespec => '*/discussion',
96
97         # attachment plugin
98         # enhanced PageSpec specifying what attachments are allowed
99         #allowed_attachments => 'virusfree() and mimetype(image/*) and maxsize(50kb)',
100         # virus checker program (reads STDIN, returns nonzero if virus found)
101         #virus_checker => 'clamdscan -',
102
103         # bzr plugin
104         # bzr post-commit hook to generate
105         #bzr_wrapper => '',
106         # mode for bzr_wrapper (can safely be made suid)
107         #bzr_wrappermode => '06755',
108         # url to show file history, using loggerhead ([[file]] substituted)
109         #historyurl => '',
110         # url to view a diff, using loggerhead ([[file]] and [[r2]] substituted)
111         #diffurl => 'http://example.com/revision?start_revid=[[r2]]#[[file]]-s',
112
113         # calendar plugin
114         # base of the archives hierarchy
115         #archivebase => 'archives',
116
117         # camelcase plugin
118         # list of words to not turn into links
119         #camelcase_ignore => [],
120
121         # comments plugin
122         # PageSpec of pages where comments are allowed
123         #comments_pagespec => 'blog/* and !*/Discussion',
124         # PageSpec of pages where posting new comments is not allowed
125         #comments_closed_pagespec => 'blog/controversial or blog/flamewar',
126         # Base name for comments, e.g. "comment_" for pages like "sandbox/comment_12"
127         #comments_pagename => '',
128         # Interpret directives in comments?
129         #comments_allowdirectives => 0,
130         # Allow anonymous commenters to set an author name?
131         #comments_allowauthor => 0,
132         # commit comments to the VCS
133         #comments_commit => 1,
134
135         # git plugin
136         # git hook to generate
137         git_wrapper => '/mit/sipb-www/ikiwiki/src/.git/hooks/post-update',
138         # mode for git_wrapper (can safely be made suid)
139         #git_wrappermode => '06755',
140         # git pre-receive hook to generate
141         #git_test_receive_wrapper => '/git/wiki.git/hooks/pre-receive',
142         # unix users whose commits should be checked by the pre-receive hook
143         #untrusted_committers => [],
144         # gitweb url to show file history ([[file]] substituted)
145         historyurl => '/cgit/cgit.cgi/wiki/log/[[file]]',
146         # gitweb url to show a diff ([[file]], [[sha1_to]], [[sha1_from]], [[sha1_commit]], and [[sha1_parent]] substituted)
147         diffurl => '/cgit/cgit.cgi/wiki/diff/?id=[[sha1_commit]]',
148         # where to pull and push changes (set to empty string to disable)
149         #gitorigin_branch => 'origin',
150         # branch that the wiki is stored in
151         #gitmaster_branch => 'master',
152
153         # htmlscrubber plugin
154         # PageSpec specifying pages not to scrub
155         #htmlscrubber_skip => '!*/Discussion',
156
157         # inline plugin
158         # enable rss feeds by default?
159         #rss => 0,
160         # enable atom feeds by default?
161         #atom => 0,
162         # allow rss feeds to be used?
163         #allowrss => 0,
164         # allow atom feeds to be used?
165         #allowatom => 0,
166         # urls to ping (using XML-RPC) on feed update
167         pingurl => [],
168
169         # listdirectives plugin
170         # directory in srcdir that contains directive descriptions
171         #directive_description_dir => 'ikiwiki/directive',
172
173         # lockedit plugin
174         # PageSpec controlling which pages are locked
175         #locked_pages => '!*/Discussion',
176
177         # mdwn plugin
178         # enable multimarkdown features?
179         #multimarkdown => 0,
180
181         # mercurial plugin
182         # mercurial post-commit hook to generate
183         #mercurial_wrapper => '',
184         # mode for mercurial_wrapper (can safely be made suid)
185         #mercurial_wrappermode => '06755',
186         # url to hg serve'd repository, to show file history ([[file]] substituted)
187         #historyurl => 'http://example.com:8000/log/tip/[[file]]',
188         # url to hg serve'd repository, to show diff ([[file]] and [[r2]] substituted)
189         #diffurl => 'http://localhost:8000/?fd=[[r2]];file=[[file]]',
190
191         # mirrorlist plugin
192         # list of mirrors
193         #mirrorlist => {},
194
195         # openid plugin
196         # an url where users can signup for an OpenID
197         #openidsignup => 'http://myopenid.com/',
198
199         # passwordauth plugin
200         # a password that must be entered when signing up for an account
201         #account_creation_password => 's3cr1t',
202         # cost of generating a password using Authen::Passphrase::BlowfishCrypt
203         #password_cost => 8,
204
205         # pinger plugin
206         # how many seconds to try pinging before timing out
207         #pinger_timeout => 15,
208
209         # prettydate plugin
210         # format to use to display date
211         #prettydateformat => '%X, %B %o, %Y',
212
213         # recentchanges plugin
214         # name of the recentchanges page
215         recentchangespage => 'recentchanges',
216         # number of changes to track
217         recentchangesnum => 100,
218
219         # repolist plugin
220         # URIs of repositories containing the wiki's source
221         #repositories => [qw{svn://svn.example.org/wiki/trunk}],
222
223         # search plugin
224         # path to the omega cgi program
225         #omega_cgi => '/usr/lib/cgi-bin/omega/omega',
226
227         # svn plugin
228         # subversion repository location
229         #svnrepo => '/svn/wiki',
230         # path inside repository where the wiki is located
231         #svnpath => 'trunk',
232         # svn post-commit hook to generate
233         #svn_wrapper => '/svn/wikirepo/hooks/post-commit',
234         # mode for svn_wrapper (can safely be made suid)
235         #svn_wrappermode => '04755',
236         # viewvc url to show file history ([[file]] substituted)
237         #historyurl => 'http://svn.example.org/trunk/[[file]]',
238         # viewvc url to show a diff ([[file]], [[r1]], and [[r2]] substituted)
239         #diffurl => 'http://svn.example.org/trunk/[[file]]?root=wiki&r1=[[r1]]&r2=[[r2]]',
240
241         # tag plugin
242         # parent page tags are located under
243         #tagbase => 'tag',
244
245         # teximg plugin
246         # Should teximg use dvipng to render, or dvips and convert?
247         #teximg_dvipng => '',
248         # LaTeX prefix for teximg plugin
249         #teximg_prefix => '\\documentclass{article}
250         #\\usepackage{amsmath}
251         #\\usepackage{amsfonts}
252         #\\usepackage{amssymb}
253         #\\pagestyle{empty}
254         #\\begin{document}
255         #',
256         # LaTeX postfix for teximg plugin
257         #teximg_postfix => '\\end{document}',
258
259         # tla plugin
260         # tla post-commit hook to generate
261         #tla_wrapper => '',
262         # mode for tla_wrapper (can safely be made suid)
263         #tla_wrappermode => '06755',
264         # url to show file history ([[file]] substituted)
265         #historyurl => '',
266         # url to show a diff ([[file]] and [[rev]] substituted)
267         #diffurl => '',
268
269         # websetup plugin
270         # list of plugins that cannot be enabled/disabled via the web interface
271         #websetup_force_plugins => [],
272         # show unsafe settings, read-only, in web interface?
273         #websetup_show_unsafe => 1,
274 }