source/plugins.rst

   1 .. include:: images.rst
   2
   3 Plugin System
   4 =============
   5
   6 Koha's Plugin System allows for you to add additional tools and reports
   7 to Koha that are specific to your library. Plugins are installed by
   8 uploading KPZ ( Koha Plugin Zip ) packages. A KPZ file is just a zip
   9 file containing the perl files, template files, and any other files
  10 necessary to make the plugin work.
  11
  12 The plugin system needs to be turned on by a system administrator.
  13
  14 .. _set-up-label:
  15
  16 Set up
  17 -------------------------
  18
  19 To set up the Koha plugin system you must first make some changes to
  20 your install.
  21
  22 -  Change <enable\_plugins>0</enable\_plugins> to
  23    <enable\_plugins>1</enable\_plugins> in your koha-conf.xml file
  24
  25 -  Restart your webserver
  26
  27 Once set up is complete you will need to alter your
  28 :ref:`UseKohaPlugins` system preference. On the Tools
  29 page you will see the Tools Plugins and on the Reports page you will see
  30 the Reports Plugins.
  31
  32 Search History
  33 ==============
  34
  35 If you have your :ref:`EnableSearchHistory`
  36 preference set to keep your search history then you can access this
  37 information by clicking on your username in the top right of the staff
  38 client and choosing 'Search history'.
  39
  40 |image1062|
  41
  42 From this page you will see your bibliographic search history
  43
  44 |image1063|
  45
  46 And your authority search history.
  47
  48 |image1064|
  49
  50 About Koha
  51 ==========
  52
  53 The 'About Koha' area will give you important server information as well
  54 as general information about Koha.
  55
  56 -  *Get there:* More > About Koha
  57
  58 .. _server-information-label:
  59
  60 Server Information
  61 -------------------------------------
  62
  63 Under the 'Server Information' tab you will find information about the
  64 Koha version and the machine you have installed Koha on. This
  65 information is very important for debugging problems. When reporting
  66 issues to your support provider or to the various other support avenues
  67 (mailing lists, chat room, etc), it's always good to give the
  68 information from this screen. The time zone is handled via Koha or
  69 server configuration. For more information how to specify time zones per
  70 instance, see
  71 https://wiki.koha-community.org/wiki/Time_Zone_Configuration
  72
  73 |image1065|
  74
  75 .. _perl-modules-label:
  76
  77 Perl Modules
  78 -----------------------------------
  79
  80 In order to take advantage of all of the functionalities of Koha, you
  81 will need to keep your Perl modules up to date. The 'Perl Modules' tab
  82 will show you all of the modules required by Koha, the version you have
  83 installed and whether you need to upgrade certain modules.
  84
  85 |image1066|
  86
  87 Items listed in bold are required by Koha, items highlighted in red are
  88 missing completely and items highlighted in yellow simply need to be
  89 upgraded.
  90
  91 .. _system-information-label:
  92
  93 System Information
  94 -------------------------------------
  95
  96 This tab will provide you with warnings if you are using system
  97 preferences that have since been deprecated or system preferences that
  98 you have set without other required preferences
  99
 100 |image1067|