web commit by ClintAdams: playing with patchqueue
[ikiwiki.git] / doc / install.mdwn
1 The easiest way to install ikiwiki is using the Debian package.
2
3 Ikiwiki is a perl program, and needs a recent version of perl such as
4 5.8.8. (5.8.0 has been reported not to work).
5
6 Ikiwiki requires [[MarkDown]] and the `HTML::Parser` perl module be
7 installed, and also uses the following perl modules if available: 
8 `CGI::Session` `CGI::FormBuilder` (version 3.02.02 or newer)
9 `HTML::Template` `Mail::Sendmail` `Time::Duration` `Date::Parse`,
10 `HTML::Scrubber`, `RPC::XML`, `XML::Simple`, `XML::Feed`.
11
12 The [[tla]] support also needs the `MailTools` perl module.
13
14 Various [[plugins]] use other libraries and utlities; see their individual
15 documentation for details.
16
17 If you're installing MarkDown by hand, note that it should be installed as
18 `Markdown.pm` somewhere in perl's module search path, or alternately as
19 `/usr/bin/markdown`. Ikiwiki will find it under either name.
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.