improve markdown docs
[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 `Text::MarkDown`, `URI` and `HTML::Parser` perl
9 modules be installed, and also uses the following perl modules if
10 available: 
11 `CGI::Session` `CGI::FormBuilder` (version 3.02.02 or newer)
12 `HTML::Template` `Mail::Sendmail` `Time::Duration` `Date::Parse`,
13 `HTML::Scrubber`, `RPC::XML`, `XML::Simple`, `XML::Feed`, `File::MimeInfo`.
14
15 The [[tla]] support also needs the `MailTools` perl module.
16
17 Various [[plugins]] use other libraries and utlities; see their individual
18 documentation for details.
19
20 If you want to install from the tarball, you should make sure that the
21 required perl modules are installed, then run:
22
23         perl Makefile.PL # PREFIX=/dir to install elsewhere
24         make
25         make test # optional
26         make install
27
28 See [[download]] for where to get it.