Merge branch 'master' of ssh://git.ikiwiki.info/srv/git/ikiwiki.info

[ikiwiki.git] / doc / install.mdwn

diff --git a/doc/install.mdwn b/doc/install.mdwn
index f408e0af1b95e4517f2870ca81d607a90d3db20c..40b7b4c5b88059c16ca1422bdcb2e58dd24b0609 100644 (file)
--- a/doc/install.mdwn
+++ b/doc/install.mdwn
@@ -2,29 +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).
 
-Ikiwiki requires the [[cpan Text::Markdown]], [[cpan URI]],
-[[cpan HTML::Parser]], and [[cpan HTML::Template]] perl modules be
-installed, and 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.
 
-The [[tla]] support also needs the [[cpan MailTools]] perl module.
+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 libraries and utlities; see their individual
+Various [[plugins]] use other perl modules and utilities; see their individual
 documentation for details.
 
-If you want to install from the tarball, you should make sure that the
-required perl modules are installed, then run:
+## 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
 
-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]]