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 Ikiwiki is a perl program, and needs a recent version of perl such as
   6 5.10. (5.8.0 has been reported not to work).
   7
   8 Ikiwiki requires the [[cpan Text::Markdown]], [[cpan URI]],
   9 [[cpan HTML::Parser]], [[cpan HTML::Template]], and [[cpan HTML::Scrubber]]
  10 perl modules be installed. It can also use a lot of other perl modules, if
  11 they are available.
  12
  13 It's recommended you have a C compiler, as ikiwiki uses one to build
  14 wrappers.
  15
  16 Various [[plugins]] use other libraries and utlities; see their individual
  17 documentation for details.
  18
  19 The Debian packages depend on and recommend an appropriate set of packages.
  20
  21 While Fedora 7 doesn't have an ikiwiki package, you can install needed
  22 perl modules using this command:
  23
  24         yum install perl-Text-Markdown perl-Mail-Sendmail perl-HTML-Scrubber \
  25           perl-XML-Simple perl-TimeDate perl-HTML-Template perl-CGI-FormBuilder \
  26           perl-CGI-Session perl-File-MimeInfo perl-gettext
  27
  28 If you want to install by hand from the tarball, you should make sure that
  29 all the perl modules are installed. This is one way to install them, using
  30 CPAN:
  31
  32         PERL5LIB=. PERL_MM_USE_DEFAULT=1 perl -MCPAN -e 'CPAN::Shell->install("Bundle::IkiWiki")'
  33         PERL5LIB=. PERL_MM_USE_DEFAULT=1 perl -MCPAN -e 'CPAN::Shell->install("Bundle::IkiWiki::Extras")'
  34
  35 Then to build and install ikiwiki:
  36
  37         perl Makefile.PL # PREFIX=/dir to install elsewhere
  38         make
  39         make test # optional
  40         make install
  41
  42 See [[download]] for where to get it.