Dokumentace: M-Turbo: Magento E-Commerce Accelerator

Date: 06-07-2011

1. Představení

M-Turbo je nový a unikátní zrychlovací modul pro Magento E-Commerce systém, jehož cílem je zlepšit placenou verzi Magenta - a to především jeho rychlost. Hlavní myšlenka je založena na skutečnosti, že většina stránek - zobrazení produktů, seznam kategorií nebo homepage nejsou měněny příliš často. Magento Core proto nepotřebuje generovat stránku pokaždé, kdy je přístupná od samého začátku a tudíž běží sofistikovaně, ale pokaždé pomalu. Většinu z těchto stránek je možné před-kešovat - to je přednastaveno - a poté funguje server pro návštěvníky jako statické HTML stránky. Tento přístup významně snižuje čas potřebný k vytváření a stahování stránek a ušetří značné množství serverových zdrojů pro další akce, které nelze kešovat.

M-Turbo kešuje:

• první stránky náhledů vybraných kategorií (seznam produktů v dané kategorii)

• detaily produktů vybraných kategorií

• vybrané CMS stránky
• homepage

 

M-Turbo nekešuje:

• nic, pokud je uživatel přihlášen
• druhé, třetí a další stránky náhledů kategorií
• výsledky vyhledávání
• informace k uživatelským účtům
• košík, pokladna

Od verze 1.2.0 je možno dynamicky načítat individuální bloky. Tato funkčnost umožňuje i na kešovaných stránkách zobrazovat informace o obsahu košíku, porovnávaní produktů, ankety apod. Dále jsou plně podoporovány e-shopy s několika 'website', spouštěných z různých adresářů.

Od verze 1.2.1 je možno používat několik 'website' spouštěných z jednoho adresáře.

2. Verze a edice

M-Turbo je k dispozici ve dvou verzích - free a placené verzi. Free verze je k dispozici na Magento Connect nebo na M-Turbo product page.

Placenou verzi si můžete zakoupit na stránkách našeho e-shopu.

 

Funkce	Free verze ke stažení	Placená verze
kešování seznamu produktů	ANO	ANO
kešování detailu produktů	NE	ANO
kešování homepage	ANO	ANO
kešování CMS stránek	NE	ANO
automatická obnova	NE	ANO (pouze linux servery)
dynamicky načítané bloky	ANO	ANO
multiwebsite režim	NE (pouze 1 website)	ANO
zpětný link	ANO	NE

 

 

Historie verzí

Verze	Funkce
1.2.1	podpora systému z několika website, spouštěných z jednoho adresáře
1.2.0	podpora systému z několika website, spouštěných z různých adresářů kešování nezávislé na zvolené příponě souborů kešování cms stránek automatické přidávání kategorií, produktů a cms stránek do seznamu kešovaných entit podpora dynamických bloků kontrola kešovaných stránek z admin panelu htaccess zálohy automatický odinstalátor
1.1.1	možnost výběrů mezi 4 způsoby stahování ověření vybraného způsobu stahování z administrace možnost přebudování htaccess pravidel přímo z administrace
1.1.0	kešování seznamu a detailu produktů kešování homepage automatické noční stahování kešovaných stránek (pouze pro linuxové servery) automatické stahování kešovaných kategorií nebo produktů při uložení

 

3. Instalace a odinstalace

Instalace se skládá z několika jednoduchých kroků a může být provedena třemi způsoby -  použitím PEAR, pomocí Magento Key Extensions nebo kopírovat M-Turbo ručně.

Aktualizaci na vyšší verzi doporučujeme provést odinstalaci stávající verze a pak instalovat verzi novou. Jak odinstalovat M-Turbo je popsáno níže.

Předpoklady:
Ujistěte se nejprve, že:

• máte v provozu funkční stránky běžící na Magentu
• oprávnění jsou nastavena správně, aby bylo možné instalovat rozšíření

 

instalace free verze

Máte na výběr 3 volby, jak instalovat free verzi. Můžete použít službu Magento connect, PEAR repositář nebo provést instalaci ručně.

PEAR- založen na instalaci z komunitního kanálu

Pro instalaci z komunitního kanálu navštivte stránku rozšíření, získáte instalační klíč, který musí být napsán do Vašeho Magento Connect Manager.

PEAR- založen na instalaci z lokálního balíku

Jděte do eshopu. Pokud jste ještě nikdy nepoužili Magento Connect nebo Pear, budete potřebovat

./pear mage-setup

- if permission error occures, run the command

sudo chmod +x pear

. Run

./pear install /path/to/mturbo.tar.gz

, from your Magento root - replace /path/to/mturbo.tar.gz by the path to your MTurbo TarBall.

 

Ruční instalace

Chcete-li instalovat M-Turbo ručně, rozbalte distrIbuční soubor lokálně nebo na vzdáleném serveru. Pak se ujistěte, že došlo ke sloučení app souboru instalace  Magento s app souborem v M-Turbo.

Při kopírování souborů na server, je třeba se ujistit, že máte oprávnění k zápisu pro app složku.

Aktualizace na placenou verzi

Chcete-li provést aktualizaci na placenou verzi, musíte vložit Vaši download id do registračního pole, které je umístěno v admin panelu komponenty. Kliknutím na "Upgrade to full version" budou staženy diff soubory a free verze bude aktualizována na placenou verzi.

Máte-li zapnutou standardní Magento cache je nutné ji po upgradu obnovit. Cache lze obnovit v nabídce System > Cache Management.

Pokud po vložení správného klíče a po obnově Magento cache nedošlo k upgradu na placenou verzi, zkontrolujte práva přiřazená k adresáři app, nalézajícím se v kořenovém adresáři Vašeho Magenta. Webový server musí mít do adresáře app práva k zápisu. Po případné úpravě práv se znovu pokuste o upgrade. Pokud ani tehdy nedojde k upgrade, kontaktujte nás na support@artio.net.

přímá instalace placené verze

Po zakoupení placené verze obdržíte emailem balík obsahující aplikaci M-Turbo v podobě PEAR balíku nebo zdrojových kódů. V emailu bude dále uveden mj. licenční klíč, který si pečlivě uschovejte. Instalaci pak můžete provést buď jako lokální PEAR balík nebo manuálním zkopírováním (viz. způsoby instalace demoverze).

 

odinstalování

Od verze 1.2.0 je k dispozici automatický odinstalátor. Naleznete jej v administraci M-Turbo pod záložkou Uninstaller v levém menu. Otevřete-li ovladací panel odinstalátoru objeví se tlačítko Uninstall. Po stištění tohoto tlačítka bude M-Turbo kompletně odstraněno z Vašeho Magenta. Po odstranění nezapomeňte obnovit standardní Magento Cache (System > Cache Management).

Používáte-li M-Turbo 1.1.1 nebo starší a nainstalovali-li jste M-Turbo pomocí služby Magento Connect. Můžete jej pomocí této služby znovu odinstalovat. Upozorňujeme však, že odinstalování odstraní pouze soubory s vašeho harddisku. Záznamy v databázi zůstanou.

Pokud z jakýchkoli důvodů nemůžete použít žádný z výše popsaných způsobů odinstalování, můžete se pokusit odinstalovat M-Turbo ručně.

ruční odinstalování komponenty M-Turbo

1. Odstranění pravidel z  htaccess souboru
   

   Otevřete si ve Vašem oblíbeném textovém editoru soubor .htaccess (používejte pouze čisté textové editory nikoli Microsoft Word, OpenOficce Writer apod.). Soubor .htaccess naleznete v kořenových adresářích Vašich jednotlivých 'website'. Pravidla dopsaná komponentou M-Turbo jsou vždy uvozena následující sekvencí.

       ############################################
       ## M-Turbo Acceleration (www.artio.net)
           ... pravidla napsaná komponentou M-Turbo
       ## End M-Turbo
                       

   Smazaním pravidel provedete odstřižení Vašich stránek od kešovaných souborů. Od této chvíle budou všechny stránky generovány přímo systémem Magento.

2. Odstranění kešovaných souborů
   

   Odstraňte adresář obsahující všechny kešované soubory. Umístění adresáře záleží na Vaši volbě při prvním nastavením komponenty M-Turbo. Výchozí umístění je var/turbocache.

3. Odstranění zdrojových souborů ze složky app
   OdstranÍ tyto zdrojové soubory a adresáře:
   • app/code/local/Artio/MTurbo
   • app/design/adminhtml/default/default/layout/mturbo.xml
   • app/design/adminhtml/default/default/template/mturbo
   • app/design/frontend/default/default/layout/mturbo.xml
   • app/etc/modules/Artio_MTurbo.xml
   • app/locale/en_US/Artio_MTurbo.csv
   • skin/frontend/default/default/js/mturbo.js
4. Odstranění záznamů z databáze
   Ve vaši databázi spusťte následující příkaz:

       DROP TABLE `$PREFIXmturbo`;
       DELETE FROM `$PREFIXcore_config_data` WHERE path LIKE '%mturbo%';
       DELETE FROM `$PREFIXcore_resource` WHERE code LIKE 'mturbo_setup';
                       

   kde $PREFIX nahraďte předponou názvu tabulek Vašeho Magenta.

5. Obnovte standardní Magento cache

4. Doporučený postup práce s komponentou M-Turbo

V této kapitole naleznete doporučený postup práce s komponentou M-Turbo. Tento dokument slouží hlavně pro prvotní pochopení a orientaci v ovládání této komponenty. Pro většinu uživatelů by měl být tento návod dostačující. Více informací o možnostech nastavení této komponenty je k dispozici v kapitole Referenční příručka, ve které byste měli nalézt všechny podstatné informace. Pokud máte nějaké problémy nebo dotazy, řešení můžete zkusit najít v kapitole FAQ and Troubleshooting.

Jak M-Turbo pracuje?

Chcete-li opravdu efektivně využívat komponentu M-Turbo je dobré mít alespoň hrubé podvědomí o tom, jak pracuje. Komponenta M-Turbo provádí tzv. "full page caching". Tento způsob kešovaní se vyznačuje tím, že cílová stránka je stažena na hardisk serveru a uživatelům je pak nabízena jako obyčejný statický html soubor. Díky tomu, že není prováděno žádné generování a ani žádný výpočet je zobrazování stránky rapidně urychleno.

Nevýhodou tohoto postupu je, že informace na stránce nejsou přímo obnovovány. "Full page caching" je proto vhodný jen pro takové stránky, u kterých se nepředpokládá žádná nebo častá změna. V Magentu se jedná typicky o seznamy produktů, detaily produktů a statické stránky. Stránky, jejichž obsah je z principu neustále měněn (košík, pokladna, uživatelský účet, výsledky hledaní apod.) takto kešovat nelze a jsou proto z možnosti kešování vyloučeny.

Problém mohou představovat části stránky poskytující uživateli určité dodatečné informace. Typickým představitelem takovýchto částí je blok, který informuje uživatele o produktech v košíku. Pro tyto případy je od verze 1.2.0 k dispozici mechanismus, provádějící dodatečné požadavky na server s cílem stáhnout tyto části stránky. V praxi to pak funguje tak, že nejprve je k uživateli stažena stránka a následně se pomocí AJAXu provede načtení takto dynamicky nahrávaných bloků. Ve výchozím nastavení jsou takto zobrazovány následující bloky: košík, porovnání produktů, anketa, odkaz zobrazující počet produktů v košíku. Dodatečně lze přidávat i další části. Nicméně přidávání uživatelských bloků do seznamu dynamicky stahovaných částí již není úplně triviální záležitost a vyžaduje určitou znalost v oblasti designovaní Magenta (konkrétně problematiku tzv. layoutů).

Kešování komponenty M-Turbo nepracuje správně tehdy, pokud je obsah stránky rozměrný popř. špatně nakódován. Typickým problémem je kombinace velkého množství kategorií a JavaScriptového menu. Vygenerování menu s velkým počtem kategorií je pro webový prohlžeč samo o sobě časově náročné. Při velkém množství kategorií doporučujeme omezit hloubku vygenerovaného menu.

aktualizace stránek

Kešované stránky je nutné občas aktualizovat. Např., když se změní cena produktu apod. Existují dvě strategie aktualizace. První, kdy jsou všechny stránky aktualizovány každý den v přesně stanoveném čase. Druhá strategie je cílená. Příslušná stránka se zaktualizuje při jakékoli změně jejího obsahu. Změníte-li např. cenu produktu, popisek kategorie, obsah CMS stránky apod., automaticky se příslušné stránky zaktualizují.

Cílená strategie je ve výchozím nastavení povolena. První strategii si však musíte aktivovat. Níže je popsáno 8 kroků, které musíte provést.

Jak nastavit Magento pro M-Turbo?

Komponenta M-Turbo vyžaduje zapnutí tzv. web server rewrites. Zapnutí provedete v konfiguraci systému Magento v nabídce System > Configuration > Web > Search Engines Optimization > Use Web Server Rewrites.

Pro správnou funkčnost automatického stahování je nutné mít korektně nastaven cron. Jak nastavit cron můžete přečíst například zde http://www.magentocommerce.com/wiki/how_to/how_to_setup_a_cron_job.

Vztah komponenty M-Turbo ke standardní Magento Cache

Standardní Magento Cache žádným způsobem neovlivňuje funkci komponenty M-Turbo. A to platí i obráceně. Při používání komponenty M-Turbo doporučujeme mít zapnutou standardní Magento Cache.

M-Turbo - instalace a nastavení

1. instalace

   Instalaci můžete provést podle jednoho z výše uvedených návodů. O úspěšné instalaci budete informováni následující zprávou:

   

   V případě selhání instalace se objeví hlášení o chybě. V takovém to případě tuto chybu pečlivě okopírujte a kontaktujte nás na support@artio.net.

   Pokud se po instalaci neobjeví žádné hlášení je možné, že instalace vůbec neproběhla. Tato situace může nastat pokud jste měli dříve nainstalovánou starší verzi komponenty M-Turbo a ta nebyla zcela odstraněna. Pokuste se provést důkladnou odinstalaci podle výše zmíněného návodu.

2. Prvotní konfigurace

   Nainstalovali-li jste M-Turbo můžete přejít k prvotní konfiguraci. Pomocí hlavního menu System > M-Turbo Management otevřte administraci M-Turbo. Uvidíte následující obrazovku:

   
   

   Prvotní konfigurace spočívá ve specifikaci licenčního klíče, adresáře s uloženými kešovanými stránkami a nastavení jednotlivých website. Adresář s kešovanými stránkami volte tak, aby webový server měl k němu práva zápisu. Nevolte adresář kolidující s některým systémovým Magento adresářem. Base Directory u jednotlivých website doporučujeme nechat výchozí. Korekci proveďte pouze v případě, kdy opravdu víte, že zobrazená cesta neodpovídá umístění Vaši website.

   U free verze je pouze jedna výchozí website. Textové pole pro vložení licenčního klíče zde není, protože ve free verzi není aktivace licenčním klíčem potřeba.

   Nebudete-li si jisti některým nastavením, nemějte obavy, veškeré vložené údaje bude možno později změnit.

   Po nastavení stiskněte tlačítko Uložit a Instalovat. M-Turbo provede vytvoření zvoleného adresáře a automaticky provede přepracování htaccess pravidel. Po úspěšné prvotní konfiguraci uvídíte následující obrazovku:

   

3. kontrola pravidel Htaccess, stahování

   Po úspěšné instalaci je vhodné provést kontrolu, zda byly zachovány pravidla v .htaccess souboru. Užitečné je také zkontrolovat, jestli stažené stránky pracují správně. Kontrolu stahování můžete provést na ovládacím panelu Main Configuration.

   

    

   Uvidíte-li na pozici (2) zelený nápis OK, znamená to, že stažení testovací stránky proběhlo v pořádku. V případě červeného nápisu FAIL se pokuste změnit metodu stahování pomocí roletky (1). K dispozici máte celkem čtyři možnosti. Pokud v případě ani jedné metody nedojde k úspěšnému stažení, prosím kontaktujte nás na support@artio.cz. Podrobnější popis možností stahování naleznete níže v referenční příručce.

   Kontrolu .htaccess pravidel provedete na ovládacím panelu Websites Configuration.

   

   Nachází-li se na pozici (B) nápis yes a na pozici (C) zelený nápis Ready,  pak byly pravidla do souboru .htaccess správně vložena. V případě problému nebo změny nastavení můžete přebudovat pravidla stiskem tlačítka (D). Pokud se ve Vaši administraci tlačítko (D) nenachází, pak je zřejmě problém se souborem .htaccess. Možné příčiny jsou buď 1) soubor .htaccess nebyl nalezen (na pozci (C) se v tomto případě objeví červený nápis Not found), 2) webový server nemá práva zápisu do souboru .htaccess (na pozici (C) se objeví červený nápis Not writeable). Soubor .htaccess je vždy hledán na cestě zobrazena na pozici (A).

    

4. Výběr kešovaných stránek

   Po kontrole stahování a přítomnosti pravidel v htaccess souboru, můžete přistoupit k volbě stránek určených ke kešování. V komponentě M-Turbo existují tři druhy kešovaných stránek (náhledy kategorií, detaily produktů, statické CMS stránky). Každý druh má v rámci administrace komponenty M-Turbo svůj vlastní ovládací panel.

   

   Náhledy kategorií představují seznam produktů v této kategorii. Tyto seznamy jsou nejvíce navštěvované stránky. Náhledy kategorií se myslí seznamy produktů v dané kategorií. Tyto seznamy jsou nejčastěji navštěvované stránky. Je proto vhodné tyto stránky kešovat vždy. Kešování můžete povolit/zakázat pro každou kategorie zvlášť. Povolení kešování provedete zatržením příslušné kategorie ve stromě (D) na ovládacím panelu. Přejete-li si, aby každá nově vytvořena kategorie byla přidavaná automaticky do výběru, nastavte volbu (A) na ano.
   
   

   

   Kešování detailů produktů je k dispozici pouze v placené verzi. Vždy berte v úvahu, které produkty má smysl kešovat a které ne. V případě velkého množství produktů v databázi, nedoporučujeme kešovat všechny. Výběr produktu je proveden pomocí kategorie. Nelze tedy vybírat jednotlivé produkty zvláště, ale vždy vybírate kategorii jejichž detaily produktů se budou kešovat. V případě, že produkt spadá do více kategorií jsou vždy automaticky kešovány všechny varianty. Volba kategorií se provádí stejně jako v předchozím případě, zatrhnutím příslušné kategorie v stromě (D) na ovladacím panelu. Přejete-li si, aby každá nově vytvořena kategorie byla přidavaná automaticky do výběru nastavte volbu (A) na ano.

   

    

   CMS stránky jsou stránky, které jsou editovatelné v administraci CMS > Pages. Mezi CMS stránky patří i homepage. Ve free verzi není kešování jiných CMS stránek než homepage dovoleno. Každá CMS stránka může mít několik variant podle počtu storeviews. Volbu kešovaných stránek provedete na ovladacím panelu. Po zaškrtnutí určité stránky (C) se automaticky rozbalí nabídky se všemi variantami pro jednotlivá storeview, kde je můžete zakazovat nebo povolovat. Přejete-li si aby každá nově vytvořena CMS stránka byla přidavaná automaticky do výběru nastavte volbu (A) na ano. V seznamu CMS stránek se nikdy nenabízí stránka označena jako no-route.

5. Synchronizace - vytvoření seznamu kešovaných stránek

   Je důležité provést synchronizaci po výběru kešovaných stránek. Synchronizace vytváří seznam stránek určených ke kešování. Tento seznam je založen na Vašem výběru. Synchronizace spustíte tlačítkem Synchronization (B) na seznamu stránek.

   

   Synchronizace je poměrně časově náročný proces. Čas strávený na synchronizaci závisí na počtu kešovaných stránek. V případě velkého množství kešovaných stránek může synchronizace trvat i několik desítek sekund.

6. kešování

   Po synchronizaci můžete přejít k samotnému kešování. Kešování je proces, kdy stažené stránky jsou uloženy jako HTML soubor na serveru. Nejjednodušší způsob, jak kešovat všechny stránky, je vybrat všechny položky na seznamu a zmáčknout tlačítko Cache selected pages (A, v předchozím obrázku).

   Stav kešování lze sledovat v novém okně. Toto okno zavřete až budou všechny stránky nakešovány. Čas potřebný ke kešování závisí na počtu kešovaných stránek a také na rychlosti serveru. Řádově se jedná o minuty. V případě opravdu velkého počtu stránek však může jít i o desítky minut.

   Stažené stránky můžete zkontrolovat přímo na seznamu stránek. Pro každou položku/stránku je zobrazena velikost a čas posledního stažení. Vizuální kontrolu kešovaných stránek můžete provést kliknutím na odkaz preview.

7. ověření funkčnosti komponenty M-Turbo

   Pomocí časové značky umístěné na konci zdrojového kódu, můžete zkontrolovat, zda stránka pochází opravdu z M-Turbo cache. Otevřte kontrolovanou stránku ve Vašem oblíbeném prohlížeči. Stiskněte pravé tlačítko myši a vyberte možnost View source code, popřípadě jinou podobnou nabídku. Přejďete na konec zdrojového kódu stránky. Uvidíte-li na konci časovou značku (na obrázku znázorněna zelenou barvou),

   

    

   pak je vše nastaveno správně a Vámi kontrolovaná stránka je opravdu zobrazena z M-Turbo Cache.

8. Nastavení automatického kešování a stahování

   Možnost automatického stahování/kešování je k dispozici pouze v placené verzi.

   Automatické plošné stahování provede akutalizaci všech aktuálně povolených stránek. Funguje to na principu externího skriptu (skript funguje pouze na linuxových serverech). V nejjednodušším případě stačí pouze automatické stahování povolit a nastavit čas spuštění. Aktualizace se pak bude provádět každý den v určitou hodinu. Vše lze nastavit v ovladacím panelu hlavní konfigurace (2).

   

   Časová značka se zobrazí na pozici (2), na výše uvedeném obrázku, informující o poslední automaticky spuštěné aktualizaci. V případě problémů se prosím podívejte do kapitoly Referenční příručka nebo FAQ and Troubleshooting, kde najdete podrobnější informace co dělat.

5. Referenční příručka

Přístup do administrace komponenty M-Turbo získáte výběrem System > M-Turbo Management v administraci Magenta.

Po otevření adminstrace komponenty M-Turbo uvidíte hlavní menu, které se skládá z 10-ti položek. Význam jednotlivých položek je popsán v následující tabulce:

 

Název	Popis
URL	Seznam kešovaných stránek s s patřičnými funkcemi
Main Configuration	Hlavní konfigurace komponenty M-Turbo. Zde se nachází nastavení hlavních vlastností vztahujících se ke komponentě M-Turbo (adresář s kešovanými soubory, metoda stahování, automatická aktualizace, atd.).
Website Configuration	Konfigurace jednotlivých website. Zde se povoluje/zakazuje stahování stránek k jednotlivým website a storeview. Dále je zde možno kontrolovat a přebudovávat htaccess pravidla určená k jednotlivým website a také ovládací tlačítko pro generování seznamů url nutných k automatické noční aktualizaci.
Categories	Konfigurace vztahující se ke kešování náhledu kategorií (seznam produktů)
Products	Konfigurace vztahující se ke kešování detailu produktů. Tento ovládací panel je k dispozici pouze v placené verzi.
CMS	Konfigurace vztahující se ke kešování statickým CMS.
Dynamic Loaded Blocks	Konfigurace vztahující se k dynamicky stažitelným blokům.
Actions	Tlačítka vyvolávající některé důležité akce.
Registration	Ovládací panel, který slouží pro vkládání licenčního klíče (Download Id).
Uninstall	Odinstalování komponenty M-Turbo

 

URL

Tato tabulka obsahuje seznam stránek určených ke kešování. Všechno automatické kešování je prováděno na základě tohoto seznamu. V příapadě, že seznam není kompletní ( v případě, že byl např. přidán nový produkt) můžete provést aktualizaci tohoto seznamu pomocí synchronizace (B).

Každá stránka tohoto seznamu může být zablokována a bránit tak kešování. Pokud jste blokovali už kešovanou stránku, bude automaticky odstraněna z cache. Blokování a odblokování můžete provést pomocí akcí Block/Unblock (E).

Každou stránku je možné stahovat ručně pomocí odkazu na příslušném řádku (I), nebo vybrat všechny najednou a kliknout na tlačítko Cache Selected Page (A). Když je hromadné kešování provedeno, otevře se nové okno s podrobným průběhem stahování stránek (podívejte se na následující obrázek). Toto okno v průběhu stahování nezavírejte, v opačném případě by došlo k přerušení stahování. Blokované stránky jsou automaticky přeskakovány.

Staženou stránku si lze prohlédnout stisknutím odkazu na příslušném řádku (H). Stránky je možné vyčistit jednu za druhou (G) nebo dohromady pomocí volby Purge from disk (E). Stránka zůstává na seznamu a při dalším stahování bude opět kešována. Pomocí funkce Delete (E) bude stránka odstraněna permanentně.

Záznamy v tabulce lze filtrovat způsobem, kterým jste zvyklý. Filtr je aplikován tlačítkem Search (D), a ruší se tlačítkem Reset Filter (C).

Popis sloupců v tabulce

Název	Popis
ID	Interní identifikátor
Obchod	Obchod, kde patří stránka
Požadovaná cesta	URL stránka, která je relativní ke kořenovému adresáři Magenta
Typ	Typ stránky. Možné hodnoty jsouu náhled kategorie, detail produktu a CMS stránky
Kešované	Zobrazí, zda je stránka kešována (kešovaný soubor je umístěn na disku)
Velikost	Zobrazí velikost kešovaných stránek. Pokud je soubor menší než minimální povolená velikost, zobrazí se číslo červeně
Stav	Zobrazí zda je kešovaná stránka blokována nebo ne

hlavní konfigurace

Tato obrazovka obsahuje několik voleb, které kontrolují jak kešování pracuje. Jakékoli změny by měly být uloženy kliknutím na tlačítko "Save Configuration", které se nachází v levém horním rohu stránky (pozice A na obrázku).

Ovládací panel hlavní konfigurace se skládá z 5 sekcí:

M-Turbo - cesta k adresáři (1)

Tato sekce obsahuje pole pro změnu hlavního adresáře s kešovanými soubory nastaveného při prvotní konfiguraci. Po změně hlavního adresáře, je nutno provést přebudování htaccess pravidel (viz. tab Actions). Při změně adresáře se však vždy ujistěte, že má webový server práva k zápisu do cílového adresáře.

Automatická správa cache (2) (pouze pro placenou verzi)

 

Tento panel slouží k nastavení automatického spuštění aktualizace stránek. Během aktualizace dochází ke spuštění externího skriptu, který stáhne všechny nekešované stránky. Spuštění skriptu se provádí vždy jednou denně. Přesný čas lze nadefinovat na tomto ovladacím panelu. Dále se na ovládacím panelu nachází popisek s informací o času posledního spuštění. Zda-li se opravdu aktualizace provádí můžete také zkontrolovat dle časové značky, kterou najdete ve zdrojovém kódu stránek.

Skript je spouštěn přímým voláním a je nutné, aby webový server měl práva ke spuštění. Na některých serverech však může být toto spouštění zákázano. V tomto případě je třeba do položky interpret zadat absolutní cestu k interpretu BASHe, který je schopen skript spustit.

Volba metod stahování (3)

Tato sekce je používána pro volbu metod ke stahování. K dispozici jsou 4 možnosti:

• Zjednodušené stahování PHP funkcí file_get_contents. Tato funkce není na většině hostingu dostupná.
• Stahování vytvářením spojením přes Sockety. Výchozí nastavení dostupné na většině serveru.
• Zabezpečené stahování metodou PHP CURL. Tato metoda je o něco málo pomalejší než dvě předchozí. K funkčnosti musí být na serveru naisntalováno rozšíření PHP CURL.
• Přímé vytvoření nové instance Magenta. Toto je krajní varianta pro servery, které mají zakázaný zpětné požadavky samy na sebe. K funkčnosti této metody je nutné mít nainstalovaný Magento Patch. Patch lze nainstalovat tlačítkem Apply Mage Patch nalezajícím se v této sekci. Po nainstalování patche lze stejným tlačítkem také patch odebrat. To, zda-li je patch nainstalován nebo ne, zjistíte popiskem tlačíka Apply Mage Patch znamená, že v současnosti patch nainstalován není a stiskem jej můžete nainstalovat. Je-li na tlačítku nápis Remove Mage Patch je patch nainstalován a stisknutím tlačítka jej odeberete.

Stahování lze kontrolovat pomocí on-line testeru, zabudovaného do ovladacího panelu. Při jakékoli změně stahovací metody dojde k automatickému testu stažení domovské stránky. Výsledek tohoto testu je zobrazen těsně pod roletkou. V případě správného stažení je zobrazen zelený text OK včetně zobrazení informaci o velikosti staženého souborů. V případě selhání se objeví červený text FAIL s hláškou vysvětlující příčinu neúspěchu.

 

Náhled velikosti souboru (4)

 

Tato sekce se používá pro stanovení minimální velikosti stránky. Stránky s menší velikostí jsou na seznamu zvýrazněny červenou. Od verze 1.2.1 nejsou takové stránky stahovány ani kešovány. Toto nastavení chrání před kešováním neplatných nebo jinak poškozených stránek. 

 

Nastavení zálohy Htaccess (5)

 

Tato část slouží k nastavení zálohy při automatických úpravách .htaccessu. Je-li provádění záloh aktivováno, bude při jakékoli automatické změně vytvořena záloha. Zálohy lze nalézt v kořenovém adresáři pod názvy .htaccess.bak0, .htaccess.bak1, atd. Maximální počet vytvořených záloh je řízen nastavením polem The maximum number of htaccess backup v této sekci. Pokud je počet záloh překročen, automaticky se nejstarší zálohy mažou.

Konfigurace Website

Ovladací panel obsahuje nastavení, které se vztahuje  k jednotlivým website. Každá website má vlastní sekci. Každou website lze povolit nebo zakázat (A). Všechny stránky spadající pod zakázanou website, jsou ignorovány. V poli (B) je nutno nastavit absolutní cestu k rootu webu pro danou website. Toto nastavení je nutné pro správné nalezení .htaccessu. (Ve verzi 1.2.0 není dovoleno mít jednu cestu přiřazenou k více website, od verze 1.2.1 toto omezení již neplatí).

Oblast (C) obsahuje ovládací panel, který slouží pro zákaz/povolení jednotlivých storeview, které patří mezi specifické website. Všechny stránky, které patří mezi nepovolené storeview, jsou ignorovány.

V části (D) jsou některé informace, které se vztahují k website. Jedná se konkrétně o absolutní cestu k htaccessu dané website. Informace, zda-li je htaccess editovaný Mturbem a zda-li je připraven pro přebudování pravidel.

V poslední oblasti se nachází dvojice ovládacích tlačítek. První tlačítko (E) slouží k přebudování pravidel htaccessu>. Aby bylo možno pravidla přebudovat je nutné, aby htaccess byl zapisovatelný. Na následujícím obrázku můžete vidět, jak to vypadá, když .htaccess není zapisovatelný. Poslední tlačítko (F) slouží k vygenerování seznamu url určených ke kešování, z tohoto seznamu čerpá automatický spouštený stahovací skript. V případě úspěšného vytvoření seznamu je uživatel informován o počtu zapsaných url adres.

kategorie

 Tato záložka slouží primárně k volbě náhledu kategorií určených ke kešování. Jednotlivé kategorie se vybírají pomocí ovládacího prvku (D). Volby (A,B,C) slouží k řízení automatického přidávání a stahování během ukládání stránek. Volba Add newly created categories to select způsobí přidaní nově vytvořené kategorie do výběru. Volba Enable automatic refresh for preview of saved category způsobí automatické stažení stránky při jejím uložením. V případě, že chcete aktualizovat i stránky nadřazených kategorií (protože se tam například nachází seznam podkategorií) nastavte na ano volbu Enable automatic refresh for previews of parents of saved category.

Produkty

 Tato záložka slouží k volbě kategorií. Detaily všech produktů spadajících do takto zvolených kategorií, budou kešovány. Jednotlivé kategorie se vybírají pomocí ovládacího prvku (D). Volby (A,B,C) slouží k řízení automatického přidávání a stahování během ukládání stránek. Volba Add newly created categories to select způsobí přidaní nově vytvořené kategorie do výběru. Volba Enable automatic refresh for preview of categories of saved product způsobí automatické stažení detailu produktu a náhledu kategorie, jejichž produkt je členem. Patří-li produkt do více kategorií budou staženy všechny náhledy, pakliže jsou samotné kategorie ve výběru. V případě, že chcete aktualizovat i stránky nadřazených kategorií, nastavte na ano volbu Enable automatic refresh for previews of parents of categories of saved product.

 

CMS

Tato záložka je používána pro výběr CMS stránek, které jsou určené ke kešování. CMS stránky jsou vybrány na ovládacím panelu (C), po kliknutí na CMS (storeview) Vám budou nabídnuty všechny jazykové mutace této stránky, pokud existují. Automatické přidávání stránek do výběru je aktivováno volbou Add newly created categories to select. Při uložení stránek se do výběru vloží CMS stránka se všemi svými mutacemi. Volbou Enable automatic refresh after save CMS pages se zaktivní automatické stahování cms stránky při jejím uložení.

 

Dynamicky načítané bloky

Definici dynamických bloků lze rozdělit do dvou částí. V první části se nacházejí výchozí bloky: Košík (blok s košíkem + aktualizace odkazu na košík v hlavičce) (A), Anketa (B), blok Porovnání produktů (C). Tato trojice bloků je napevno nastavena podle výchozí šablony Magenta. Ve většině instalací Magenta bude vše fungovat korektně. Může se ale stát, že při použití uživatelských šablon nemusí některý z bloků fungovat. Pak je potřeba nadefinovat tento blok ručně. Do textové pole (D) vepište názvy bloků v layoutu Vaší šablony.

V případě použití Magenta 1.3.x, je nutné mít pro správnou funkci dynamicky stahovatelných bloku nainstalován Layout Patch. Ten nainstalujete stisktem tlačítka Layout Patch nacházejícím se na tomto ovládacím panelu. Ve verzích 1.4.x a vyšších není patch potřeba a zmíněné tlačítko se zde nevyskytuje.

Akce

Zde najdete 5 tlačítek, které slouží pro spuštění určité akce:

	Název	Popis
A	Remove all cached pages	Odstranění všech kešovaných stránek z hardisku. Po spuštění akce tak nebude žádná stránka kešovaná.
B	Update URLs from Rewrite Table	Synchronizace seznamu kešovaných stránek oproti seznamu Magento URL Rewrite Management.
	Generate URL list for all websites	Generování seznamu URL pro všechny website do externí souboru. Tento seznam je zdrojem pro automatické kešování.
D	Cache all pages	Kešuje všechny stránky uvedené v seznamu url. Tato akce je ekvivalentní s označením všech stránek v seznamu url a stištěním tlačítka 'Cache selected pages'.
E	Rebuild .htaccess for all websites	Přebudování .htaccess pravidel pro všechny website.

Registrace

 Následující panel slouží k uložení Vašeho licenčního klíče. Zadání klíče je nutné, pokud chcete používat placenou verzi. Bez správně vyplněného klíče nefunguje drtivá většina funkcí dostupných v komponentě MTurbo. Licenční klíč, který obdržíte v emailu spolu s informacemi k Vaší objednávce, vložte do pole Your download id(A) a konfiguraci uložte. Proběhne-li kontrola v pořádku, uvidíte na obrazovce hlášení s Vašim jménem a datem objednávky.

V opačném případě se Vám objeví následující zpráva:

Následující zpráva znamená, že licenční klíč je registrována správně, ale nesouhlasí registrovaná doména. Název domény je vyplněn už během nákupního procesu. Pokud si jste jisti, že je doména správná, napište nám na náš email support@artio.net. V případě, že jste přenesli MTurbo na novou doménu, můžete provést přeregistraci. Více informací najdete zde Product registration.

Odinstalování

Kliknutím na toto tlačítko odstraníte komponentu M-Turbo z Vašeho Magenta.

  ALTER TABLE `$PREFIXmturbo` 
    CHANGE `request_path` `request_path` VARCHAR( 255 ) CHARACTER 
  SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL;
      

  Order deny,allow
  Allow from all  
      

    app/code/local/Artio/MTurbo/Model/scripts/getstatichtml.sh LIST_URL
      

    app/code/local/Artio/MTurbo/Model/scripts/getstatichtml.sh LIST_URL MIN_SIZE
      

    <?php echo $this->getIncludes() ?>