updated branch; this is ready for review for inclusion in IkIWiki

[git.ikiwiki.info.git] / doc / install.mdwn

diff --git a/doc/install.mdwn b/doc/install.mdwn
index 08a446fb85beae8c39b93d898615067d76e015ea..48c11272b0e0ba9fdae6dff7f68a093c4e2212a7 100644 (file)
--- a/doc/install.mdwn
+++ b/doc/install.mdwn
@@ -1,28 +1,48 @@
-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.
+
+## Dependencies

 
 Ikiwiki is a perl program, and needs a recent version of perl such as
 
 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 `Text::MarkDown`, `URI` and `HTML::Parser` perl
-modules 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`,
-`HTML::Scrubber`, `RPC::XML`, `XML::Simple`, `XML::Feed`, `File::MimeInfo`.
+It's recommended you have a C compiler, as ikiwiki uses one to build
+wrappers.

 
 

-The [[tla]] support also needs the `MailTools` perl module.
+Ikiwiki requires the [[!cpan Text::Markdown::Discount]] (or 
+[[!cpan Text::Markdown]]), [[!cpan URI]],
+[[!cpan HTML::Parser]], [[!cpan HTML::Template]], [[!cpan YAML::XS]] 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.
 
 documentation for details.
 

-If you want to install from the tarball, you should make sure that the
-required perl modules are installed, then run:
+### 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 to install modules from your local machine after you extract the ikiwiki tarball:
+
+       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")'
+
+## Installing ikiwiki by hand

 
 

-        perl Makefile.PL # PREFIX=/dir to install elsewhere
-        make
+Then to build and install ikiwiki:
+
+       perl Makefile.PL # INSTALL_BASE= PREFIX=/dir to install elsewhere
+       make

        make test # optional
        make test # optional

-        make install
+       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:
+

 
 

-See [[download]] for where to get it.
+* [[tips/NearlyFreeSpeech]]
+* [[tips/DreamHost]]