Kaltura Video Tool for Sakai Installation and Upgrade Guide. Version: 5 for Sakai 11

Size: px

Start display at page:

Download "Kaltura Video Tool for Sakai Installation and Upgrade Guide. Version: 5 for Sakai 11"

Madeleine Blankenship
5 years ago
Views:

1 Kaltura Video Tool for Sakai Installation and Upgrade Guide Version: 5 for Sakai 11

2 Kaltura Business Headquarters 250 Park Avenue South, 10th Floor, New York, NY Tel.: Copyright 2017 Kaltura Inc. All Rights Reserved. Designated trademarks and brands are the property of their respective owners. Use of this document constitutes acceptance of the Kaltura Terms of Use and Privacy Policy.

3 Contents Preface... 4 About this Guide... 4 Audience... 4 Document Conventions... 4 Prerequisites... 5 Section 1 Installation Process... 5 Installing the Kaltura Video Tool for Sakai Application... 5 Section 2 Adding the CKEditor (Rich Text Editor) Integration... 6 Section 3 Adding the Kaltura Media Gallery to Sakai Sites... 7 Section 4 Adding Kaltura My Media to Sakai MyWorkspace... 8 Section 5 Verifying that the Kaltura Admin Tool is Available... 9 Section 6 Upgrading from Kaltura Video Tool v3 to Kaltura Video Tool v Section 7 Upgrading from Kaltura Video Tool v4 to Kaltura Video Tool v Kaltura Video Tool for Sakai Installation and Upgrade Guide 3

4 Preface Preface This preface contains the following topics: About this Guide Audience Document Conventions About this Guide This guide describes how to install, configure and upgrade the Kaltura Video Tool for Sakai. NOTE: Please refer to the official and latest product release notes for last-minute updates. Technical support may be obtained directly from: Kaltura Customer Care. Contact Us: Please send your documentation-related comments and feedback or report mistakes to We are committed to improving our documentation and your feedback is important to us. Audience This guide is intended for Sakai administrators. Document Conventions Kaltura uses the following admonitions: Note Workflow NOTE: Identifies important information that contains helpful suggestions. Workflow: Provides workflow information. 1. Step 1 2. Step 2 Kaltura Video Tool for Sakai Installation and Upgrade Guide 4

5 S E C TION 1 Installation Process Prerequisites Before you begin, be certain that you have the following information for your Kaltura account: Partner id (PID) and Admin Secret for your Kaltura account. Alternatively, you can find this information in KMC under Settings à Integration Settings. A Kaltura Application Framework instance URL, for example, kaf.kaltura.com Installing the Kaltura Video Tool for Sakai Application To install the Kaltura Video Tool for Sakai application Download the Sakai-extension from github to get the latest Kaltura package. Change the Kaltura version to match the Sakai version you are using. For example: "find./ -type f -exec sed -i -e s/11-snapshot/11.2/g {} \;" Add the My Media tool (see additional instructions below) Build the Sakai extension project: mvn clean install. Shutdown your Tomcat server From the Kaltura Sakai extension run the following command to deploy to Sakai: mvn sakai:deploy -Dmaven.tomcat.home= <path to TOMCAT home> Add the following to your sakai.properties and restart your server: Fill in your partner ID, Admin Secret and KAF instance in sakai.properties,as follows: kaltura.launch.key= ###CHANGEME### --> Your partner ID kaltura.launch.secret= ###CHANGEME### --> Your admin secret kaltura.host= ###CHANGEME### --> Your KAF instance hostname (ex: kaltura.ckeditor.url= ###CHANGEME### --> partner id>.kaf.kaltura.com/browseandembed/index/browseandembed content.cleaner.default.low.security= ###CHANGEME### --> true portal.include.extrahead= ###CHANGEME### --><script type="text/javascript" language="javascript" src="/media-gallery-tool/js/kalturaupgrade.js"></script> portal.iframesuppress= ###CHANGEME append tool ids kaltura.media and kaltura.my.media ### -->:all:kaltura.media:kaltura.my.media auto.ddl= true ###only need to be on for the first server restart### Restart the Tomcat server. Kaltura Video Tool for Sakai Installation and Upgrade Guide 5

6 S E C TION 2 Adding the CKEditor (Rich Text Editor) Integration The following steps describe how to modify Sakai to allow the CK editor to integrate with the Kaltura Browse Search & Embed tool. To integrate the CKEditor Copy the "kaltura" directory into the {SAKAI_ROOT}/reference/library/src/webapp/editor/ckextraplugins Example: cp -R {KALTURA_LTI_ROOT}/ckeditor/kaltura {TOMCAT_HOME}/library/editor/ckextraplugins Edit {TOMCAT_HOME}/library/editor/ckeditor.launch.js a. At about line 158, inside the definition of "toolbar_full:", add 'kaltura' before the two references to 'Image' (these are the buttons in the toolbar): (sakai.editor.enableresourcesearch? ['AudioRecorder','ResourceSearch','Image','Movie','Table','HorizontalRule', 'Smiley','SpecialChar','fmath_formula','FontAwesome'] : ['AudioRecorder','Image','Movie','Table','HorizontalRule','Smiley','Special Char','fmath_formula','FontAwesome']), changes to: (sakai.editor.enableresourcesearch? ['AudioRecorder','ResourceSearch','kaltura','Image','Movie','Table','Horizo ntalrule','smiley','specialchar','fmath_formula','fontawesome'] : ['AudioRecorder','kaltura','Image','Movie','Table','HorizontalRule','Smiley ','SpecialChar','fmath_formula','FontAwesome']), b. At about line 232, add the following additional line: ckconfig.extraplugins+="image2,audiorecorder,movieplayer,wordcount,fmath_fo rmula,autosave,fontawesome,notification"; changes to: CKEDITOR.pluginsaddExternal('kaltura',basePath+'kaltura/','plugin.js'); ckconfig.extraplugins+="image2,audiorecorder,movieplayer,wordcount,fmath_fo rmula,autosave,fontawesome,notification,kaltura"; Kaltura Video Tool for Sakai Installation and Upgrade Guide 6

Adding the Kaltura Media Gallery to Sakai Sites S E C TION 3 Adding the Kaltura Media Gallery to Sakai Sites To add the Kaltura Media Gallery to a Sakai site Login as admin

In the resulting page, you should see one new tools named 'Media Gallery available in the list. Select the checkbox of the tool to add to your site and click Continue.

7 Adding the Kaltura Media Gallery to Sakai Sites S E C TION 3 Adding the Kaltura Media Gallery to Sakai Sites To add the Kaltura Media Gallery to a Sakai site Login as admin user or a user with maintain access permissions to a site. Enter the Sakai site and click on 'Site Info' from the left navigation pane. Click on 'Edit Tools'. In the resulting page, you should see one new tools named 'Media Gallery available in the list. Select the checkbox of the tool to add to your site and click Continue. NOTE: If the Sakai site had an existing Media Gallery tool/page added to it, then no steps are required to update the Media Gallery tool. Kaltura Video Tool for Sakai Installation and Upgrade Guide 7

8 S E C TION 4 Adding Kaltura My Media to Sakai MyWorkspace The following tasks should be performed before you deploy the Sakai-extension. To add the Kaltura My Media to the Workplace or a Sakai site Login to the tomcat server, and edit the following XML: sakai-extension/my-media-tool/src/main/webapp/tools/kaltura.my.media.xml To the XML file, Add or remove the categories relating to the sites that you wish to deploy the tool. Adding each of these lines will add the My Media to the relevant Sakai part: Sakai home/workplace (default): <category name="myworkspace" /> Sakai courses: <category name="course" /> Sakai projects: <category name="project" /> Build and deploy the sakai-extension NOTE: This step is not necessary if you want to add My Media to the workplace only, as this is the default. Kaltura Video Tool for Sakai Installation and Upgrade Guide 8

S E C TION 5 Verifying that the Kaltura Admin Tool is Available To verify that the Kaltura Video Admin Tool is available Login as admin user or a user with maintain access permissions to a site.

9 S E C TION 5 Verifying that the Kaltura Admin Tool is Available To verify that the Kaltura Video Admin Tool is available Login as admin user or a user with maintain access permissions to a site. Click on 'Sites' tool from the admin user My Workspace. Search for Admin in the Site ID field and press Enter. In the resulting page, click on the Administration Workspace link. In the Edit Site admin page, click Add/Edit pages located toward the bottom of the page. Click New Page and enter the Title as Kaltura Admin and click Tools under Continue Editing. Click New Tool. Select the radio button next to Kaltura Admin Tool (kaltura admin) and click Save under Complete the Site Edit. Go to the Administration Workspace site and on the left navigation page the Kaltura Admin Tool should be available. Kaltura Video Tool for Sakai Installation and Upgrade Guide 9

10 S E C TION 6 Upgrading from Kaltura Video Tool v3 to Kaltura Video Tool v5 Please coordinate with your Kaltura representative to schedule your content migration from previous versions. IMPORTANT NOTE: You must have Kaltura release version 3 on Sakai version 2.9 and above to upgrade to Sakai version 11.x. Please refer to the article What's New in the Kaltura Video Tool for Sakai to understand the differences between the two versions. Main updates post migration are as follows: If an entry was private in the site gallery it will be pending moderation in the Media Gallery post migration If an entry was private in a collection, it will not appear in the channel playlist Not all collections types must be migrated. You can decide which types of collection you would like to migrate to channel playlists. You will need to provide the list of collection types you would like to migrate from the following: Instructor, Community, Personal and Owner. Kaltura Video Tool for Sakai Installation and Upgrade Guide 10

11 S E C TION 7 Upgrading from Kaltura Video Tool v4 to Kaltura Video Tool v5 Remove the existing Kaltura module from the Sakai codebase and follow the steps described in the installation process to upgrade to latest version. IMPORTANT NOTE: You must have Kaltura release version 4 on Sakai version 10.x and ready to upgrade to Sakai version 11.x. No migration of content is needed. Please refer to the Sakai release notes and guides on the Knowledge Center. Kaltura Video Tool for Sakai Installation and Upgrade Guide 11

Kaltura Video App for Canvas Deployment Guide

Kaltura Video App for Canvas Deployment Guide Version: 1.0 Kaltura Video App for Canvas Deployment Guide 1 Kaltura Business Headquarters 250 Park Avenue South, 10th Floor, New York, NY 10003 Tel.: +1 800