X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/e49ff966a39d1037ccbf168b8dbd12618cf1b41e..8d81dee4117ac6ad9ce79c4852aa82bdec79beea:/doc/install.mdwn diff --git a/doc/install.mdwn b/doc/install.mdwn index eb5b91e67..40b7b4c5b 100644 --- a/doc/install.mdwn +++ b/doc/install.mdwn @@ -1,16 +1,56 @@ -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`, -`XML::Simple`, `XML::Feed`, `HTML::Parser` +## Dependencies -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.10. (5.8.0 has been reported not to work). - perl Makefile.PL - make - make install +It's recommended you have a C compiler, as ikiwiki uses one to build +wrappers. -See [[download]] for where to get it. +Ikiwiki requires the [[cpan Text::Markdown]], [[cpan URI]], +[[cpan HTML::Parser]], [[cpan HTML::Template]], and [[cpan HTML::Scrubber]] +perl modules be installed. It can also use a lot of other perl modules, if +they are available. + +Various [[plugins]] use other perl modules and utilities; see their individual +documentation for details. + +## Debian + +The Debian packages depend on and recommend an appropriate set of packages, +so just install ikiwiki using apt. + +## Fedora 7 + +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 perl-Authen-Passphrase + +## Installing by hand + +If you want to install by hand from the tarball, you should make sure that +all the perl modules are installed. This is one way to install them, using +CPAN: + + PERL5LIB=`pwd` PERL_MM_USE_DEFAULT=1 perl -MCPAN -e 'CPAN::Shell->install("Bundle::IkiWiki")' + PERL5LIB=`pwd` PERL_MM_USE_DEFAULT=1 perl -MCPAN -e 'CPAN::Shell->install("Bundle::IkiWiki::Extras")' + +Then to build and install ikiwiki: + + perl Makefile.PL # PREFIX=/dir to install elsewhere + make + make test # optional + make install + +If you're using a shared hosting provider, of the sort where you don't have +root, you can still install ikiwiki. There are tutorials covering this for +a few providers: + +* [[tips/NearlyFreeSpeech]] +* [[tips/DreamHost]]