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