doc/install.mdwn

   1 The easiest way to install ikiwiki is using the Debian package, but you can
   2 also [[download]] the source and install it by hand. Ikiwiki should work on
   3 most unix-like systems.
   4
   5 ## Dependencies
   6
   7 Ikiwiki is a perl program, and needs a recent version of perl such as
   8 5.10. (5.8.0 has been reported not to work).
   9
  10 It's recommended you have a C compiler, as ikiwiki uses one to build
  11 wrappers.
  12
  13 Ikiwiki requires the [[cpan Text::Markdown]], [[cpan URI]],
  14 [[cpan HTML::Parser]], [[cpan HTML::Template]], and [[cpan HTML::Scrubber]]
  15 perl modules be installed. It can also use a lot of other perl modules, if
  16 they are available.
  17
  18 Various [[plugins]] use other perl modules and utilities; see their individual
  19 documentation for details.
  20
  21 ## Debian
  22
  23 The Debian packages depend on and recommend an appropriate set of packages,
  24 so just install ikiwiki using apt.
  25
  26 ## Fedora 7
  27
  28 While Fedora 7 doesn't have an ikiwiki package, you can install needed
  29 perl modules using this command:
  30
  31         yum install perl-Text-Markdown perl-Mail-Sendmail perl-HTML-Scrubber \
  32           perl-XML-Simple perl-TimeDate perl-HTML-Template perl-CGI-FormBuilder \
  33           perl-CGI-Session perl-File-MimeInfo perl-gettext perl-Authen-Passphrase
  34
  35 ## macports
  36
  37 IkiWiki can be installed [from macports](http://www.macports.org/ports.php?by=name&substr=ikiwiki)
  38 by running `sudo port install ikiwiki`.
  39
  40 ## Installing by hand
  41
  42 If you want to install by hand from the tarball, you should make sure that
  43 all the perl modules are installed. This is one way to install them, using
  44 CPAN:
  45
  46         PERL5LIB=`pwd` PERL_MM_USE_DEFAULT=1 perl -MCPAN -e 'CPAN::Shell->install("Bundle::IkiWiki")'
  47         PERL5LIB=`pwd` PERL_MM_USE_DEFAULT=1 perl -MCPAN -e 'CPAN::Shell->install("Bundle::IkiWiki::Extras")'
  48
  49 Then to build and install ikiwiki:
  50
  51         perl Makefile.PL # PREFIX=/dir to install elsewhere
  52         make
  53         make test # optional
  54         make install
  55
  56 If you're using a shared hosting provider, of the sort where you don't have
  57 root, you can still install ikiwiki. There are tutorials covering this for
  58 a few providers:
  59
  60 * [[tips/NearlyFreeSpeech]]
  61 * [[tips/DreamHost]]