X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/b0e7e2e123079a2e68924cfb90d19c44571b1f65..96eb9bb3fa1d805df967f44d13876f57b8ea121d:/doc/install.mdwn?ds=sidebyside diff --git a/doc/install.mdwn b/doc/install.mdwn index 0aa55fb0b..22f1a3a39 100644 --- a/doc/install.mdwn +++ b/doc/install.mdwn @@ -1,14 +1,32 @@ -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]] 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` (libtimedate-perl), `HTML::Scrubber`, `RPC::XML` +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). -If you want to install from the tarball, you should make sure that the required perl modules are installed, then run: +Ikiwiki requires [[MarkDown]] and the `URI` and `HTML::Parser` 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`, `File::MimeInfo`. - perl Makefile.PL +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 +`/usr/bin/markdown`. Ikiwiki will find it under either name. + +If you want to install from the tarball, you should make sure that the +required perl modules are installed, then run: + + perl Makefile.PL # PREFIX=/dir to install elsewhere make + make test # optional make install See [[download]] for where to get it.