X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/89fccafa57ea93bbce5f0c1b5a0e275fd9911fa1..d34b9278109d017c49889d4b15295675cd518732:/doc/install.mdwn diff --git a/doc/install.mdwn b/doc/install.mdwn index 3a9885828..6fdc8bb9e 100644 --- a/doc/install.mdwn +++ b/doc/install.mdwn @@ -1,24 +1,42 @@ -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`. The 'fortune' plugin uses fortune(1). +Ikiwiki requires the [[cpan Text::Markdown]], [[cpan URI]], +[[cpan HTML::Parser]], and [[cpan HTML::Template]] perl modules be +installed. -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. +It also uses the following perl modules if available: [[cpan +CGI::Session]], [[cpan CGI::FormBuilder]] (version 3.05 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]] (version +1.04 or newer). + +It's recommended you have a C compiler, as ikiwiki uses one to build +wrappers. + +Various [[plugins]] use other libraries and utlities; see their individual +documentation for details. + +The Debian packages depend on and recommend an appropriate set of packages. + +While Fedora 7 doesn't have an ikiwiki package, you can install needed +perl modules using this command: + + yum install perl-Text-Markdown perl-Mail-Sendmail perl-HTML-Scrubber \ + perl-XML-Simple perl-TimeDate perl-HTML-Template perl-CGI-FormBuilder \ + perl-CGI-Session perl-File-MimeInfo perl-gettext 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.