]> sipb.mit.edu Git - ikiwiki.git/blobdiff - doc/install.mdwn
web commit by EthanGlasserCamp
[ikiwiki.git] / doc / install.mdwn
index e8c94361cfc8792489a38a4b632e9d24aed72f53..4c3c8bbe95203c32e36f5d05ffc1d89f14ae1532 100644 (file)
@@ -1,9 +1,31 @@
-The easiest way to install ikiwiki is using the Debian package.
+The easiest way to install ikiwiki is using the Debian package, but you can
+also [[download]] the source and install it by hand. Ikiwiki should work on
+most unix-like systems.
 
 
-If you want to install from the tarball, you should make sure that the required perl modules are installed, then run:
+Ikiwiki is a perl program, and needs a recent version of perl such as
+5.8.8. (5.8.0 has been reported not to work).
 
 
-        perl Makefile.PL
+Ikiwiki requires [[MarkDown]] and the `HTML::Parser` perl module be
+installed, and also uses the following perl modules if available: 
+`CGI::Session` `CGI::FormBuilder` (version 3.02.02 or newer)
+`HTML::Template` `Mail::Sendmail` `Time::Duration` `Date::Parse`,
+`HTML::Scrubber`, `RPC::XML`, `XML::Simple`, `XML::Feed`.
+
+The [[tla]] support also needs the `MailTools` perl module.
+
+Various [[plugins]] use other libraries and utlities; see their individual
+documentation for details.
+
+If you're installing MarkDown by hand, note that it should be installed as
+`Markdown.pm` somewhere in perl's module search path, or alternately as
+`/usr/bin/markdown`. Ikiwiki will find it under either name.
+
+If you want to install from the tarball, you should make sure that the
+required perl modules are installed, then run:
+
+        perl Makefile.PL # PREFIX=/dir to install elsewhere
         make
         make
+       make test # optional
         make install
 
         make install
 
-See [[download]] for where to get it.
\ No newline at end of file
+See [[download]] for where to get it.