add a pointer to arch mirror
[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 [[MarkDown]] and the `HTML::Parser` perl module be
9 installed, and also uses the following perl modules if available: 
10 `CGI::Session` `CGI::FormBuilder` (version 3.02.02 or newer)
11 `HTML::Template` `Mail::Sendmail` `Time::Duration` `Date::Parse`,
12 `HTML::Scrubber`, `RPC::XML`, `XML::Simple`, `XML::Feed`.
13
14 The [[tla]] support also needs the `MailTools` perl module.
15
16 Various [[plugins]] use other libraries and utlities; see their individual
17 documentation for details.
18
19 If you're installing MarkDown by hand, note that it should be installed as
20 `Markdown.pm` somewhere in perl's module search path, or alternately as
21 `/usr/bin/markdown`. Ikiwiki will find it under either name.
22
23 If you want to install from the tarball, you should make sure that the
24 required perl modules are installed, then run:
25
26         perl Makefile.PL # PREFIX=/dir to install elsewhere
27         make
28         make test # optional
29         make install
30
31 See [[download]] for where to get it.