Differences

This shows you the differences between two versions of the page.

--- configuration:ils:examples:koha_rest_plugin [2023/02/27 16:21] – [Installing and Configuring Koha's REST Plugin] 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 ======
-// Thanks to Mohan Pradhan for developing this documentation. //
+// Thanks to Mariyapillai Jayakananthan and Mohan Pradhan for developing this documentation. //
 ** Prerequisite **
@@ Line 43: / Line 43: @@
 </code>
-. Download the plugin:
+. Download the most up-to-date .kpz plugin file from https://github.com/NatLibFi/koha-plugin-rest-di/releases.
-https://github.com/NatLibFi/koha-plugin-rest-di/releases/download/v22.05.06/koha-plugin-rest-di-22.05.06.kpz
-. 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 'Disable.'
+. 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 'Disable.'
-Set each dropdown to 'Enable' as shown below:
+Set each dropdown (RESTBasicAuth, RESTOauth2ClientCredentials, RESTPublicAnonymousRequests and RESTPublicAPI) to 'Enable' and then click the **Save all Web service preferences** button, as shown below:
 {{ :configuration:ils:examples:screenshot3.png |}}
@@ Line 54: / Line 53: @@
 ==== Upload the Plugin ====
-Go to Home -> Administration  and click Manage Plugins. The output will be as follows:
+Go to **Home -> Administration**  and click **Manage Plugins**. The output will be as follows:
 {{ :configuration:ils:examples:screenshot4.png |}}
@@ Line 64: / Line 63: @@
 {{ :configuration:ils:examples:screenshot5.png |}}
-Choose the file ''koha-plugin-rest-di-1.2.12.kpz'', or the latest version, and click **Upload** button.
+Choose the file you downloaded earlier (the filename will be something similar to ''koha-plugin-rest-di-22.05.06.kpz''), and click the **Upload** button.
-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 **Enable**, as shown below.
 {{ :configuration:ils:examples:screenshot6.png |}}
@@ Line 84: / 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.
-To enable Plack, enter the following commands:
+To enable Plack, enter the following commands, replacing "libraryname" with the appropriate name for your own Koha instance:
 <code bash>
@@ Line 97: / Line 96: @@
 ==== Configure the EnvAuthorisation setting ====
-Add the following line as shown below in ''/etc/apache2/sites-available/<instance.conf>'':
+Add the following line as shown below in ''/etc/apache2/sites-available/<instance.conf>'' (where "instance.conf" is the Apache configuration filename for your Koha site):
 <code bash>
@@ Line 133: / Line 132: @@
 {{ :configuration:ils:examples:screenshot14.png |}}
-Note the Client ID and Secret key.
+Note the Client ID and Secret key; you will need these later when [[configuration:ils:examples:koharest_driver|configuring the KohaRest ILS driver]].
 ==== Verify whether the API is working ====
@@ Line 153: / Line 152: @@
 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 the URL:
 <code bash>