move
[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]],
9 [[cpan HTML::Parser]], and [[cpan HTML::Template]] perl modules be
10 installed.
11
12 It also uses the following perl modules if available: [[cpan
13 CGI::Session]], [[cpan CGI::FormBuilder]] (version 3.05 or newer), [[cpan
14 Mail::Sendmail]], [[cpan Time::Duration]], [[cpan TimeDate]], [[cpan
15 HTML::Scrubber]], [[cpan RPC::XML]], [[cpan XML::Simple]], [[cpan
16 XML::Feed]], [[cpan File::MimeInfo]], [[cpan Locale::gettext]] (version
17 1.04 or newer).
18
19 It's recommended you have a C compiler, as ikiwiki uses one to build
20 wrappers.
21
22 Various [[plugins]] use other libraries and utlities; see their individual
23 documentation for details.
24
25 The Debian packages depend on and recommend an appropriate set of packages.
26
27 While Fedora 7 doesn't have an ikiwiki package, you can install needed
28 perl modules using this command:
29
30         yum install perl-Text-Markdown perl-Mail-Sendmail perl-HTML-Scrubber \
31           perl-XML-Simple perl-TimeDate perl-HTML-Template perl-CGI-FormBuilder \
32           perl-CGI-Session perl-File-MimeInfo perl-gettext
33
34 If you want to install from the tarball, you should make sure that the
35 required perl modules are installed, then run:
36
37         perl Makefile.PL # PREFIX=/dir to install elsewhere
38         make
39         make test # optional
40         make install
41
42 See [[download]] for where to get it.