]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/install.mdwn
inline: Fix handling of rootpage that doesn't exist.
[git.ikiwiki.info.git] / doc / install.mdwn
index e1e071201c75bb25e9d2553b689256ea4a17302f..d745737aafe97f60d22652cf817c84047a7b8ce9 100644 (file)
@@ -1,36 +1,43 @@
-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
 5.10. (5.8.0 has been reported not to work).
 
 
 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).
 
-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.
-
 It's recommended you have a C compiler, as ikiwiki uses one to build
 wrappers.
 
 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.
 
 documentation for details.
 
-The Debian packages depend on and recommend an appropriate set of packages.
+### Installing dependencies with yum
 
 
-While Fedora 7 doesn't have an ikiwiki package, you can install needed
-perl modules using this command:
+Here's an example of how to install ikiwiki's dependencies using yum
+on Fedora 7:
 
        yum install perl-Text-Markdown perl-Mail-Sendmail perl-HTML-Scrubber \
          perl-XML-Simple perl-TimeDate perl-HTML-Template perl-CGI-FormBuilder \
 
        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 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:
 
 
 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=. PERL_MM_USE_DEFAULT=1 perl -MCPAN -e 'CPAN::Shell->install("Bundle::IkiWiki")'
-       PERL5LIB=. PERL_MM_USE_DEFAULT=1 perl -MCPAN -e 'CPAN::Shell->install("Bundle::IkiWiki::Extras")'
+       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
 
 Then to build and install ikiwiki:
 
 
 Then to build and install ikiwiki:
 
@@ -39,4 +46,9 @@ Then to build and install ikiwiki:
        make test # optional
        make install
 
        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]]