doc/plugins/contrib.mdwn

   1 Contributed [[plugins]]:
   2
   3 [[inline pages="plugins/contrib/* !*/Discussion"
   4 feedpages="created_after(plugins/contrib/navbar)" archive="yes"
   5 rootpage="plugins/contrib" postformtext="Add a new plugin named:" show=0]]
   6
   7 # Installing third party plugins
   8
   9 Most ikiwiki plugins are perl modules and should be installed somewhere in
  10 the perl module search path. See the @INC list at the end of the output of
  11 `perl -V` for a list of the directories in that path. All plugins are in
  12 the IkiWiki::Plugin namespace, so they go in a IkiWiki/Plugin subdirectory
  13 inside the perl search path. For example, if your perl looks in
  14 `/usr/local/lib/site_perl` for modules, you can locally install ikiwiki
  15 plugins to `/usr/local/lib/site_perl/IkiWiki/Plugin`
  16
  17 You can use the `libdir` configuration option to add a directory to the
  18 search path. For example, if you set `libdir` to `/home/you/.ikiwiki/`,
  19 then ikiwiki will look for plugins in `/home/you/.ikiwiki/IkiWiki/Plugins`.
  20
  21 Ikiwiki also supports plugins that are external programs. These are
  22 typically written in some other language than perl. Ikiwiki searches for
  23 these in /usr/lib/ikiwiki/plugins by default. If `libdir` is set, it will
  24 also look in that directory, for example in `/home/you/.ikiwiki/plugins`.