X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/87c1a89443308690d7c22bcf5e648ca15d7d4e8d..30cd1f80ba006e9283ae8b03c2428f1b1408c19a:/doc/install.mdwn?ds=sidebyside diff --git a/doc/install.mdwn b/doc/install.mdwn index d34de92b1..d9c2a79f7 100644 --- a/doc/install.mdwn +++ b/doc/install.mdwn @@ -1,21 +1,29 @@ -The easiest way to install ikiwiki is using the Debian package. +The easiest way to install ikiwiki is using the Debian package, but you can +also [[download]] the source and install it by hand. Ikiwiki should work on +most unix-like systems. -Ikiwiki requires [[MarkDown]] and the `HTML::Parser` perl module be +Ikiwiki is a perl program, and needs a recent version of perl such as +5.8.8. (5.8.0 has been reported not to work). + +Ikiwiki requires the [[cpan Text::Markdown]], [[cpan URI]], +[[cpan HTML::Parser]], and [[cpan HTML::Template]] perl modules be installed, and also uses the following perl modules if available: -`CGI::Session` `CGI::FormBuilder` (version 3.02.02 or newer) -`HTML::Template` `Mail::SendMail` `Time::Duration` `Date::Parse`, -`HTML::Scrubber`, `RPC::XML`, `XML::Simple`, `XML::Feed` +[[cpan CGI::Session]], [[cpan CGI::FormBuilder]] (version 3.02.02 or newer), +[[cpan Mail::Sendmail]], [[cpan Time::Duration]], [[cpan TimeDate]], +[[cpan HTML::Scrubber]], [[cpan RPC::XML]], [[cpan XML::Simple]], +[[cpan XML::Feed]], [[cpan File::MimeInfo]], [[cpan Locale::gettext]]. + +The [[tla]] support also needs the [[cpan MailTools]] perl module. -If you're installing MarkDown by hand, note that it should be installed as -`Markdown.pm` somewhere in perl's module search path, or alternately as -`/usr/bin/markdown`. Ikiwiki will find it under either name. +Various [[plugins]] use other libraries and utlities; see their individual +documentation for details. If you want to install from the tarball, you should make sure that the required perl modules are installed, then run: - perl Makefile.PL - make + perl Makefile.PL # PREFIX=/dir to install elsewhere + make make test # optional - make install + make install See [[download]] for where to get it.