User Tools

Site Tools


Sidebar

admin_menu:site_setup:cache:start

Cache

Admin Page: Site Setup > Cache

The Geo Cache system will cache data, and module output, in cache files. Using the cache system will greatly reduce the amount of data that is retrieved from the database, resulting in faster page loads and less strain on the database server.

In the admin panel, it gives the warning: Warning: Changing settings on this page can have drastic effects if your server is not configured correctly. It is important that you consult the user manual, so that you may fully understand what is happening, before changing any settings on this page.

The reason for the strong warning is so you come to this page to learn a little about what the cache does before attempting to turn it on. Don't let the warning scare you too much though, turning the cache on works fine for the majority of sites, and if anything goes wrong when you turn it on, you can easily reset the cache by deleting the contents of the _geocache/ directory. You won't loose any data by turning it on.

Important Notes:

  • If you make changes in the admin panel, the cache for that specific data should automatically be adjusted. In other words, the cache is automatically updated if making changes in the admin panel. However, if you make a change in the admin panel that does not seem to take effect, try clearing the cache.1)
  • The cache is created as it is needed. For instance, language text for a page won't be cached until that page is viewed on the client side for the first time.
  • The amount of time something is cached for depends on the nature of that thing. For example, the "featured listings" module display is cached for 5 minutes since it is always changing, but the "category navigation" modules are cached for a full 30 minutes.
  • In the admin panel, you can only turn on or off the cache system. If you are familiar with PHP and are comfortable with editing PHP files, you can try editing the settings file _geocache/_cacheSettings.php to fine-tune the cache settings, but doing so is not supported.
  • You will need to clear the cache (or temporarily turn the cache off) for these events:
    • If you make changes outside the admin panel, for instance if you use FTP to upload a change to a template file, you will need to clear the cache or turn the cache off while you are working on changes to the site via FTP.
    • If the installation is moved, for instance from one folder to another or from one server to another, you need to turn the cache off before the move. Then you can turn the cache back on once you have moved to the new location. If you forget to do this, you can clear your cache on the new location to achieve the same effect. 2)
    • If you update, you will need to turn the cache off before the update starts, and turn it back on afterwards. Or just clear the cache after the fact if you forgot to do that. Note that this is part of the standard update instructions.

Section Cache Stats:

This section lists information about the file caching system. If you have it turned on, it will list the number items that have been cached so far.

Cache Controls:

Clear All Cache

Removes all cache items

Clear Output Cache

Removes any cache items that caches the "end product" of what is displayed on the end user's computer.

Clear Data Cache

Removes any cache items that caches things based on raw data that is stored in the database.

Section General Settings:

Turning on the cache system should significantly speed up high-traffic sites, since it eliminates the need to retrieve certain data from the database, instead being able to retrieve the information from the cache files.

Cache System: On or Off:

Turning on activates the cache system.

If you turn the cache system on, but when the page refreshes it goes back to off, you may need to CHMOD 777 the directory _geoCache/ in order to use the cache system.

More "advanced" settings to control how the cache system work are planned for future releases. At this time, however, the only available setting is to turn the cached system on or off.

Cache Times

The amount of time something is cached for depends on the nature of what is being cached. Below you will find the list of different modules, and how long the "display contents" of each module is cached for.

Cached Item Cache Type Cache Time
Site-Wide Settings data Forever
Addon Settings data Forever
Module Settings data Forever
Page Text data Forever
FEATURED_ADS_1 contents output 5 Minutes
FEATURED_ADS_2 contents output 5 Minutes
FEATURED_ADS_3 contents output 5 Minutes
FEATURED_ADS_4 contents output 5 Minutes
FEATURED_ADS_5 contents output 5 Minutes
DISPLAY_USERNAME contents output Not Cached
LOGIN_REGISTER_LINK contents output Forever
NEWEST_ADS_1 contents output 5 Minutes
NEWEST_ADS_2 contents output 5 Minutes
NEWEST_ADS_LINK contents output Forever
FEATURED_PIC_LINK contents output Forever
FEATURED_TEXT_LINK contents output Forever
LOGGED_IN_OUT_HTML contents output Forever
LOGGED_IN_OUT_HTML_2 contents output Forever
LOGGED_IN_OUT_HTML_3 contents output Forever
NEWEST_ADS_LINK_1 contents output Forever
NEWEST_ADS_LINK_2 contents output Forever
NEWEST_ADS_LINK_3 contents output Forever
SEARCH_LINK contents output Forever
MODULE_FEATURED_PIC_1 contents output 5 Minutes
MODULE_FEATURED_PIC_2 contents output 5 Minutes
FILTER_DISPLAY_1 contents output Forever
CLASSIFIED_NAVIGATION_1 contents output 30 Minutes
CLASSIFIED_NAVIGATION_2 contents output 30 Minutes
CLASSIFIED_NAVIGATION_3 contents output 30 Minutes
CATEGORY_TREE_1 contents output 30 Minutes
CATEGORY_TREE_2 contents output 30 Minutes
CATEGORY_TREE_3 contents output 30 Minutes
MAIN_CLASSIFIED_NAVIGATION_1 contents output 30 Minutes
FILTER_DISPLAY_2 contents output Forever
MODULE_FEATURED_PIC_3 contents output 5 Minutes
MODULE_PHP_INSERT_1 contents output Not Cached
MODULE_PHP_INSERT_2 contents output Not Cached
MODULE_PHP_INSERT_3 contents output Not Cached
MODULE_SEARCH_BOX_1 contents output 30 Minutes
MODULE_PHP_INSERT_4 contents output Not Cached
MODULE_PHP_INSERT_5 contents output Not Cached
MODULE_PHP_INSERT_6 contents output Not Cached
MAIN_CLASSIFIED_LEVEL_NAVIGATION_1 contents output 30 Minutes
MODULE_FEATURED_PIC_1_LEVEL_2 contents output 5 Minutes
MODULE_FEATURED_PIC_2_LEVEL_2 contents output 5 Minutes
MODULE_FEATURED_PIC_1_LEVEL_3 contents output 5 Minutes
MODULE_FEATURED_PIC_2_LEVEL_3 contents output 5 Minutes
MODULE_FEATURED_PIC_1_LEVEL_4 contents output 5 Minutes
MODULE_FEATURED_PIC_2_LEVEL_4 contents output 5 Minutes
MODULE_FEATURED_PIC_1_LEVEL_5 contents output 5 Minutes
MODULE_FEATURED_PIC_2_LEVEL_5 contents output 5 Minutes
MODULE_FEATURED_1_LEVEL_2 contents output 5 Minutes
MODULE_FEATURED_2_LEVEL_2 contents output 5 Minutes
MODULE_FEATURED_1_LEVEL_3 contents output 5 Minutes
MODULE_FEATURED_2_LEVEL_3 contents output 5 Minutes
MODULE_FEATURED_1_LEVEL_4 contents output 5 Minutes
MODULE_FEATURED_2_LEVEL_4 contents output 5 Minutes
MODULE_FEATURED_1_LEVEL_5 contents output 5 Minutes
MODULE_FEATURED_2_LEVEL_5 contents output 5 Minutes
MODULE_ZIP_FILTER_1 contents output Forever
MODULE_STATE_FILTER_1 contents output Forever
SUBCATEGORY_NAVIGATION_1 contents output 30 Minutes
SUBCATEGORY_NAVIGATION_2 contents output 30 Minutes
SUBCATEGORY_NAVIGATION_3 contents output 30 Minutes
SUBCATEGORY_NAVIGATION_4 contents output 30 Minutes
SUBCATEGORY_NAVIGATION_5 contents output 30 Minutes
SUBCATEGORY_NAVIGATION_6 contents output 30 Minutes
SUBCATEGORY_NAVIGATION_7 contents output 30 Minutes
LOGGED_IN_OUT_HTML_4 contents output Forever
LOGGED_IN_OUT_HTML_5 contents output Forever
LOGGED_IN_OUT_HTML_6 contents output Forever
MODULE_TOTAL_LIVE_USERS contents output 5 Minutes
MODULE_TOTAL_REGISTERED_USERS contents output 30 Minutes
MODULE_TITLE contents output Not Cached
MODULE_HOTTEST_ADS contents output 30 Minutes
FEATURED_CATEGORY_1 contents output 5 Minutes
FEATURED_CATEGORY_2 contents output 5 Minutes
LOGGED_IN_OUT_HTML_8 contents output Forever
LOGGED_IN_OUT_HTML_9 contents output Forever
LOGGED_IN_OUT_HTML_10 contents output Forever
LOGGED_IN_OUT_HTML_11 contents output Forever
LOGGED_IN_OUT_HTML_12 contents output Forever
LOGGED_IN_OUT_HTML_13 contents output Forever
LOGGED_IN_OUT_HTML_14 contents output Forever
LOGGED_IN_OUT_HTML_15 contents output Forever
LOGGED_IN_OUT_HTML_16 contents output Forever
LOGGED_IN_OUT_HTML_17 contents output Forever
LOGGED_IN_OUT_HTML_18 contents output Forever
LOGGED_IN_OUT_HTML_19 contents output Forever
LOGGED_IN_OUT_HTML_20 contents output Forever
LOGGED_IN_OUT_HTML_7 contents output Forever
MODULE_PHP_INSERT_7 contents output Not Cached
MODULE_PHP_INSERT_8 contents output Not Cached
MODULE_PHP_INSERT_9 contents output Not Cached
MODULE_PHP_INSERT_10 contents output Not Cached
MODULE_PHP_INSERT_11 contents output Not Cached
MODULE_PHP_INSERT_12 contents output Not Cached
MODULE_PHP_INSERT_13 contents output Not Cached
MODULE_PHP_INSERT_14 contents output Not Cached
MODULE_PHP_INSERT_15 contents output Not Cached
MODULE_PHP_INSERT_16 contents output Not Cached
MODULE_PHP_INSERT_17 contents output Not Cached
MODULE_PHP_INSERT_18 contents output Not Cached
MODULE_PHP_INSERT_19 contents output Not Cached
MODULE_PHP_INSERT_20 contents output Not Cached
CATEGORY_DROPDOWN contents output Forever
CATEGORY_BROWSING_OPTIONS contents output Not Cached
MY_ACCOUNT_LINKS contents output Not Cached
Smarty Template File Locations data Forever

Forever: Note that Forever doesn't really mean forever, just until the next time a setting that affects the cached item is changed in the admin, or the next time the cache is turned off or cleared in the admin.

Template Designers: See that last cached item? That means if you are using cache, turn it off while working on your custom template design using FTP3), or you will be wondering why the system refuses to use your new file instead of the one in the default template set.

1)
The cache system has matured so that this should not be a problem, but if you do experience this problem where you need to clear the cache for a setting change to take effect in the admin panel, notify Geo Support.
2)
Don't forget to make the _geocache folder "writable" if you are changing servers!
3)
If you make changes ONLY in the admin panel, in theory the cache should be automatically updated just fine.
admin_menu/site_setup/cache/start.txt · Last modified: 2014/09/25 16:55 (external edit)