Upgradinganexistinginstallation

Important:ifyouarealreadyfamiliarwithupgradinganexistingXerteinstallationsthereare
importantadditionalstepsoutlinedinthisguide.Therearealsotwomethodsoutlinedhere:
1. Easyoptionsomepreviousfileswillremainduplicatedinnewlocations
2. Cleanupgradethisinvolvesremovingnonuniquefilesbeforeapplyingtheupdatedfiles
Step1.Backupfirst.
Asalwayswhicheverofthesemethodsyouchooseyoushouldbackupyourexistingdatabaseand
directoryfirstincaseofproblems.

Easyoption
Thisistheeasiestupgradeoptionbutsomepreviousfileswillremainduplicatedasinversion2they
havebeenmovedtonewlocations
Note:Ifyourexistinginstallationisalready1.9afilenamedauth_config.phpexistsandiswherethe
authenticationmethodisset.Avoidoverwritingthisfileifyoudon'twanttorevertbacktoguest
access).
Step2.
Dropthelatestcodeoverthetopoftheexistingcodebeingcarefultomergeorprotectanylocal
customisationsorrestorethoseafterupgradee.g.auth_config.php,Static.phpstyles.cssetc
Step3.
Ifyourexistinginstallationwasolderanddidntcontainauth_config.phporwasoverwrittenthen
yourupgradewillinitiallyhaveguestaccessset.Inthiscaseitsanopportunitytotestthebasicsare
workingokviaguestaccess(e.g.createandtestanLO)beforechangingtheauthenticationbackto
yourusualmethod.
Step4.
Importantnewstep:Nowvisithttp://yourinstall/upgrade.phpThiswillcopyanyldapdetailsform
thesitedetailstabletotheldaptableaswellassettingothernewdefaultvalues.
Step5.
Changefromguesttoldaporoneoftheotherauthenticationoptionsinauth_config.phpby
commenting/uncommentingtherelevantline.
Step6.
IfyouareusingMoodleforauthenticationreadandfollowtheinstructionsinthe
moodle_integration_readmefile
Step7.
Refreshindex.phpandtestloginandcreationetcagain
Step8.
Removethefoldernamedsetupormoveitoutsideofthewebroot.

Cleanupgrade
Thismethodisverysimilartotheeasyoptionexceptthatitinvolvesremovingmostoftheexisting
installationfilesbeforeapplyingtheupgrade.
Step1.Backupfirst.
Asalwayswhicheverofthesemethodsyouchooseyoushouldbackupyourexistingdatabaseand
directoryfirstincaseofproblems.
Step2.
Removemostoftheexistinginstallationfilesbeingcarefulnottoremoveuserfilesandfiles/folders
uniquetoyourinstallation.Thelistandscreenshotbelowoutlinesthefilesandfoldersthatshould
NOTberemoved:
error_logs
Thismaycontainpreviouserrorlogswhichshouldobviouslybeinvestigatedanywaybutasthe
foldersprobablyalsohasdifferentpermissionsshouldntberemoved.
import
againthisfolderprobablyalsohasdifferentpermissionsandmaycontainimportedprojectsso
shouldntberemoved.
library
Thisfoldercanactuallyberemovedunlessyouareusingstaticauthentication.Ifyouareusingstatic
authenticationthenbackuporprotect\library\Xerte\Authentication\Static.phpasthiswillcontain
yourstaticusernamesandpasswords.
USERFILES
Thisiswherealluserprojectsaresavedanddefinitelyshouldnotberemoved.
auth_config.php
Thisiswheretheauthenticationmethodisset.Ifyourexistinginstallationcontainsandusesthisfile
thisshouldnotbeoverwritten.
database.php
Thiscontainstheuniquedatabasecredentialsforyourinstallationsobecarefulnottoremovethis
file.Note:theXerteOnlineToolkitsdownloaddoesnotcontaindatabase.phpasthisiscreated
duringinitialinstallation.

Step3.
Ifyourexistinginstallationwasolderanddidntcontainauth_config.phporwasoverwrittenthen
yourupgradewillinitiallyhaveguestaccessset.Inthiscaseitsanopportunitytotestthebasicsare
workingokviaguestaccess(e.g.createandtestanLO)beforechangingtheauthenticationbackto
yourusualmethod.
Step4.
Importantnewstep:Nowvisithttp://yourinstall/upgrade.phpThiswillcopyanyldapdetailsform
thesitedetailstabletotheldaptableaswellassettingothernewdefaultvalues.
Step5.
Changefromguesttoldaporoneoftheotherauthenticationoptionsinauth_config.phpby
commenting/uncommentingtherelevantline.
Step6.
IfyouareusingMoodleforauthenticationreadandfollowtheinstructionsinthe
moodle_integration_readmefile.
Step7.
Refreshindex.phpandtestloginandcreationetcagain.
Step8.
Removethefoldernamedsetupormoveitoutsideofthewebroot.

CommonIssues/Considerations
1.Commonconfigurationissues
Directorypermissionse.g.codecantwritetouserfiles
PHPuploadsettingse.g.maxuploadsettoosmallpreventinguploadoflargerfilessuchasvideoor
importingprojectsexportedfromanotherinstallation
MimetypesespeciallyonWindows/IISservers
xwd,rlt&rlmasmimetype'text/xml'possiblyflvtoo.
2.Generalissueswithinstallation/upgrading
ContactXertetechnicallistforfreehelpprovideasmuchinfoaspossible
http://lists.nottingham.ac.uk/mailman/listinfo/xerte