Welcome to 2019
[ikiwiki.git] / 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 Various [[plugins]] use other perl modules and utilities; see their individual
22 documentation for details.
23
24 ### Installing dependencies by hand
25
26 If you want to install by hand from the tarball, you should make sure that
27 all the perl modules are installed. This is one way to install them, using
28 CPAN:
29
30         PERL5LIB=`pwd` PERL_MM_USE_DEFAULT=1 perl -MCPAN -e 'CPAN::Shell->install("Bundle::IkiWiki")'
31         PERL5LIB=`pwd` PERL_MM_USE_DEFAULT=1 perl -MCPAN -e 'CPAN::Shell->install("Bundle::IkiWiki::Extras")'
32
33 ## Installing ikiwiki by hand
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 If you're using a shared hosting provider, of the sort where you don't have
43 root, you can still install ikiwiki. There are tutorials covering this for
44 a few providers:
45
46
47 * [[tips/NearlyFreeSpeech]]
48 * [[tips/DreamHost]]