doc/install.mdwn

   1 This page documents how to install ikiwiki if a prepackaged version is not
   2 available for your distribution, and you are faced with [[downloading|download]]
   3 the source and installing by hand. Ikiwiki should work on most unix-like
   4 systems.
   5
   6 ## Dependencies
   7
   8 Ikiwiki is a perl program, and needs a recent version of perl such as
   9 5.10. (5.8.0 has been reported not to work).
  10
  11 It's recommended you have a C compiler, as ikiwiki uses one to build
  12 wrappers.
  13
  14 Ikiwiki requires the [[!cpan Text::Markdown::Discount]] (or
  15 [[!cpan Text::Markdown]]), [[!cpan URI]],
  16 [[!cpan HTML::Parser]], [[!cpan HTML::Template]], [[!cpan YAML::XS]] and [[!cpan HTML::Scrubber]]
  17 perl modules be installed.
  18 It can also use a lot of other perl modules, if
  19 they are available.
  20
  21 In addition, Ikiwiki requires the 'gettext' package for internationalisation.
  22
  23 Various [[plugins]] use other perl modules and utilities; see their individual
  24 documentation for details.
  25
  26 ### Installing dependencies by hand
  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=`pwd` PERL_MM_USE_DEFAULT=1 perl -MCPAN -e 'CPAN::Shell->install("Bundle::IkiWiki")'
  33         PERL5LIB=`pwd` PERL_MM_USE_DEFAULT=1 perl -MCPAN -e 'CPAN::Shell->install("Bundle::IkiWiki::Extras")'
  34
  35 ## Installing ikiwiki by hand
  36
  37 Then to build and install ikiwiki:
  38
  39         perl Makefile.PL # PREFIX=/dir to install elsewhere
  40         make
  41         make test # optional
  42         make install
  43
  44 If you're using a shared hosting provider, of the sort where you don't have
  45 root, you can still install ikiwiki. There are tutorials covering this for
  46 a few providers:
  47
  48
  49 * [[tips/NearlyFreeSpeech]]
  50 * [[tips/DreamHost]]