X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/6dd37879bbb222d689a7570bbc14397f43e324c7..e61cf0b7dcb76cddb441850a0a7241d330541457:/doc/install.mdwn diff --git a/doc/install.mdwn b/doc/install.mdwn index e8c94361c..6fdc8bb9e 100644 --- a/doc/install.mdwn +++ b/doc/install.mdwn @@ -1,9 +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. -If you want to install from the tarball, you should make sure that the required perl modules are installed, then run: +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). - perl Makefile.PL - make - make install +Ikiwiki requires the [[cpan Text::Markdown]], [[cpan URI]], +[[cpan HTML::Parser]], and [[cpan HTML::Template]] perl modules be +installed. -See [[download]] for where to get it. \ No newline at end of file +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 # PREFIX=/dir to install elsewhere + make + make test # optional + make install + +See [[download]] for where to get it.