Kaltura Video Package for Moodle 4.x Installation Guide

Overview

This document details the steps required to install the Kaltura Video Package 4.4.6 for Moodle 4.0 and later. Moodle 4.x supports using Kaltura Video package with both LTI 1.1 and LTI 1.3,  so you can upgrade your Moodle version into 4.x separately from upgrading the version of your LTI integration.

* If you are using Moodle 3.x, follow the instructions in the Kaltura Video Package for Moodle 3.x Installation Guide.

* If you want to upgrade your Moodle 4.x integration from LTI 1.1 to LTI 1.3 please follow the Kaltura Video Package for Moodle 4.x upgrade for LTI 1.3 guide.

Prerequisites

• A Kaltura account:
  • Partner ID (“pid”), e.g.,
  • Admin secret, e.g.,
  • Client ID from Hosted module (for LTI 1.3 only)
• A Kaltura Application Framework (KAF) instance URL, e.g., https://12345.kaf.kaltura.com
• Minimum Moodle version 4.x

KAF pre-configurations

1. Login to your KAF Configuration Management page (https://{your_KAF_base_URL}/admin).
2. Navigate to the Hosted module (https://{your_KAF_base_URL}/admin/config/tab/hosted).
3. Please select the LTI version you'd like to use and set the KAF configurations according to that.
   1. Configurations for LTI 1.1 (if you wish to use LTI 1.3 please skip this step):
      1. Set the authMethod field = “lti”.
   2. Configurations for LTI 1.3 (if you wish to use LTI 1.1 please  skip this step):
      1. Set the authMethod field = “lti1.3”. This displays the fields listed in steps 2 – 6.
      2. Set lti13PlatformOidcAuthUrl = https://{your_Moodle_domain}/local/kaltura/auth.php
      3. Set lti13AuthTokenUrl = https://{your_Moodle_domain}/mod/lti/token.php
      4. Set lti13KeysUrl = https://{your_Moodle_domain}/mod/lti/certs.php
      5. Scroll down to the LTI3service section and click the Generate key pair here.  This generates the keys.
      6. In the Certificate Generator frame, click Use to have the key pairs saved to the lti13ServicePrivateKey and lti13ServicePublicKey fields.
         
4. Scroll to the bottom of the Hosted module settings and click Save.

Installation Background

1. Local plug-in used to:
   1. Store configuration data and the Kaltura PHP client library (local/kaltura)
   2. Display the user's My Media repository (local/mymedia)
2. Video assignment module, equivalent to the video assignment type for the Kaltura plug-in for Moodle 4.x
3. Video resource module, equivalent to the video resource type for the Kaltura plug-in for Moodle 4.x
4. Filter plug-in, used to display Kaltura video embed inside rich-text markups

Installation Process

To install the Kaltura Video Package 4.4.6

1. Download the latest Kaltura Video Package to your Moodle root directory from here.
2. Unzip the downloaded file into Moodle root directory.
3. Browse to the Moodle home screen and follow the Moodle installation wizard.
   1. Click Continue at the bottom of the welcome screen.
   2. Click Continue after server check.
   3. Please wait while installation is processed. When finished, the Continue button is displayed.
   4. Fill in the relevant information and click Update Profile.
   5. Fill in settings for the front page. Click 'Save changes'.
4. Enter the Kaltura credentials (or verify that they were entered correctly) by going to the "Site Administration" area. Then search for "Kaltura package libraries" at the bar on your right-hand side. Click "Kaltura package libraries" in the search results.
   
5.  Enter the following information:
   1. KAF URI: It should have the format https://{your_KAF_URL}.   For example, https://123456.kaf.kaltura.com, or https://123456-1.kaf.kaltura.com, or https://kaltura.kaf.university.edu
      PLEASE NOTE: The "https://" is required.  Do not include an ending "/".
   2. Server URI: By default this should be www.kaltura.com . For most use cases, this should not need to change.
   3. Partner ID: This is your Kaltura account number also referred to as a Partner ID (PID). The PID can be found on the Integration Settings page of the Kaltura Management Console. For more information, see Integration Settings.
   4. Please select the LTI version you'd like to use and set the following configurations according to that:
      1. Configurations for LTI 1.1 (if you wish to use LTI 1.3 please skip this step):
         Admin Secret: This is an alphanumeric string used for integrations. The admin secret can be found on the Integration Settings page of the Kaltura Management Console. For more information, see Integration Settings.
      2. Configurations for LTI 1.3 (if you wish to use LTI 1.1 please skip this step):
         Copy the Client ID value and paste it into the KAF Hosted module's lti13ClientId setting, scroll to the bottom of the Hosted module settings and click Save.
   5. Enable Trace Logging: Checked
   6. Enable Clone Submission: Unchecked (unless needed)
   7. Click Save changes.

Set Up the Filter Plugin

To set up the filter plug in:

1. After the installation is complete, navigate to Site Administration > Plugins > Filters  > Manage Filters.  
2. Enable the Kaltura Media filter and click the Settings link.
3. Navigate to Site Administration > Plugins > Filters  > Kaltura Media. 
4. Ensure that Embed Kaltura Video Links is checked. If  not, check it.
5. Click Save.

Adding Kaltura Embed Button to text editors

TinyMCE text Editor:

The Kaltura Embed Buttons are being automatically added to the TinyMCE text editor in two places:

Atto text Editor:

To add the Kaltura embed button to the Atto text editor (Moodle 4.x)

1. Login as administrator.
2. Go to Site administration > Plugins > Text editors > Atto HTML editor > Atto toolbar settings.
3. Under Toolbar config, add “kalturamedia” at the end of the "files" buttons line separated with a comma.  For example:
   
4. Click on "Save changes" at the bottom of the page.
   The “Embed Kaltura Video” is added to the Atto editor.
   

My Media 

You can determine where to place the Kaltura My Media link. The link may be in one of the following locations:

• Top Navigation menu
• Side Navigation menu

To choose where to place the Kaltura My Media link:

1. Login as administrator.
2. Go to Site administration > Plugins > Local Plugins and select Kaltura My Media
   
3. Select where you want the Kaltura My Media link to display.

Boost Theme Support

The Boost theme may not have the ‘Navigation’ tab. The Kaltura Media Gallery will be available in other locations.
 
You can determine where to place the Kaltura Media Gallery link. The link may be in one of the following locations:

• Navigation Block
• Course setting menu

To add the link to Kaltura Media Gallery

1. Login as administrator.
2. Go to Site administration > Plugins > Local Plugins and select Kaltura Media Gallery.
3. Select where you want the Kaltura Media Gallery link to display.

Navigation Block:

Select the Navigation block for the link to appear on the left Navigation block.

Course Setting Menu:

Select Course settings for the link to appear on the course Admin settings menu:

The default display is in the Navigation block.

Adding a Block

If you have permission to add blocks to a course, you can add the Kaltura Media Gallery Block. The link to the Kaltura Media Gallery will be added to the course side pane.

To add the Kaltura Media Gallery block 

1. Navigate to the site administration.
2. Click Blocks editing on.
3. Navigate to a course, and click on the block drawer button.
4. Locate the Add a block button.
5. Under the list of blocks, choose the Kaltura Media Gallery.

The results after adding the Kaltura Media Gallery block are as follows:

Roles - Setting Permissions

This section provides information on how to set roles and permissions for users to use the Kaltura features.

The following provides steps on how to set up Kaltura permissions for each of the Moodle roles. 

To define roles

1. Log in as Moodle admin.
2. Go to Site Administration > Users > Permissions > Define Roles.

A list all of the standard roles and all custom roles is displayed.

To edit the permissions for each role

1. Select the Manage roles tab.
2. For EACH role that should be able to use the Kaltura Video Extension for Moodle, select the Gear icon to edit the role.
3. Scroll down the Edit page until you see the list of permissions (there are a many permissions).
4. Use the Filter field at the top of the permission list and type “Kaltura”.  There are a several permissions related to the Kaltura extension.
5. Set the permissions to Allow for each string that contains Kaltura and Save.

The following lists the available features/permissions:

• Block: Kaltura Media Gallery
  • Add a new Kaltura Media Gallery block to Dashboard
• Kaltura package libraries (recommended for admins only)
  • Download Kaltura trace logs
  • Migrate Kaltura Data
• Kaltura Media Gallery
  • View Kaltura Media Gallery
• Activity: Kaltura Media Assignment
  • Add a Kaltura Media Assignment
• Activity: Kaltura Video Resource
  • Add a Kaltura Video Resource
• Activity: Kaltura Media Assignment
  • Grade video submissions
  • Submit videos
• Block: Kaltura Media Gallery
  • Add a new Kaltura Media Gallery block
• My Media
  • View My Media page

Video Quiz Integration with Gradebook

To complete your Kaltura deployment, please select the LTI version you'd like to use and follow the right deployment guide:

• for LTI 1.1 please refer to Kaltura Video Quiz Moodle Gradebook Integration with LTI 1.1 Deployment Guide.
• for LTI 1.3 please refer to Kaltura Video Quiz Moodle Gradebook Integration with LTI 1.3 Deployment Guide.

Configure LTI Additional Integrations (NOTE: This setting is relevant for the Moodle Video Quiz Integration only) 

1. Go to your KAF instance and click on the Hosted module.

2. Locate the ltiAdditionalIntegrations section.

3. Click on +Add “ltiAdditionalIntegrations”.

4. Fill in the lti13PlatformOidcAuthUrl, lti13AuthTokenUrl, lti13KeysUrl, and lti13ClientId.

5. Click Save.