onsmagento

M-Turbo:MagentoE-CommerceAcceleratorDocumentationMichalUnzeitigJiíChmielM-Turbo:MagentoE-CommerceAcceleratorDocumentationMichalUnzeitigJiíChmielPublicationdate21.
6.
2010AbstractUserdocumentationforARTIOM-Turbo:MagentoE-CommerceAcceleratormodule.
Installationandusagein-structions.
iiiTableofContents1.
Introduction11.
1.
WhatisM-Turbo11.
2.
M-TurboEditions12.
InstallingM-Turbo22.
1.
Prerequisites22.
2.
InstallingM-TurboFreeEdition22.
3.
UpgradingtoPaidEditionofM-Turbo23.
CacheUsageandManaging33.
1.
OptionsTab33.
2.
URLsTab43.
3.
RegistrationTab53.
4.
PageSelectionTabs54.
FAQsandTroubleshooting64.
1.
Q:Thepageappearstobecached,butwhenatteptingtoaccessit,thebrowserre-ports"Accessforbidden"error64.
2.
Q:Thedailynightcachebuildingdoesnotwork64.
3.
Q:HowcanIidentifyifthepageiscachedandwhenwasitrecachedlasttime64.
4.
Q:Thetimeoflastcachingdoesnotmatchtherealtime61Chapter1.
Introduction1.
1.
WhatisM-TurboM-TurboisanewuniqueaccelerationmoduleforMagentoE-Commercesystem,thataimtoimprovetheMagento'sbiggestpaid-speed.
Theconceptbehindisbasedonthefact,thatmostofthepages-productviews,categorylistsorhomepagedoesnotchangetoooften.
Therefore,itisnotneededtogeneratethepageeverytimeitisaccessedfromscratchandthusrunthesophisticatedbutslowMagentoCoreeverytime.
Mostofthesepagescanbepre-cached-thatispregenerated-andthenservertothesitevisitorsastheywerestaticHTMLpages.
Thisapproachsignitifantlydescreasestimeneededtogenerateanddownloadthepagesandsavessignificantammountofserverresourcesforotheractions,thatcannotbecached.
M-TurbooffersAcceleratedimagingofcategorylist,detailofproductsandprospectivehomepage.
Thisaccelerationisworking,ifyouarenotusinganyquerystringinURLslink.
Thepagesdonotcacheforlogged-inusers.
M-Turbodoescache:sitefrontpagecategorylistsproductdetailsThepagesdocacheforSEOURLs.
TheydonotgetcachedforURLsincludingquerystringorforpersonalizedpagesforlogged-inusers.
Anyway,asstatisticallymostoftheusersbrowseyoursiteunlogged,M-Turbowillbringasignificantspeed-uptoyoursite.
1.
2.
M-TurboEditionsM-TurboAcceleratorcomesintwoeditions-freeandpaid.
Thefreeeditionhassomelimitations,suchasitdoesnotspeed-upproductdetailpages.
Also,freeeditiongeneratesafootertextwithacomponentauthorback-reference.
2Chapter2.
InstallingM-TurboTheinstallationconsistofaseveralsimplestepsandcanbedoneinatwodifferentways-usingthePEARrepositoryusedforMagentoExtensionsorbycopyingtheM-Turbomodulemanually.
Toinstallapaidedition,firstfollowstepstoinstallthefreeoneandafterwardsfollowstepstoinstallpaid.
2.
1.
PrerequisitesTocontinuefollowingthisinstalationtutorial,firstmakesurethat:youhavearunningandfunctionalMagentositethefilepermissionsaresetcorrectlytobeabletoinstalladd-ons2.
2.
InstallingM-TurboFreeEditionYouhavetwooptionshowtostartwithinstallationofthefreeedition.
YoucanmakeuseoftheMagentoExtensionsPEARrepositoryordotheinstallationmanually.
2.
2.
1.
PEAR-basedInstallationTostartinstallation,pleasevisitTADYBUDEURLtogettheextensionkey.
Inthesectionadmin-istrationinputtoSystem/MagentoConnect/MagentoConnectManagerinYourMagento.
InserttheextensionkeyandpushthebuttonInstall.
2.
2.
2.
ManuallInstallationToinstallM-Turbomanually,unzipthedistributionpackagelocallyorattheremoteserver.
ThenmakesuretomergetheappdirectoryofyourMagentositeinstallationwiththeappdirectoryintheM-Turbodistributionpackage.
Whencopyingfilestoserver,youneedtomakesurethatyouhavethewritepermissionsfortheappfolder.
2.
3.
UpgradingtoPaidEditionofM-TurboThecrucialconditionforupgradingtopaidversionistheinsertionofthevalidlicencekey(alsocalledDownloadID).
Youwillobtainthekeybasedonpurchasingthepaidversionli-censeathttp://www.
artio.
net/e-shop/magento-extensions/m-turbo-magen-to-accelerator.
Thelicensekeyissenttoyouautomaticallybye-mailafteryourpaymentisconfirmed.
Withinstanttypesofpaymentstheconfirmationprocesstakessecondstoafewminutes.
Withbanktransfers,itmaytakeevenafewdays.
Afteryoureceivethelicensekey,pleaseinsertthekeyintheMagentoadministrationasdescribedatSection3.
3,"RegistrationTab".
Ifyouinsertkeycorrectly,youwillbeabletopushtheUpgradetofullversionsituatedintheupperleftcorner.
Thisactionwillautomaticallydownloadfullversionandinstallitonyourfilesystem.
IfyouhavestandardMagentocacheswitched-off,youhavetore-enableit.
Upgradehasbeencompletedsuccessfully,whenthebuttonUpgradetofullversion,togetherwiththedemoversionnoteatleftsiteofthescreendisappears.
Youshouldalsoseenewoptionsatthe.
Inthecasethatupgradewasnotsuccessfull(inadministration,thedemoversionnotestillappearsoradminfunctionalityisnotworkigncorrectlyinanyway)andyouaresuretousevalidlicensekey,pleasecheckwritepermissionstofolderapp/code/local/Artio/MTurboandfileswithin.
Aftercheckingandupdatingthepermissions,simplypressthebuttonUpgradetofullversionagain.
Afterthenextinstallationrun,theproblemsshallbefixed.
3Chapter3.
CacheUsageandManagingYoucanaccessM-TurboadministrationbychoosingSystem→M-TurboManagementfromtheMa-gentobackendmenu.
Thereare6tabsavailableattheControlPanel.
Firstoneincludestableofpagesthatarecurrentlybeingcached.
Seconddoesincludeconfigurationoptionsaswellascontrolsforlaunchingcacherelatedactions.
Theothertwotabsincludetreeswhereyoucanchoose/limitcategoriesandproductsincludedwithin,whichyoudesiretocache.
The5thtabincludesbuttonswithactionsyoucanlaunch.
The6ththenaformtoinsertyourpaidversionlicensekey.
3.
1.
OptionsTabThistabdoesincludeseveraloptionsthatcontrolhowthecachingworksaswellasbuttonstoinitiatecache-relatedactions.
Anychangeshouldbesavedbyclickingthe"SaveConfiguration"buttonlocatedintheleft-topcornerofthepage.
3.
1.
1.
GeneralOptionsPathtocachedpagesUsingthisoptionyoucansetapathtoadirectory,wherecachedpageswillbestored.
ThepathisrelativetotheMagentorootpath.
Incaseofchange,thedirectorywillberenamedandallthecachedpageswillbemoved,sothecacheregenerationisnotneeded.
Itisimportant,thatthepathisaccessibletothewebserver.
Changeofthepathalsorequiresupdateofthepathinthe.
htaccessrootfile.
Theupdateofthepathismadeau-tomatically,howeverthe.
htaccessfilemustbewriteable.
EnablemultistoreviewM-Turboadd-onalsosupportssystemswithmorethanonestoreviewactiveincaseyouhaveactivatedthestorenameintotheURL.
(ThissettingcanbedoneinSystem→Configuration→Websites→URLOptions→AddStoreCodetoURL).
Ifthissettingisalreadyactivated,youcanactivatethissettinginM-Turbo.
Afterenablingthesetting,itisneccessarytodeleteandregenerateallcachedpages.
Enablerefreshafterproductorcat-egorysaveEnables/disablesautomaticcacherefreshonproductorcat-egorymodification.
Ifthechoiceisselected,thenaftereachsavedchangeoftheproductanewversionofcachedpageisstoredfortheproductandrelatedcategory.
Incaseofcategorychange,onlythenewcategorypagecachewillbecreated.
IncasewhenaproductorcategoryURLisaffectedbythechange,thecacheisnotregenerated.
Insuchcase,asynchronizationofcachedpageswithtableofrewritesshouldbedone-seeTO-DO.
Regeneratingcachemaytakeuptoseveralseconds,there-foreincaseofimportingmultipleproducts,itmaybebettertodisableautomaticcachegenerationtemporarily,importalltheproductsandafterwardsinitiatethenewlyimportedproductscachegeneration.
3.
1.
2.
HomepageOptionsIncludehomepageIfyouselectyes,thehomepagewillbealsocached.
Inthelistofthecachedpages,thehomepageismarketwithabackslash-"/".
CacheUsageandManaging43.
1.
3.
AutomaticCacheManagementEnableautomaticcachegenerationByselectingyes,youwillallowautomaticcachingofallURLslisted,excepttheblockedones.
Automaticcachegenerationisrunneddailyatselectedhourthroughacronscript.
Tobesureallrunsasdesired,youneedtomakesurewgetprogramisin-stalledatyoursystemandyourcronisconfiguredproperly.
DownloadtimeConfigureshourandminutewhenthecacheautogenerationisstarted.
Cachegenerationmaytakeasignificantammountoftime,somakesuretoconfigurethisforoff-peakhours,ideallyduringnighthours.
LastdownloadInformationaboutthetimewhenlastautomaticcacheregener-ationwasrun.
3.
1.
4.
ManagementActionsRemoveallcachepagesThisactionwillremoveallexistingcachedpagesincludingdi-rectories.
SynchronizewithURLRewriteTa-bleThisactionlaunchessycnronizationwithanactuallistofURLredirectofMagento.
Thesynchronizationisdoneforproductsandcategoriesmarkedtobecached.
Onlypagesofactivestore-viewsarebeingcached.
Itisrecommendedtolaunchthisactionincaseofmoresignificantchanges(productimports,storeviewadded,etc.
)YoucanseelistoftheURLsatthefirsttab.
Pagesbeingcachedaredeterminedbasedonthislist.
GeneratelistofrewriteURLstofileLaunchingthiswillgeneratealistofcachedURLsintoafile.
ThefilewillbesavedinadirectoryconfiguredunderPathtocachedpagesanditsnameisurllist.
txt.
Thisfileisusedalsoforcacheautogeneration.
Itisthereforerunnedautomati-callybeforeeachcacheautogenerationrun.
DownloadallpagesInteractivegeneratedofallpageslistedinthecachepageslist(excepttheblockedones).
Theprogressofcachingcanbemon-itoredinaseparatewindow(donotclosethiswindow).
Pleasenotethatthegenerationofallcachepagesmaytakeconsider-ableammountoftime,dependingonoverallnumberofpages.
3.
2.
URLsTabThistabcontainsalistofpagestobecached.
Allautomaticcachingisdonebasedonthislist.
ThelistispreparedbasedontheURLrewritelistoftheMagentocore.
Incasethelistisnotcomplete(e.
f.
afternewproductshasbeenadded)youcanupdatethelistbydoingthesynchronizationaction.
Anypageinthislistcanbeblockedandthuspreventedfrombeingcached.
Ifthepageisblocked,itispreventedfrombeingcachedandwillbeignoredduringthecachingprocess.
Ifyoublockanalreadycachedpage,itwillbeautomaticallyerasedfromthecache.
Table3.
1.
ListoftablecolumnsIDInternalidentifierStoreStorewherethepagebelongsRequestPathPageURLrelativetoMagentostorerootCacheUsageandManaging5CachedShowsifpageiscached(cachefileispresentonthedisc)LastRefreshTimestampofthelastpagecacherefreshStateDisplaysifpagecachingisblockedornotAttheheadofthetable,youcanfindCacheSelectedPagesbutton,thatwillinitatecachegenerationforthepagesselectedinthelist.
3.
3.
RegistrationTabThistabcontainsafieldwheretheproductlicensekey(DownloadID)canbeintered.
Tobeabletoupgradefromfreetopaidversion,thekey(DownloadID)needstobefilledincorrectly.
Themostrecommendedprocedureistousecopy+pastefunctionfromthee-mailwherethekeywassenttoyou.
Please,insertthekeyintotheprovidedfieldandconfirmtheactionbyclickingtheSaveconfigurationbuttonintheupperleftcorder.
Ifthecorrectkeywasinserted,youshouldseeyourorderdatalinkedtothekey(Name,Company,Date)andthetext:Status:OK.
Incaseoffailure,youwillseeamessagedescribingtheproblem(keynotrecognized,domainnotmatching,etc.
)3.
4.
PageSelectionTabsThelasttwotabsareusedtodefinewhatcategoriesandproductsshouldbecached.
AtthetabnamedCategories,youchoosecategoriesforwhichthelistpagesshouldbegenerated.
AtthetabnabmedProducts,youchoosecategories,wheretheproductdetailpageswillbecached.
Aftermakingthedesiredchoice,presstheSaveConfigurationbuttonandthensynchronizethelistusingtheSynchronizewithURLRewriteTableattheConfigurationtab.
6Chapter4.
FAQsandTroubleshooting4.
1.
Q:Thepageappearstobecached,butwhenat-teptingtoaccessit,thebrowserreports"Accessforbidden"errorA:Mostlikely,the.
htaccessfileismissingthethedirectorywiththecachedfiles.
Thisproblemcanbefixedbycreatingan.
htaccessfileinthedirectorycontainingthecachedfiles(defaultinvar/turbocache)withafollowingcontent:Orderdeny,allowAllowfromall4.
2.
Q:ThedailynightcachebuildingdoesnotworkA:Therecanbemultiplesourceofthisproblem.
Firstofall,makesuretocheckthatsetting"Enableautomaticcacherefresh"inmodulesettingsisenabled.
Ifthesettingsisenabled,butthecacherefresh-ingdoesnotworkanyway,makesurethattheMagentocronjobsarerunnedregularlyandthattheitsparametersaresetcorrectly-seeSystem→Configuration→Advanced→System→Cron.
Morein-structionsaboutcronsettinginMagentoisavailableathttp://www.
magentocommerce.
com/wiki/how_to/how_to_setup_a_cron_job.
4.
3.
Q:HowcanIidentifyifthepageiscachedandwhenwasitrecachedlasttimeA:Youcanfindthiseasilybycheckingthesourcecodeofthegivenpageinyourbrowser.
Ifyouseeaspecialtagattheendofthesourcecode,thenthepageiscachedandthetagincludesatimestampinformationaboutwhenthepagewascachedlasttime.
Ifyoudonotseeanysuchmarkerthere,thepageisnotbeinggeneratedfromM-Turbocache.
4.
4.
Q:ThetimeoflastcachingdoesnotmatchtherealtimeA:ThereasonforthismightbeeitherincorrectlysettimeontheserverordifferenttimezonesettingsatserverandinyourMagentoconfiguration.