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.

• 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.¹⁾
• 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. ²⁾
  • 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.

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.

Removes all cache items

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

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

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.

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.

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.

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 FTP³⁾, or you will be wondering why the system refuses to use your new file instead of the one in the default template set.