X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/4eabe04ced0825d578ae83942daebda613aade1b..1bb80f7d32d43fbef4e973c09f172c811d7e33a3:/doc/install.mdwn diff --git a/doc/install.mdwn b/doc/install.mdwn index 5e3720c5e..40b7b4c5b 100644 --- a/doc/install.mdwn +++ b/doc/install.mdwn @@ -2,40 +2,55 @@ 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. +## Dependencies + 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). +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. Ikiwiki requires the [[cpan Text::Markdown]], [[cpan URI]], [[cpan HTML::Parser]], [[cpan HTML::Template]], and [[cpan HTML::Scrubber]] -perl modules be installed. +perl modules be installed. It can also use a lot of other perl modules, if +they are available. -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 -RPC::XML]], [[cpan XML::Simple]], [[cpan XML::Feed]], [[cpan -File::MimeInfo]], [[cpan Locale::gettext]] (version 1.04 or newer). +Various [[plugins]] use other perl modules and utilities; see their individual +documentation for details. -It's recommended you have a C compiler, as ikiwiki uses one to build -wrappers. +## Debian -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, +so just install ikiwiki using apt. -The Debian packages depend on and recommend an appropriate set of packages. +## 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-CGI-Session perl-File-MimeInfo perl-gettext perl-Authen-Passphrase + +## Installing by hand -If you want to install from the tarball, you should make sure that the -required perl modules are installed, then run: +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 -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]]