X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/127d97066b4e80275afd10fbdf98c683bd27eb43..4e97a8d915415e9577a65076e7aa9c2e0d0ae61a:/doc/install.mdwn diff --git a/doc/install.mdwn b/doc/install.mdwn index 170a1d93a..cc3a4c29f 100644 --- a/doc/install.mdwn +++ b/doc/install.mdwn @@ -1,41 +1,45 @@ -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. +This page documents how to install ikiwiki if a prepackaged version is not +available for your distribution, and you are faced with [[downloading|download]] +the source and installing 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 the [[cpan Text::Markdown]], [[cpan URI]], -[[cpan HTML::Parser]], [[cpan HTML::Template]], and [[cpan HTML::Scrubber]] -perl modules be installed. +## Dependencies -It also uses the following perl modules if available: [[cpan -CGI::Session]], [[cpan CGI::FormBuilder]] (version 3.05 or newer), [[cpan -Mail::Sendmail]], [[cpan TimeDate]], [[cpan RPC::XML]], -[[cpan XML::Simple]], [[cpan XML::Feed]], [[cpan File::MimeInfo]], -[[cpan Locale::gettext]] (version 1.04 or newer). +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). 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 +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. -The Debian packages depend on and recommend an appropriate set of packages. +### Installing dependencies 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: -While Fedora 7 doesn't have an ikiwiki package, you can install needed -perl modules using this command: + 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")' - 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 +## Installing ikiwiki by hand -If you want to install from the tarball, you should make sure that the -required perl modules are installed, then run: +Then to build and install ikiwiki: perl Makefile.PL # PREFIX=/dir to install elsewhere make make test # optional make install -See [[download]] for where to get it. +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]]