]> sipb.mit.edu Git - ikiwiki.git/blob - doc/install.mdwn
web commit by JoshTriplett
[ikiwiki.git] / doc / install.mdwn
1 The easiest way to install ikiwiki is using the Debian package, but you can
2 also [[download]] the source and install it by hand. Ikiwiki should work on
3 most unix-like systems.
4
5 Ikiwiki is a perl program, and needs a recent version of perl such as
6 5.8.8. (5.8.0 has been reported not to work).
7
8 Ikiwiki requires the [[cpan Text::MarkDown]], [[cpan URI]] and
9 [[cpan HTML::Parser]] perl modules be installed, and also uses the
10 following perl modules if available: 
11 [[cpan CGI::Session]], [[cpan CGI::FormBuilder]] (version 3.02.02 or newer),
12 [[cpan HTML::Template]], [[cpan Mail::Sendmail]], [[cpan Time::Duration]]
13 [[cpan TimeDate]], [[cpan HTML::Scrubber]], [[cpan RPC::XML]],
14 [[cpan XML::Simple]], [[cpan XML::Feed]], [[cpan File::MimeInfo]].
15
16 The [[tla]] support also needs the [[cpan MailTools]] perl module.
17
18 Various [[plugins]] use other libraries and utlities; see their individual
19 documentation for details.
20
21 If you want to install from the tarball, you should make sure that the
22 required perl modules are installed, then run:
23
24         perl Makefile.PL # PREFIX=/dir to install elsewhere
25         make
26         make test # optional
27         make install
28
29 See [[download]] for where to get it.