Feed Cache for Umbraco

Version 2.0
Copyright 2010, Ferguson Moriyama Limited. All rights reserved

Feed Cache for Umbraco 2.0

Page 1

Introduction ............................................................................................................................................ 3
Prerequisites ........................................................................................................................................... 3
Requirements...................................................................................................................................... 3
Downloading ....................................................................................................................................... 3
Installing .................................................................................................................................................. 3
Upgrading............................................................................................................................................ 3
Uninstalling ......................................................................................................................................... 3
Configuring Feed Cache for Umbraco ..................................................................................................... 4
Configuration via the Umbraco GUI........................................................................................................ 4
Scheduling Feed Cache to run................................................................................................................. 5
Displaying Cached feeds on your Umbraco website............................................................................... 5
Troubleshooting ...................................................................................................................................... 5
Support ................................................................................................................................................... 6
License..................................................................................................................................................... 6

Feed Cache for Umbraco 2.0

Page 2

Introduction
Feed Cache for Umbraco retrieves XML feeds from a given URL (or any type of data available from a
URL) at scheduled intervals and saves them to disk so they are accessible to your Umbraco based
website in cached form.

Prerequisites
Requirements
Feed Cache for Umbraco 2.0 will work with Umbraco version 4.5 or later. Previous versions of
Umbraco are not supported. It is built with .net 4.

Downloading
Feed Cache for Umbraco can be downloaded from our.umbraco.org:
http://our.umbraco.org/projects/website-utilities/feed-cache

Installing
In the developer section of the Umbraco GUI:

Expand the packages node of the navigation tree.

Click on install local package.
Click on the browse button in the right pane and locate your downloaded version of Feed
Cache for Umbraco.
Click on the Load Package button.
Confirm any further prompts.

Upgrading
If you are upgrading from a previous release you will need to migrate your configuration to a new
XML format. See Configuring Feed Cache for Umbraco for more details.

Uninstalling
Delete FM.Umbraco.FeedCache.dll from the bin directory of your Umbraco website.
Delete the following directory from the document root of your Umbraco website:
/umbraco/plugins/FergusonMoriyama/FeedCache2
Delete the following file from relative to the root of your Umbraco website:
/config/feedcache2.config

Feed Cache for Umbraco 2.0

Page 3

Configuring Feed Cache for Umbraco

Once installed Feed Cache needs to be configured to cache one or more RSS feeds.
Feeds are configured in the following file relative to the document root of your Umbraco website:
/config/feedcache2.config
An example configuration would be as follows:
<?xml version="1.0" encoding="utf-8"?>
<Configuration xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance">
<CachePath>D:\www\App_Data\FeedCache</CachePath>
<Feeds>
<Feed>
<Url>http://feeds.feedburner.com/darrenjferguson</Url>
<LocalFile>darrenferguson.xml</LocalFile>
</Feed>
<Feed>
<Url>http://feeds.feedburner.com/umbracoblog</Url>
<LocalFile>umbraco.xml</LocalFile>
</Feed>
</Feeds>
</Configuration>

You may add as many feeds as required to this configuration.

By default Feeds are cached to the following directory relative to the document root of your
Umbraco website:
/App_Data/FeedCache
You can change this location by modifying the CachePath configuration variable.
The configuration file is loaded at application start and configuration changes require an application
restart.

Configuration via the Umbraco GUI

GUI Configuration has been removed from version 2.0

Feed Cache for Umbraco 2.0

Page 4

Scheduling Feed Cache to run

Feed Cache for Umbraco utilises Umbraco scheduled tasks to perform caches.
Umbraco scheduled tasks are configured in /config/umbracoSettings.config
Upon installation feed cache will be automatically configured to run every 5 minutes.
You should edit the task child node of the scheduledTasks node in order to modify the interval at
which feeds are cached (note the value of the interval attribute is in seconds).
<scheduledTasks>
<task log="true" alias="feedcache" interval="600"
url=" http://yourhost/umbraco/plugins/FergusonMoriyama/FeedCache2/FmFeedCache.aspx "/>
</scheduledTasks>

Displaying Cached feeds on your Umbraco website

An example of rendering cached feeds on your Umbraco website using XSLT is detailed in a blog post
at the following URL:
http://www.darren-ferguson.com/2009/1/21/quick-umbraco-tip-display-twitter-feeds-on-your-site.aspx

Troubleshooting
We only support this software via the our.umbraco.org forums.
Before contacting Ferguson Moriyama for support please verify the following.

FM.Umbraco.FeedCache.dll is present in the bin directory of your Umbraco website.

The following files exist in the /umbraco/plugins/FergusonMoriyama/FeedCache2 folder
relative to the document root of your Umbraco website.
o FmFeedCache.aspx
o PostInstall.ascx
Feedcache2.config is present in the /config folder relative to the root of your Umbraco
website and is valid XML.
You have defined at least RSS feed to be cached as detailed in the configuration section of
this document.

In the event that you have verified the above you may wish to check the umbracoLog table of your
Umbraco website database for log entries with the prefix [FmFeedCache2].

Feed Cache for Umbraco 2.0

Page 5

Support
Ferguson Moriyama provides support for Feed Cache for Umbraco via the our.umbraco.org
forums.

License
The MIT License
Copyright (c) 2009 Ferguson Moriyama
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

Feed Cache for Umbraco 2.0

Page 6