ikiwiki (3.20130711) unstable; urgency=low
[ikiwiki.git] / doc / plugins / install.mdwn
1 [[!meta title="Installing third party plugins"]]
2
3 Most ikiwiki plugins are perl modules and should be installed somewhere in
4 the perl module search path. See the @INC list at the end of the output of
5 `perl -V` for a list of the directories in that path. All plugins are in
6 the IkiWiki::Plugin namespace, so they go in a IkiWiki/Plugin subdirectory
7 inside the perl search path. For example, if your perl looks in
8 `/usr/local/lib/site_perl` for modules, you can locally install ikiwiki
9 plugins to `/usr/local/lib/site_perl/IkiWiki/Plugin`
10
11 You can use the `libdir` configuration option to add a directory to the
12 search path. For example, if you set `libdir` to `/home/you/.ikiwiki/`,
13 then ikiwiki will look for plugins in `/home/you/.ikiwiki/IkiWiki/Plugin`.
14
15 Ikiwiki also supports plugins that are external programs. These are
16 typically written in some other language than perl. Ikiwiki searches for
17 these in `/usr/lib/ikiwiki/plugins` by default. If `libdir` is set, it will
18 also look under that directory, for example in `/home/you/.ikiwiki/plugins`.
19 Note that this type of plugin has to be executable for ikiwiki to use it.