X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/87c1a89443308690d7c22bcf5e648ca15d7d4e8d..ec6482402c33f4027d9f39cea9d469225ca9dace:/doc/install.mdwn diff --git a/doc/install.mdwn b/doc/install.mdwn index d34de92b1..4c3c8bbe9 100644 --- a/doc/install.mdwn +++ b/doc/install.mdwn @@ -1,10 +1,20 @@ -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 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 [[MarkDown]] and the `HTML::Parser` perl module 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` +`HTML::Template` `Mail::Sendmail` `Time::Duration` `Date::Parse`, +`HTML::Scrubber`, `RPC::XML`, `XML::Simple`, `XML::Feed`. + +The [[tla]] support also needs the `MailTools` perl module. + +Various [[plugins]] use other libraries and utlities; see their individual +documentation for details. 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 @@ -13,7 +23,7 @@ If you're installing MarkDown by hand, note that it should be installed as If you want to install from the tarball, you should make sure that the required perl modules are installed, then run: - perl Makefile.PL + perl Makefile.PL # PREFIX=/dir to install elsewhere make make test # optional make install