Caching Module for rss2hml.php and rssMesh.php Documentation V1.7
Contents
Introduction
Requirements
Usage
Introduction:
The caching module gives users of the rss2html.php and rssMesh script the ability to have their source RSS feeds cached, significantly speeding up web page display time. Once the feed is cached it will be read from the local hard drive for a specified amount of time. After the specified time has lapsed, the RSS feed will be fetched again. This allows the contents of the RSS feed being displayed to remain current, while expediting the whole process. Additionally, the script reduces bandwidth usage. The bandwidth is reduced because the web server does not have to repeatedly fetch the same RSS feed from a remote server. Another benefit to using the new caching module is that on occasion a website will forbid access to their RSS feeds from websites or IP addresses that request the feeds too frequently. The caching module will assist in these situations, because RSS feed requests will be minimized.
The caching module is available for free for all registered users of FeedForAll or FeedForAll Mac, and can be downloaded from here: http://www.feedforall.com/rss-cache.htm
Requirements:
1. A working version of rss2html.php version 2.21 or newer
or
1a. A working version of rssMesh.php version 1.16 or newer
2. A copy of FeedForAll_Scripts_CachingExtension.php version 1.7 or newer
Usage:
1. Copy FeedForAll_Scripts_CachingExtension.php to the same directory on your web server that rss2html.php or rssMesh.php is in.
2. Create a directory beneath that directory named "FeedForAllCacheFiles", and make sure the web server has permissions to write to it. This folder is required, because it is where the RSS feed XML files are cached.
2a. Example - On a Unix like operating systems this can be done with the following commands:
mkdir FeedForAllCacheFiles
chmod 777 FeedForAllCacheFiles
3. Edit either your rss2html.php file or your rssMesh.php file and change the line "$allowCachingXMLFiles = 0;" to "$allowCachingXMLFiles = 1;" if the value isn't already set to 1.
4. By default a cached file has a life of 24 hours. If you wish to change the interval, edit FeedForAll_Scripts_CachingExtension.php and change
"$cacheTTL=86400; //cache files for 1 day" to what ever value you wish. $cacheTTL is in seconds.