ikiwiki/doc/install.mdwn

49 lines
1.6 KiB
Plaintext
Raw Normal View History

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.
2006-10-28 01:48:38 +02:00
2008-05-06 01:10:42 +02:00
## Dependencies
2008-05-06 01:08:47 +02:00
2006-10-28 01:48:38 +02:00
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).
2006-10-28 01:48:38 +02:00
2008-05-06 01:08:47 +02:00
It's recommended you have a C compiler, as ikiwiki uses one to build
wrappers.
Ikiwiki requires the [[!cpan Text::Markdown::Discount]] (or
[[!cpan Text::Markdown]]), [[!cpan URI]],
2012-04-26 16:18:52 +02:00
[[!cpan HTML::Parser]], [[!cpan HTML::Template]], [[!cpan YAML::XS]] and [[!cpan HTML::Scrubber]]
perl modules be installed.
It can also use a lot of other perl modules, if
they are available.
2008-05-06 01:08:47 +02:00
Various [[plugins]] use other perl modules and utilities; see their individual
2007-09-10 07:56:45 +02:00
documentation for details.
2008-07-12 16:28:19 +02:00
### Installing dependencies by hand
2008-05-06 01:08:47 +02:00
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=`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")'
2008-07-12 16:28:19 +02:00
## Installing ikiwiki by hand
Then to build and install ikiwiki:
2006-10-28 01:48:38 +02:00
2006-11-20 12:31:23 +01:00
perl Makefile.PL # PREFIX=/dir to install elsewhere
make
2006-10-28 01:48:38 +02:00
make test # optional
2006-11-20 12:31:23 +01:00
make install
2006-10-28 01:48:38 +02:00
2008-05-06 01:08:47 +02:00
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:
2008-05-06 01:08:47 +02:00
* [[tips/NearlyFreeSpeech]]
* [[tips/DreamHost]]