Kaltura MediaSpace Installation and Upgrade Guide. Version: 5.0

Transcription

1 Kaltura MediaSpace Installatin and Upgrade Guide Versin: 5.0

2 Kaltura Business Headquarters 5 Unin Square West, Suite 602, New Yrk, NY, 10003, USA Tel.: Cpyright 2013 Kaltura Inc. All Rights Reserved. Designated trademarks and brands are the prperty f their respective wners. Use f this dcument cnstitutes acceptance f the Kaltura Terms f Use and Privacy Plicy.

3 Cntents Preface... 4 Abut this Guide... 4 Audience... 4 Dcument Cnventins... 4 Sectin 1 Kaltura MediaSpace Installatin Overview and Requirements... 6 Kaltura MediaSpace Installatin Wrkflw... 6 System Requirements... 6 Hardware Requirements... 7 FAQ... 7 Sectin 2 Installing Kaltura MediaSpace... 9 Sectin 3 Upgrading frm MediaSpace Versin 4.x Backup yur Existing MediaSpace Cnfiguratin Files Verify System Requirements Chse a Pssible Upgrade Methd Start the Upgrade Prcess Questins that Arise in Every Upgrade Sectin 4 Pst Installatin Steps Kaltura MediaSpace Installatin and Upgrade Guide 3

4 Preface This preface cntains the fllwing tpics: Abut this Manual Audience Dcument Cnventins Abut this Guide This guide describes hw t: Install Kaltura MediaSpace (KMS) Versin 5.0 Upgrade frm MediaSpace versin 4.0 t versin 5.0 NOTE: T upgrade frm MediaSpace 3.0 r earlier t MediaSpace 5.0, cntact yur Kaltura Prject Manager r Accunt Manager fr assistance. This guide is intended fr Kaltura MediaSpace site administratrs. NOTE: Please refer t the fficial and latest prduct release ntes fr last-minute updates. Technical supprt may be btained directly frm: Kaltura Supprt. Cntact Us: Please send yur dcumentatin-related cmments and feedback r reprt mistakes t knwledge@kaltura.cm. We are cmmitted t imprving ur dcumentatin and yur feedback is imprtant t us. Audience This manual is intended fr Kaltura MediaSpace site administratrs. Dcument Cnventins Kaltura uses the fllwing admnitins: Nte Wrkflw NOTE: Identifies imprtant infrmatin that cntains helpful suggestins. Kaltura MediaSpace Installatin and Upgrade Guide 4

5 Preface Wrkflw: Prvides wrkflw infrmatin. 1. Step 1 2. Step 2 Kaltura MediaSpace Installatin and Upgrade Guide 5

6 SECTION 1 Kaltura MediaSpace Installatin Overview and Requirements This sectin cntains the fllwing tpics: Kaltura MediaSpace Installatin Wrkflw System Requirements Hardware Requirements FAQ Kaltura MediaSpace Installatin Wrkflw The fllwing lists the steps yu shuld perfrm t install r upgrade Kaltura MediaSpace 5.0 Wrkflw: 1. Verify that yur system meets the requirements. 2. Start the installatin r upgrade prcess. 3. Install r upgrade: Install MediaSpace fr the first time. Upgrade frm MediaSpace versin Cmplete the pst installatin steps. System Requirements A Kaltura accunt (username and passwrd) Web Server Apache versin 2.2 and later Fr Zend Framewrk: md_rewrite Enable.htaccess files. Set AllwOverride t All. PHP Minimum: PHP versin and later Recmmended: PHP versin and later NOTE: PHP versin 5.4.x is nt supprted. Kaltura MediaSpace Installatin and Upgrade Guide 6

7 Kaltura MediaSpace Installatin Overview and Requirements Fr an integratin with an LDAP server (authenticatin): PHP LDAP extensin Fr the Kaltura Client library: PHP curl extensin. PHP simplexml NOTE: PHP 5 generally enables PHP simplexml by default. PHP mcrypt library needs t be installed. NOTE: This is a new requirement starting KMS versin 5. Flder permissins: The user that runs the web server must have write permissins fr the fllwing paths: {KMS_PATH}/cnfigs {KMS_PATH}/cnfigs/backups {KMS_PATH}/cache {KMS_PATH}/lgs Hardware Requirements The hardware requirements are mstly dependent n the number f cncurrent users yu expect fr yur MediaSpace setup. Assuming yu assign a dedicated server fr the KMS applicatin (nt strictly required), yu can expect: CPU: KMS is nt CPU intensive. Strage: The entire applicatin, with caching turned n, shuld nt cnsume mre than 100 megabytes f hard disk space. Memry: We estimate that a typical plain server with 3GB f memry culd supprt 100 cncurrent requests. Since nt all users are making requests every single mment they are n the system, we feel it is safe t assume that this wuld be enugh fr 1,000 cncurrent users. The nly real measure is requests and the number f users is really a guesstimate/ assumptin. FAQ Q: Can the KMS server be virtual? A: Yes Q: What prts will I need t pen inbund and utbund frm the KMS server traffic? A: 80 and 443. Q: What versin f Linux is supprted? A: Sftware requirements lay ut the different cmpnents that need t be installed. All f these cmpnents are crss-platfrm and therefre the Linux versin is irrelevant. Q: Hw much disk space and RAM des the KMS server need? A: The KMS applicatin, lgs and cache cnsume arund 53MB. Nrmal disk space in multiples f tens f GB shuld be sufficient fr this release. Kaltura MediaSpace Installatin and Upgrade Guide 7

8 Kaltura MediaSpace Installatin Overview and Requirements Lgs are written t disk and may take extra space. The lgs may either be cleaned peridically r a lg-rtate can be setup if needed. The default lg level is lw and the lgs d nt increase in size quickly. Cache files are written t disk and may take extra space. The expired cache files are deleted autmatically and the ttal space f the cache shuld nt grw drastically. Kaltura MediaSpace Installatin and Upgrade Guide 8

9 SECTION 2 Installing Kaltura MediaSpace This sectin prvides detailed instructins n hw t install Kaltura MediaSpace fr the first time. T start the installatin prcess Cntact yur Kaltura Prject Manager r Accunt Manage t receive the Kaltura MediaSpace installatin package. Extract the installatin archive cntents t yur installatin path. In the fllwing sample, the installatin path is /var/www/mediaspace. NOTE: Yur web server may be cnfigured with a dcument rt path that is different frm the path used in the example (/var/www). Refer t On yur cmmand line, enter: cd /var/www tar zxpvf MediaSpace-versin_number.tar.gz Set the required permissins. On yur cmmand line, enter: cd /var/www/mediaspace chmd 777 cnfigs cnfigs/backups cache lgs Cnfigure an Apache Virtual Hst fr Kaltura MediaSpace. The DcumentRt must pint t the public flder in the MediaSpace rt flder. NOTE: In the example in step 2, yu extracted the cntents f the MediaSpace installatin archive t /var/www/mediaspace. Therefre, the virtual hst s DcumentRt shuld pint t /var/www/mediaspace/public. Fr instructins n hw t set up a virtual hst under Apache, refer t In yur brwser, pen the virtual hst yu cnfigured (fr example, The installatin wizard checks whether system requirements are met. Kaltura MediaSpace Installatin and Upgrade Guide 9

10 Installing Kaltura MediaSpace 6. Cmplete the missing requirements as needed until all requirements are met. 7. When all requirements are met, click Install and fllw the prcedure t install MediaSpace fr the first time. T install MediaSpace fr the first time 1. On the installatin user details windw, fill in the fllwing fields and click Next. Username: Use yur Kaltura Management Cnsle (KMC) user name. Passwrd: Use yur KMC passwrd. Kaltura MediaSpace Installatin and Upgrade Guide 10

11 Installing Kaltura MediaSpace Partner ID: T find yur partner ID: Open the KMC and g t Settings>Accunt Settings. Under Accunt Inf, cpy yur Partner ID value. 2. Instance ID: Specify an Instance Identifier fr this installatin f Kaltura MediaSpace. The ID: Is an alphanumeric string Minimum 4 characters Maximum 10 characters Binds specific settings t the current instance f the applicatin Is used t unify the installatin f MediaSpace in user-level analytics (applicatin name) Is used t separate user rles between MediaSpace instances, s the same user can have different rles in different instances Cannt be changed after installatin Frce Instance ID: Select the checkbx t specify an Instance ID that is used by a previus MediaSpace instance. Depending n yur authenticatin and authrizatin cnfiguratin, Frce Instance ID enables all users wh can lg int the previus instance t lg int this MediaSpace instance. Privacy Cntext: Specify a label fr privacy cntext, used fr end-user entitlements. The label: Is an alphanumeric string Minimum 4 characters Maximum 10 characters Cannt be changed after installatin Kaltura Server URL: Fr Kaltura SaaS, use Wait until the Dne screen is displayed. Kaltura MediaSpace Installatin and Upgrade Guide 11

12 Installing Kaltura MediaSpace 3. Cmplete the pst installatin steps. Kaltura MediaSpace Installatin and Upgrade Guide 12

13 SECTION 3 Upgrading frm MediaSpace Versin 4.x Direct upgrade t MediaSpace 5 is nly supprted frm versin 4.0 and up. T upgrade frm MediaSpace 3.0 r earlier t MediaSpace 5.0, cntact yur Kaltura Prject Manager r Accunt Manager fr assistance. Upgrading is a multi stage prcess in which prcedures must be perfrmed in a particular rder. NOTE: D nt attempt t upgrade frm MediaSpace 3.0 r earlier befre cnsulting yur Kaltura representative. Wrkflw: 1. Backup yur existing MediaSpace cnfiguratin files 2. Verify that the system requirements are met. 3. Chse upgrade methd (in-place, side-by-side) and extract the archive accrdingly 4. Start the upgrade prcess by brwsing t the site 5. Cmplete the pst installatin steps. Backup yur Existing MediaSpace Cnfiguratin Files T backup yur existing MediaSpace cnfiguratin files: Cpy the fllwing cnfiguratin files as a backup frm yur existing MediaSpace installatin: {KMS_PATH}/cnfigs/cnfig.ini {KMS_PATH}/cnfigs/mdules.ini NOTE: We recmmend that yu back up the entire MediaSpace flder befre starting the upgrade prcess. Verify System Requirements Verify that yur server meets all the updated requirements fr MediaSpace 5. Chse a Pssible Upgrade Methd When upgrading t KMS 5.0 yu can chse between tw methds f upgrade. Upgrade In-Place Kaltura MediaSpace Installatin and Upgrade Guide 13

14 Upgrading frm MediaSpace Versin 4.x In this methd yu verride yur existing KMS files with the new files In this methd yu will mst likely want t have a dwn-time during the upgrade prcess, and make the site available again after the upgrade has been cmpleted. Upgrade Side-By-Side In this methd yu setup a new KMS site with the cnfiguratins f the ld ne. In this methd yur existing site can stay available fr yur users, and after the upgrade is cmpleted yu will have t switch yur server s cnfiguratin t have the new site lad when users brwse t yur existing KMS. NOTE: We recmmend that yu back up yur existing MediaSpace flder regardless f the chsen upgrade methd. T perfrm upgrade in-place, fllw these steps: Extract the MediaSpace archive smewhere n yur server. NOTE: Fr example, extract t /tmp: tar xzvf MediaSpace tar.gz /tmp/ Cpy the files frm the extracted using the rsync cmmand. in rder t make sure ld files will be deleted, use the fllwing cmmand: rsync -avc --delete /tmp/mediaspace/ {KMS_PATH}/ \ --exclude="cnfig.ini" --exclude="mdules.ini" \ --exclude="lcal.ini" --exclude="cache.ini" where {KMS_PATH} shuld be replaced with the actual path where yur existing MediaSpace is installed. Brwse t yur MediaSpace site t start the upgrade prcess. T perfrm upgrade side-by-side, fllw these steps: Extract the MediaSpace archive t yur installatin path. NOTE: Yu may fllw steps in this guide, under the Installing MediaSpace fr the First Time sectin. The side-by-side upgrade methd invlves setting up a new MediaSpace installatin. Cpy yur cnfiguratin files frm yur existing MediaSpace installatin int the new MediaSpace installatin. Fr example: cp /var/www/mediaspace/cnfigs/cnfig.ini /var/www/mediaspace_new/cnfigs/ cp /var/www/mediaspace/cnfigs/mdules.ini /var/www/mediaspace_new/cnfigs/ NOTE: Yu may als have cache.ini and lcal.ini in the same flder under yur existing MediaSpace installatin. If yu d, yu may want t cpy them ver as well. Brwse t yur MediaSpace site t start the upgrade prcess. Start the Upgrade Prcess After yu cmpleted ne f the upgrade methds and yu brwse t yur new r existing MediaSpace Kaltura MediaSpace Installatin and Upgrade Guide 14

15 Upgrading frm MediaSpace Versin 4.x installatin (depends n the upgrade methd chsen), MediaSpace perfrms the requirements verificatin. In case sme requirements fail, yu will receive a list f requirements and their statuses, and yu will have t fix the missing requirements and refresh the page. When all requirements are met and yu refresh the page yu are presented with an upgrade frm that cllects infrmatin required fr the upgrade. NOTE: The frm that is presented may include different fields depending n the versin yu are upgrading frm and t. Fill ut the frm, and click Upgrade. After the prcess is finished a cnfirmatin ntice is displayed that the prcess has cmpleted. Yu are nw able t start wrking with the upgraded MediaSpace. Kaltura MediaSpace Installatin and Upgrade Guide 15

16 Upgrading frm MediaSpace Versin 4.x Questins that Arise in Every Upgrade In every upgrade, regardless f the versin yu are upgrading frm r t, the fllwing questins may arise: Wuld yu like t autmatically upgrade the widgets used in yur MediaSpace? Chse yes if yu want the upgrade prcess t create new widgets and verride yur MediaSpace cnfiguratin with these ut-f-the bx uicnfs. If yu custmized any f the widgets, please review the release ntes and change lg t see hw t apply thse changes t yur custmized widgets. Chse n if yu d nt want the upgrade prcess t verride yur MediaSpace cnfiguratin and keep yur current widgets. In this case yu will need t update yur widgets manually by fllwing the release ntes and change lg. Kaltura MediaSpace Installatin and Upgrade Guide 16

17 SECTION 4 Pst Installatin Steps After yu install r upgrade MediaSpace: 1. Set up yur MediaSpace site. Refer t the Kaltura MediaSpace Setup Guide. 2. (Recmmended) In yur Kaltura MediaSpace Administratin Area: a. On the User Management panel ({yur MediaSpace URL}/admin/user-list), add new MediaSpace users. b. On the Cnfiguratin Management panel ({yur MediaSpace URL}/admin/), custmize yur MediaSpace cnfiguratin settings. 3. Fr custmers upgrading frm a previus versin mdify the fllwing: a. Categry Entitlements Enable the fllwing mdules frm In yur Kaltura MediaSpace Administratin Area: Categrymembers Categrymderatin b. Channel Categrizatin T be able t assciate channels t the same categry structure that is used fr media, enable the Channelcategries mdule. c. Update yur custm widgets: Main player, embed player, embedded playlist player, Facebk player versin Krecrd versin Adds supprt fr h.264 NOTE: Updating the uicnf versin can be dne via the TestMe Cnsle. If yu need assistance, cntact yur Prject Manager r supprt Create yur MediaSpace categry structure via the KMC and set the apprpriate users as wners f each categry s they can manage them frm MediaSpace. Yu can refer t the Setting up MediaSpace Categries in the KMC, in the Kaltura MediaSpace Setup Guide, fr instructins n hw t d this. Cnfigure yur MediaSpace hme page accrding t the Setting the Hme Page sectin in the Kaltura MediaSpace Setup Guide. (Optinal) Select a different style fr yur MediaSpace site. NOTE: Functinality may be limited befre yu add users and custmize required cnfiguratin settings. Kaltura MediaSpace Installatin and Upgrade Guide 17