Disable the Preferences link if no plugin with an auth hook is enabled.

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

diff --git a/doc/install.mdwn b/doc/install.mdwn
index 3a9885828ee7d8acf427f7ba4461fdd8a7959187..cc3a4c29f186ca1d0c952c28b14733dda70d0659 100644 (file)
--- a/doc/install.mdwn
+++ b/doc/install.mdwn
@@ -1,24 +1,45 @@
-The easiest way to install ikiwiki is using the Debian package.
+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).
+
+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. 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.

 
 

-Ikiwiki requires [[MarkDown]] and the `HTML::Parser` perl module 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`.  The 'fortune' plugin uses fortune(1).
+### Installing dependencies by hand

 
 

-If you're installing MarkDown by hand, note that it should be installed as
-`Markdown.pm` somewhere in perl's module search path, or alternately as
-`/usr/bin/markdown`. Ikiwiki will find it under either name.
+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:

 
 

-If you want to install from the tarball, you should make sure that the
-required perl modules are installed, then run:
+       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")'

 
 

-        perl Makefile.PL
-        make
+## Installing ikiwiki by hand
+
+Then to build and install ikiwiki:
+
+       perl Makefile.PL # 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]]