Warning: This page has not been updated in over over a year and may be outdated or deprecated.
configuration:ils:examples:koha_rest_plugin
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
configuration:ils:examples:koha_rest_plugin [2023/02/27 16:19] – [Configuration at the Koha side] demiankatz | configuration:ils:examples:koha_rest_plugin [2023/05/03 16:39] (current) – [Installing and Configuring Koha's REST Plugin] demiankatz | ||
---|---|---|---|
Line 1: | Line 1: | ||
====== Installing and Configuring Koha's REST Plugin ====== | ====== Installing and Configuring Koha's REST Plugin ====== | ||
- | // Thanks to Mohan Pradhan for developing this documentation. // | + | // Thanks to Mariyapillai Jayakananthan and Mohan Pradhan for developing this documentation. // |
** Prerequisite ** | ** Prerequisite ** | ||
- | These instructions assume that you have already installed Koha version 22.05 and Mariadb 10.5.* The Koha ILS is installed on one server and VuFind will be installed on another server. | + | These instructions assume that you have already installed Koha version 22.05 in a Debian-based Linux environment. Later versions of Koha may look different from the provided screen shots, and different operating systems may have minor differences in some commands. |
+ | |||
+ | The example assumes that the Koha ILS is installed on one server and VuFind will be installed on another server. | ||
===== Configuration at the Koha side ===== | ===== Configuration at the Koha side ===== | ||
Line 41: | Line 43: | ||
</ | </ | ||
- | 2. Download the plugin: | + | 2. Download the most up-to-date .kpz plugin |
- | https:// | + | |
- | 3. In the Koha staff interface, go to: '' | + | 3. In the Koha staff interface, go to: **Home -> Koha administration -> Global system preferences -> Web services** and find the REST API section. By default, it is set to ' |
- | Set each dropdown to ' | + | Set each dropdown |
{{ : | {{ : | ||
Line 52: | Line 53: | ||
==== Upload the Plugin ==== | ==== Upload the Plugin ==== | ||
- | Go to Home -> Administration | + | Go to **Home -> Administration** and click **Manage Plugins**. The output will be as follows: |
{{ : | {{ : | ||
Line 62: | Line 63: | ||
{{ : | {{ : | ||
- | Choose the file '' | + | Choose the file you downloaded earlier (the filename will be something similar to '' |
- | When you view the Plugins list, you will see that the REST API plugin is set as DISABLED. Go to Actions at the far right and select Enable, as shown below. | + | When you view the Plugins list, you will see that the REST API plugin is set as DISABLED. Go to **Actions** at the far right and select |
{{ : | {{ : | ||
Line 82: | Line 83: | ||
Plack can increase the performance of Koha. Plack is included with Koha by default, but in some cases it may need to be enabled. Check your **About Koha** page to see if it’s running or not. | Plack can increase the performance of Koha. Plack is included with Koha by default, but in some cases it may need to be enabled. Check your **About Koha** page to see if it’s running or not. | ||
- | To enable Plack, enter the following commands: | + | To enable Plack, enter the following commands, replacing " |
<code bash> | <code bash> | ||
Line 95: | Line 96: | ||
==== Configure the EnvAuthorisation setting ==== | ==== Configure the EnvAuthorisation setting ==== | ||
- | Add the following line as shown below in ''/ | + | Add the following line as shown below in ''/ |
<code bash> | <code bash> | ||
Line 131: | Line 132: | ||
{{ : | {{ : | ||
- | Note the Client ID and Secret key. | + | Note the Client ID and Secret key; you will need these later when [[configuration: |
==== Verify whether the API is working ==== | ==== Verify whether the API is working ==== | ||
Line 151: | Line 152: | ||
If it is already enabled, disable and save it. Then enable it again and save it. | If it is already enabled, disable and save it. Then enable it again and save it. | ||
- | Now recheck again with the command: | + | Now recheck again by again trying to access |
<code bash> | <code bash> |
configuration/ils/examples/koha_rest_plugin.1677514762.txt.gz · Last modified: 2023/02/27 16:19 by demiankatz