Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
litespeed_wiki:cache:litemage:configuration [2016/02/04 22:26] Rob Holda Updated last section on page. |
litespeed_wiki:cache:litemage:configuration [2017/04/27 21:00] (current) Jackson Zhang [Configuration Settings By Section] |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== Important Note About Updating ====== | ====== Important Note About Updating ====== | ||
| - | Updating LiteMage will overwrite LiteMage's "config.xml" file. Before you update, make sure to copy and save your "config.xml" file if you have made any customizations. | + | Updating LiteMage will overwrite LiteMage's "config.xml" file. Before you update, make sure to manually copy and save your "config.xml" file if you have made any customizations. |
| - | ===== Preliminary Magento Configuration ===== | + | ====== Preliminary Magento Configuration ===== |
| * For LiteMage to work correctly, you must have both "Configuration" and "Layouts" enabled under System -> Cache Management in the Magento Admin Panel. If you are using Magento Enterprise, you must also disable "Page Cache". | * For LiteMage to work correctly, you must have both "Configuration" and "Layouts" enabled under System -> Cache Management in the Magento Admin Panel. If you are using Magento Enterprise, you must also disable "Page Cache". | ||
| {{ :litespeed_wiki:cache:magento-cache-management-li-80-e.png?nolink |}} | {{ :litespeed_wiki:cache:magento-cache-management-li-80-e.png?nolink |}} | ||
| - | ===== LiteMage Extension For Magento Configuration ===== | + | ====== LiteMage Extension For Magento Configuration ===== |
| * LiteMage's default configuration should be suitable for testing. | * LiteMage's default configuration should be suitable for testing. | ||
| Line 30: | Line 30: | ||
| - | ===== Notes On Specific Configuration Settings ===== | + | ===== Configuration Settings By Section ===== |
| - | * **Flush LiteMage Cache:** The Flush LiteMage Cache button (under System -> Cache Management) flushes all public and private caches. Cache Warm Up (if enabled) will also be started automatically after the cache is flushed. Disabling LiteMage through LiteMage Configuration will also cause the cache to be flushed. | + | * **[[litespeed_wiki:cache:litemage:configuration:cache_storage_management| Cache Storage Management]]** |
| - | + | * **[[litespeed_wiki:cache:litemage:configuration:general_settings|General Settings]]** | |
| - | ==== General Settings ==== | + | * **[[litespeed_wiki:cache:litemage:configuration:system-defined_cache_rules|System-Defined Cache Rules]]** |
| - | * **Enable LiteMage Cache: ** (global setting) Determines whether your server runs our LiteMage Cache or not. | + | * **[[litespeed_wiki:cache:litemage:configuration:user-defined_cache_rules|User-Defined Cache Rules]]** |
| - | * After LiteMage is installed, it’s disabled by default. To enable it, you need to change this setting. | + | * **[[litespeed_wiki:cache:litemage:configuration:caching-additional-urls|Caching Additional Known Cacheable URLs]]** |
| - | * Setting this to “no” will auto flush all LiteMage cache. | + | * **[[litespeed_wiki:cache:litemage:configuration:cache_warm_up|Cache Warm Up]]** |
| - | * Always enable/disable LiteMage using this setting, do not disable LiteMage using “disable module output”, doing so will cause trouble. | + | * **[[litespeed_wiki:cache:litemage:configuration:fishpig_wordpress_integration|FishPig WordPress Integration]]** |
| - | * **Admin IPs: ** (global setting) Allows listed IPs (space or comma separated) to perform certain actions from their browsers using LITEMAGE_DEBUG and LITEMAGE_CTRL [[litespeed_wiki:cache:litemage:administration#all_administrative_privilege_browser_commands|parameters]]. | + | * **[[litespeed_wiki:cache:litemage:configuration:developer_testing|Developer Testing]]** |
| - | * We’ll gradually add more control actions. | + | |
| - | * This makes it very convenient for administrators to perform certain actions from a browser without logging into the admin panel. | + | |
| - | * This also allows you to automate some tasks with scripts. For example, if you have direct database updates for pricing, you can add a script at the end of your update program to purge the related products and categories. | + | |
| - | * **Default Public Cache TTL: ** (set on a per store basis) Determines how long (in seconds) public cached pages and data are stored for. The recommended value is 28800. | + | |
| - | * Change this setting based on your store’s needs. If your store updates frequently, set this to a lower value, otherwise, set it to a higher value. The default setting is 8 hours (28800 seconds). | + | |
| - | * **Default Private Cache TTL:** (set on a per store basis) Determines how long (in seconds) private cached pages and data are stored for. The suggested value is 1800 and the suggested maximum value is 3600 as that is the default Cookie Lifetime value and this should not be set higher than the Cookie Lifetime setting (System -> Configuration -> Web). | + | |
| - | * Each user’s private data is stored in private cache, this value can be in sync with your PHP session timeout and Magento session timeout. | + | |
| - | * **Track Recently Viewed Products:** (set on a per store basis) Allows for recently viewed products functionality to work correctly even when page is served from cache. Disabling this will speed up page loading, but may make recently viewed products not appear and Magento "most viewed" reports not accurate. If you would like to know how to disable the "recently viewed products" block from your template, try this guide from [[http://www.templatemonster.com/help/magento-how-to-remove-recently-viewed-products-block.html|TemplateMonster]]. | + | |
| - | * Turn this off if your store front end does not show recently viewed products. | + | |
| - | * If your store shows recently viewed products, it is highly recommended that you review your store’s design and user behavior to determine whether it is really needed. We recommend you remove the recently viewed products block from your template because having this enabled will greatly slow down the page. Every product page, even if most of the page was served from cache, will also go to the Magento backend and insert the last viewed product for that user into the database. However, if you need this feature, you can leave it on. LiteMage will work properly for this case while many other cache solutions cannot. | + | |
| - | * **Separate Cache Copy per Customer Group:** (set on a per store basis) Enable this only if you have a different view or pricing schema for different customer groups. | + | |
| - | * If you have a different view based on customer groups, you need to enable this. | + | |
| - | * For example, users who aren’t logged in cannot see the price while users who are logged in can see the price information. To accomplish this, you need to set the Separate Cache Copy for users who are logged in and users who are not. | + | |
| - | * For example, if you have a wholesale group that sees different prices than regular users, you can set this to “Yes”. This feature will be improved in future to allow you specify which user group it applies to. | + | |
| - | * **Separate Cache Copy for Customized Cookie Values** (global setting) This setting has been retired since 1.0.11 as using rewrite rules is more efficient. Add the below rewrite rule in .htaccess: RewriteRule .* - [E=cache-vary:cookie_name] | + | |
| - | * For more information, check out our [[litespeed_wiki:cache:litemage:customization:views-based-on-cookie-values|wiki page]]. | + | |
| - | * **Use Alternative ESI Syntax** (global setting) If the standard ESI include tags are being filtered by some extension(s) and causing ESI parser errors, you can enable Alternative ESI Syntax, which is known only by LiteMage and LiteSpeed Web Server. | + | |
| - | * [[http://www.w3.org/TR/esi-lang|Standard]] ESI syntax is <esi:include src=”...”/> | + | |
| - | * Some extensions doing html minify may not recognize this syntax and may remove it, causing LiteMage to not function. If you have errors due to ESI syntax being removed, you can enable this setting. The default value for this setting is “No”. | + | |
| - | + | ||
| - | ==== System-Defined Cache Rules ==== | + | |
| - | * //Note: These settings are defined in module config.xml. To modify them, config.xml must be changed directly. These settings cannot be modified here. We only list them here for information/reference.// | + | |
| - | * **Cacheable Routes:** (global setting) The routes to be cached. Partial matches will also be cached. (example: catalog cms contacts_index_index) | + | |
| - | * **Do-Not-Cache Subroutes:** (global setting) The sub routes within cacheable routes to be excluded from caching (example: catalog_product_compare catalogsearch) | + | |
| - | + | ||
| - | ==== User-Defined Cache Rules ==== | + | |
| - | * **Cacheable Routes:** (global setting) Routes to be cached. Partial matches will also be cached. Space, comma, return separated. | + | |
| - | * **Do-Not-Cache Subroutes:** (global setting) Subroutes within cacheable routes to be excluded from caching. Space, comma, return separated. | + | |
| - | * **Do-Not-Cache GET Parameters:** (global setting) Comma-separated list of GET variables that prevents caching URLs within Cacheable Routes. | + | |
| - | * **URL Blacklist:** (global setting) List of relative URLs contained in Cacheable Routes that you would like to exclude from caching. Space, comma, return separated. | + | |
| - | * **Customized Block Names for “welcome” Tag:** (global setting) Comma-separated list of customized block names associated with the “welcome” tag. These are private blocks and are only purged by login and logout events. | + | |
| - | * **Customized Block Names for “toplinks” Tag:** (global setting) Comma-separated list of customized block names associated with the “toplinks” tag. These are private blocks and are only purged by login and logout events. | + | |
| - | * **Customized Block Names for “messages” Tag:** (global setting) Comma-separated list of customized block names associated with the “messages” tag. Only define here if the block is not derived from “Mage_Core_Block_Messages.” | + | |
| - | + | ||
| - | ==== Cache Warm Up ==== | + | |
| - | * //Note: The settings in this section will take effect when the next cron runs (the default setting is 10 minutes). As a result, there’s no need to flush LiteMage cache.// | + | |
| - | * **Enable Cache Warm Up:** (set on a per store basis) Allow LiteMage to automatically warm up the cache. Magento cron job must be enabled. Because LiteMage is encrypted, the Magento cron.sh must use a PHP with IonCube Loader. Updating the cron.sh PHP_BIN setting to "PHP_BIN=/usr/local/lsws/fcgi-bin/lsphp5" will connect it to LSWS's PHP. For more information, you can check out the magento blog entry on [[http://devdocs.magento.com/guides/v2.0/config-guide/cli/config-cli-subcommands-cron.html|setting up the Magento cron job]]. | + | |
| - | * You can enable the warm up at the global level, and disable it for certain stores; or you can disable it at global level and only enable the stores you want to crawl. | + | |
| - | * You can let it crawl both the complete URL list and user-defined list. | + | |
| - | * **Only Run When Load Is Less Than:** (global setting) Warm up will only run when current server load is less than this limit. | + | |
| - | * The crawler will check the average server load from the last minute using the first value of [[http://php.net/manual/en/function.sys-getloadavg.php|sys_getloadavg]]. | + | |
| - | * If server load is currently high, the crawler will skip this run. During a crawler run, it will also dynamically check this load limit and adjust the thread count, if only 1 thread is used and server load is still above this limit, the crawler will stop. | + | |
| - | * Load expresses how many processes are waiting in the queue to access the computer processor. This is calculated for a certain period of time, and the smaller the number the better. This should be set based on your server’s hardware. For example, if your server has a total of 4 cores, you can set the load limit to 4. | + | |
| - | * **Maximum Crawler Threads:** (global setting) Multi-threading the crawler will help crawl big sites faster. LiteMage will use multiple threads up to this limit and dynamically adjust it based on current server load. Valid range is 1 - 10. | + | |
| - | * If this number is higher than 1, the crawler will use multiple threads to crawl. The thread number is dynamically adjusted during crawling based on the current server load and the configured load limit, and won’t exceed this maximum number. | + | |
| - | * Since the thread number changes based on server load, you can safely set this number higher. The recommended value is the number of your cpu cores. | + | |
| - | * **Maximum Run Time (seconds):** (global setting) Limit how long Cache Warm Up can run. Warm up cron job is set to run every 10 minutes. Set this value lower than the cron job time interval. | + | |
| - | * The crawler will be invoked every 10 minutes. You can adjust this value in the LiteMage config.xml file (crontab:jobs:litemage_warmup_cache:schedule). | + | |
| - | * When the crawler is invoked, it will continue crawling from where it’s left off during the last run. If it finds that any warm-up configuration has updated, it will restart crawling process. | + | |
| - | * For each cycle, the crawler will run for the amount of time set here, this is to avoid occupying your server by crawling all the time. If your server is busy, you can set this to a smaller value. If your URL list is huge, you can set this to a larger value. Make sure this is set to a value less than 10 minutes as the crawler is relaunched every 10 minutes. | + | |
| - | * If your server load is higher than the load limit, the crawler will skip one cycle or will exit earlier. | + | |
| - | * **Warm Up Interval (seconds):** (set on a per store basis) Specifies how often you want to crawl the full list. Crawler request will always be served by backend directly. If you make the interval less than the public TTL, you can keep your cache always warm. | + | |
| - | * **Warm Up Priority:** (set on a per store basis) Sets a custom warm up sequence at the store level. This value should be larger than 0, the lower the number, the higher the priority. | + | |
| - | * You can also define the sequence of stores that the crawler will crawl. Put lower numbers for your more important stores. | + | |
| - | * This priority setting is for the whole URL list of a store. You can set a different priority for your customized URL list. | + | |
| - | * **Crawl Non-Default Currencies:** (set on a per store basis) Warm up pages for non-default currencies. Set this to “ALL” to include all available currencies, or list only the most used currencies. Space, comma separated currency codes, like “USD,GBP,EUR”. | + | |
| - | * If your store supports multiple currencies, you can also warm up non-default currency views. You can turn this off by leaving this setting blank. | + | |
| - | * You can also list only the popular currencies in the order of priority. The default currency will be crawled first, then the crawler will follow the order of your supplied list. | + | |
| - | * **Custom Defined URL List:** (global setting) You can supply your own URL list for each store view. Go to the “Current Configuration Scope” box and select a store to set this up. | + | |
| - | * (set on a per store basis) Absolute path of the file containing the list of custom-defined URL. This should contain 1 URL per line. These URLs are relative to the store baseURL (without http://domain/storepath). You can create a short list of the most important URLs, so they can be warmed up first and refreshed more frequently. | + | |
| - | * The file name here is an absolute path. Make sure you set the proper permissions on the file so it is readable by magento. | + | |
| - | * This file can be updated whenever you want. When the crawler is invoked on each cycle, it will check if this file has changed. If it has, it will update its internal cache and restart crawling. | + | |
| - | * Custom Lists are set at the store level, and it will follow the same rule you defined for the store, for example, what currencies to crawl. | + | |
| - | * This list only contains the relative URL. When the crawler runs, it will add the proper base URL for that store. For example, the base URL could be something like https://www.mystore.com/en/ , but your list should only contain the rest of the URL without its base like “accessories.html”. Use only one URL per line. | + | |
| - | * **Custom List Crawl Interval (seconds):** (set on a per store basis) Specify how often you want to crawl the custom URL list. | + | |
| - | * The full store URL list will be crawled after the public TTL expires. It checks the time elapsed since the crawler finished crawling that store. If it is over the public TTL for that store, it will regenerate the URL list and restart crawling. You cannot set your own time. | + | |
| - | * For custom lists, you can set a different interval. The crawler checks the time elapsed after it previously finished crawling the list and if it is over this interval, it will restart crawling. | + | |
| - | * **Custom List Priority:** (set on a per store basis) You can specify a different priority for the custom-defined URL list. This value should be larger than 0, the lower the number, the higher the priority. | + | |
| - | * You can give different priorities for your custom list. The crawler will always follow the defined order of priority. If the priority setting is the same for all stores, the default store will be crawled first. | + | |
| - | + | ||
| - | ==== Developer Testing ==== | + | |
| - | * **Enable LiteMage Cache Only for Listed IPs:** (global setting) Limit LiteMage Cache to specified IPs. (Space or comma separated.) Allows cache testing on a live site. If empty, cache will be served to everyone. When you are ready to use LiteMage Cache for all users, leave this setting blank. After updating this setting, flush LiteSpeed's cache (System -> Cache Management). This will get rid of the cached copies made during testing (which cannot be served to normal users). | + | |
| - | * We always recommend testing LiteMage on your dev/staging server first, especially for heavily customized Magento stores. If you have to test on a production environment, you can put your test IPs here. This way regular viewers will not be affected by LiteMage. | + | |
| - | * **Enable Debug:** (global setting) Prints additional information to /var/log/system.log for debugging purposes. (Ensure developer log is enabled.) | + | |
| - | * //Note: Turn off for production use.// | + | |
| - | * The developer log has to be enabled, this is sometimes globally enabled by default, but not at the store level. To change this, go to Configuration → Developer → Log Settings. | + | |
| - | * A detailed log will be printed out. LiteMage log entries have a LiteMage label at beginning. This is not for end users, but for us to troubleshoot issues. We also provide LiteMage set up services, more info on these services [[litespeed_wiki:cache:litemage:troubleshooting:support|here]]. | + | |