The foswiki svn repository will become read-only on Friday 8/8. Developers should register for a http://github.com/ account for commit access to foswiki.

A plugin I installed is not working. How can I troubleshoot it?

warning This topic was used to create System.FAQTroubleshootingExtensions in Foswiki 1.1. Please try to keep them in sync.


Some questions to answer:
  • Perhaps the plugin is installed, but did you remember to enable it in configure?
  • Did the installer mention any missing dependencies? Examine the Dependencies section of the plugin's System topic to determine if your environment has all the necessary dependencies: other Plugins/Contribs, perl libraries, 3rd-party software, etc.
    • Note that you can have the installer re-check dependencies by executing it with the "dependencies" option from the server:
      cd /path/to/my/foswiki/
      $  perl GenPDFAddOn_installer dependencies
      CGI,>=0,cpan,May be required for lib/Foswiki/Contrib/GenPDF.pm
      Data::Dumper,>=0,cpan,May be required for lib/Foswiki/Contrib/GenPDF.pm
      Error,>=0,cpan,May be required for lib/Foswiki/Contrib/GenPDF.pm
      File::Temp,>=0,cpan,May be required for lib/Foswiki/Contrib/GenPDF.pm
      htmldoc,0,external,Obtain from http://www.htmldoc.org/software.php
      
  • Check System.InstalledPlugins and look against your plugin to see if it is listed.
    • If it is listed, then it must be enabled in configure.
    • If there is an initialisation error, it will be shown and hopefully provides a clue on how to fix the problem.
  • Are you using a persistent perl environment such as Foswiki:Extensions.FastCGIEngineContrib or Foswiki:Extensions.ModPerlEngineContrib? Perhaps you need to restart your web server (apache, for example) so that the latest LocalSite.cfg changes may take effect
  • Are there any clues in the webserver's error log?
  • Are there any clues in Foswiki's warn log (on Foswiki 1.0.x, data/warnYYYYMM.txt - on Foswiki 1.1.x, default is working/logs/error.log)?
  • Perhaps the problem isn't with Foswiki itself (ie. not a problem with the plugin's perl code), but some interaction with the web server and/or web browser
    • Are there any javascript errors reported by the web browser?
      • Sometimes javascript libraries may be loaded in the wrong order. This might be due to the new ADDTOZONE feature - not all plugins have been updated to work properly. If you are on Foswiki 1.0.x, you must have the latest version of JQueryPlugin and Foswiki:Extensions.ZonePlugin installed. In Configure, disabling {OptimizePageLayout} can help.
      • Sometimes javascript libraries aren't correctly received by the web browser. You may wish to check your webserver's error log for 404 not found, 403 unauthorised etc. errors on your Foswiki's pub directory, Eg. http://foswiki.org/pub/System
        If the web server's error logs aren't readily accessible, a web browser may be used instead. Using Firefox for example, the Firebug debugging plugin can show files that failed to download in the 'net' panel. The failed files should be shown in red (eg. 404 not found, 403, 400, etc. errors). This might lead you to check filesystem permissions and perhaps webserver access controls.


Other resources

  • Check the "Tasks" page for your plugin - perhaps the issue is already known. You can check progress on the resolution and perhaps learn of some work-around. If the plugin is named EmptyPlugin, then its tasks page will be at Foswiki:Tasks.EmptyPlugin.
  • Browse existing support requests in the Support web to see if the problem you are having has an FAQ for it, or perhaps another user has worked through the same issue before as a support question. As with the Tasks system, if Foswiki:Extensions.EmptyPlugin has existing Support questions filed against it, they should be available at Foswiki:Support.EmptyPlugin

Getting Help

Support.FAQForm edit

TopicClassification FrequentlyAskedQuestion
Subject Debugging, Extension
Topic Summary Some plugins fail to work properly when they are installed. Here are some steps to get them going.
Extension
Interested Parties
Related Topics FAQTroubleshootingExtensions, InstalledPlugins, PluginsSupplement
Topic revision: r5 - 27 Dec 2011, ArthurClemens
 
The copyright of the content on this website is held by the contributing authors, except where stated elsewhere. see CopyrightStatement. Creative Commons License