Installation

To install Inokufu Search in your Moodle™ platform, you need to follow these four steps:

1. Create your API key. In this part, we will guide you to create your credentials to authenticate with the Learning Object API.

2. Install Services Plugin: This plugin enables your Moodle™ platform to connect with the Learning Object API using your credentials created in the first step.

3. Install Repository Plugin: This plugin enables users to search and add Learning Objects to courses. Once installed, you will see Inokufu Search as a new repository in your Moodle™ platform.

4. Install Text editor Plugin : This plugin adds a button in the text editor to easily search and add a learning object with Inokufu Search. There are currently two plugins : one for Atto text editor and one for TinyMCE.

1. Create your API key

To install the Services plugin to your Moodle™ platform, you'll need to get an API key to connect your plugin to our Learning Object API.

Here are the steps to get an API key:

Create an account

1. Go to Inokufu APIs Gateway

2. Click on "Create an account" and fill out the form. Then validate your email to finalise your registration.

Configure the API

1. Return to the login page and log in.

2. On the homepage, click on "Create an application".

   
   

3. In "Application name", make sure to mention the name of your organisation. In "Description", indicate the purpose of the API for your organisation. Click on "Next".

   
   

4. Select "simple". In type, fill in "web" and click on "Next".

   
   

5. In the search bar that appears on the next screen, select "Learning Object API".

   
   

Subscribe to a plan

1. Once the Learning Object API is selected, our price offers are displayed. If you don't know your needs yet, we advise you to select the "Quota Plan" offer and we will get back to you to study your need.

   
   

2. Click on "Subscribe". You can then leave us a comment.

   
   

3. The procedure is now complete. You can click on "Create the application".

Subscription validation

1. Find the management page of your API by clicking on "Applications" in the menu bar.

   
   

2. In the menu of this space (black bar), click on "Subscription".

3. You can check the status of your subscription. If it says "Waiting", this means that we have not yet validated your subscription.

   
   

4. When the status shows "accepted", you can retrieve your API key. You also receive an email confirming that the subscription has been validated.

5. Click on the "Accepted" status to display the box containing your API key.

   
   

If needed, you can renew your API key.

You can also end your subscription, by clicking on "Revoke".

2. Install Services plugin

Installation from ZIP

1. Download the plugin zip file from this GitHub repository.

2. Log in to your Moodle site as an administrator.

3. Navigate to Site administration > Plugins > Install plugins.

4. Upload the zip file you downloaded from this GitHub repository and follow the on-screen instructions.

5. Complete and confirm the forms to finish the plugin installation.

Installation from sources

1. Establish an SSH connection to your Moodle instance.

2. Clone the source files from this GitHub repository directly into your Moodle source files.

3. Rename the cloned folder to inokufu.

4. Move the inokufu folder into the local directory of your Moodle installation. Ensure that the plugin folder is named inokufu.

5. Open the folder in a terminal.

6. Install the Composer dependencies (you will need to install Composer if you don't have it yet).

composer install

7. Log in to your Moodle site as an administrator.

8. Navigate to Site administration > Notifications to finalize the plugin installation.

Configuration

1. After a successful installation, you should be prompted to fulfill the original configuration for the plugin (including you API key). You can still access this menu from Site administration > Plugins > Local plugins > Inokufu Services.

2. Save changes, and start using our plugin.

Note: An API Key is required in order to use this plugin. To obtain an API Key, please refer to the 1st step above or contact Inokufu Support.

3. Install Repository plugin

Installation from ZIP file

1. Download the zip file of the plugin from this link.

2. Log in to your Moodle™ platform as an administrator.

3. Go to Site Administration > Plugins > Install plugins.

4. Upload the zip file that you downloaded and follow the on-screen instructions.

5. Fill out and confirm the forms to complete the plugin installation.

Installation from Github

1. Establish a SSH connection to your Moodle™ platform.

2. Clone the source files from this GitHub repository directly into your Moodle™ platform source files.

3. Rename the cloned folder to inokufu.

4. Move the inokufu folder into the repository folder of your Moodle™ installation. Make sure the plugin folder is named inokufu.

5. Log in to your Moodle™ platform as an administrator.

6. Go to Site Administration > Notifications to finalise the plugin installation.

Configuration

1. After successful installation, navigate to Site administration > Plugins > Repositories > Manage repositories to configure the plugin settings.

2. Activate the Inokufu Search repository plugin by switching it to Enabled and visible.

3. Navigate to the plugin settings, by clicking on Settings (next to Inokufu Search and Enabled and visible), or by navigating to Site administration > Plugins > Repositories > Inokufu Search.

4. Enter the Plugin Name (Optional).

5. Save changes, and start using the repository plugin.

4. Install Text editor plugin

In order to integrate Inokufu Search into the editor of your Moodle™ platform, you need to install a second plugin.

If you are using the TinyMCE editor, please download the Inokufu Search Moodle TinyMCE plugin.

Otherwise, we recommend installing the Inokufu Search - Atto plugin.

To find out if the TinyMCE editor is enabled on your Moodle™ platform, go to Site administration > Plugins > Text editor > Editor management.

Installation from ZIP

1. Download the text editor plugin zip file:

   • For TinyMCE here,

   • Or for Atto here.

2. Log in to your Moodle™ platform as an administrator.

3. Navigate to Site administration > Plugins > Install plugins.

4. Upload the zip file you downloaded and follow the on-screen instructions.

5. Complete and confirm the forms to finish the plugin installation.

Installation from Github

1. Establish a SSH connection to your Moodle™ platform.

2. Depending the text editor you want to install:

   • For TinyMCE:

     • Clone the source files from this GitHub repository directly into your Moodle™ platform source files.

     • Move the inokufu folder into the lib/editor/tiny/plugins directory of your Moodle installation.

   • For Atto:

     • Clone the source files from this GitHub repository directly into your Moodle™ platform source files.

     • Move the inokufu folder into the lib/editor/atto/plugins directory of your Moodle installation.

3. Ensure that the plugin folder is named inokufu.

4. Log in to your Moodle site as an administrator.

5. Navigate to Site administration > Notifications to finalize the plugin installation.

Configuration

1. After successful installation, navigate to Site administration > Plugins > Text Editors > Atto Toolbar Settings to configure the plugin settings.

   
   

2. In the Toolbar Configuration text field, add a new row : search = inokufu, above the raw files = (...).

3. Save changes, and start using our atto plugin.

Inokufu Search is now installed and usable by your users. 🥳