ikiwiki/doc/install.mdwn

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.

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).

Ikiwiki requires [[MarkDown]] and the `URI` and `HTML::Parser` perl
modules 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 test # optional
        make install

See [[download]] for where to get it.
update 2006-09-18 23:32:21 +02:00			`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.`
web commit by joey 2006-04-29 20:18:59 +02:00
note about perl version 2006-08-12 18:54:47 +02:00			`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).`

* Add missing dependency on the URI perl module. 2006-10-27 19:11:30 +02:00			Ikiwiki requires [[MarkDown]] and the `URI` and `HTML::Parser` perl
			`modules be installed, and also uses the following perl modules if`
			`available:`
* Renamed GlobLists to PageSpecs. * PageSpecs can now include nested parens, "and", and "or". This remains backwards compatible to the old GlobList format. It's implemented by treating the GlobList as a very limited microlanguage that is transformed to perl code that does the matching. * The old GlobList format is deprecated, and I encourage users to switch to using the new PageSpec format. Compatability with the old format will be removed at some point, possibly by 2.0. * Wiki rebuild needed on upgrade to this version due to PageSpec change. * Add support for creation_month and creation_year to PageSpec. Closes: #380680 * Changes to index file encoding. 2006-08-02 02:14:31 +02:00			`CGI::Session` `CGI::FormBuilder` (version 3.02.02 or newer)
web commit by JamesWestby: Correct name of Mail::Sendmail module 2006-08-27 02:32:30 +02:00			`HTML::Template` `Mail::Sendmail` `Time::Duration` `Date::Parse`,
improve 2006-08-23 22:44:26 +02:00			`HTML::Scrubber`, `RPC::XML`, `XML::Simple`, `XML::Feed`.

* Add support for tla, contributed by Clint Adama. Closes: #385936 2006-09-04 08:15:54 +02:00			The [[tla]] support also needs the `MailTools` perl module.

improve 2006-08-23 22:44:26 +02:00			`Various [[plugins]] use other libraries and utlities; see their individual`
			`documentation for details.`
web commit by joey 2006-04-29 20:20:35 +02:00
* Improve markdown loading. First, try to load it as a properl perl module, in case it was installed as one. Then fall back to trying /usr/bin/markdown. * Document in install page how to install markdown, since it has no installation procedure in the upstream tarball. 2006-08-10 06:11:58 +02:00			`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.

* Add wikitext markup plugin, which supports ".wiki" pages written in the original wiki syntax, CamelCase links and all. 2006-07-07 20:28:27 +02:00			`If you want to install from the tarball, you should make sure that the`
			`required perl modules are installed, then run:`
web commit by joey 2006-04-29 20:18:59 +02:00
more PREFIX fun 2006-08-27 19:17:54 +02:00			`perl Makefile.PL # PREFIX=/dir to install elsewhere`
web commit by joey 2006-04-29 20:18:59 +02:00			`make`
suggest running make test as part of install 2006-08-10 06:24:51 +02:00			`make test # optional`
web commit by joey 2006-04-29 20:18:59 +02:00			`make install`

* Support pinging services such as Technorati using XML-RPC to notify them about changes to rss feeds. 2006-06-27 03:13:03 +02:00			`See [[download]] for where to get it.`