This page last changed on Feb 21, 2007 by tom@atlassian.com.

RSS feed macro embeds an RSS feed on a page. It can display the contents of external feeds, or internal feeds generated by Confluence. To display blog posts or list recently updated pages in a space, use the Feed Builder to create an internal feed, then render it using this macro. RSS feeds are updated every hour.

Usage

Use the Wiki Markup Editor to edit the page and insert the RSS macro with your feed link.

Replace the example

http://www.example.com/rss/

feed link below with your own

{rss:url=http://www.example.com/rss/}

Private Feeds

RSS feeds which require authentication can't be accessed using the RSS Macro.

Optional Parameters

Number Parameter Default Description
 1 max 15 Limit the number of entries displayed
 2 showTitlesOnly false Show only the RSS feed titles
 3 titleBar true Hide the feeds titlebar

The effects of these parameters are described below.

1. Limit the number of entries displayed

This parameter defaults to '15'.

{rss:url=http://host.com/rss.xml|max=5}

2. Show only the RSS feed titles.

This parameter defaults to 'False'.

{rss:url=http://host.com/rss.xml|showTitlesOnly=true}

3. Hide the feeds titlebar

This parameter defaults to 'True'.

{rss:url=http://host.com/rss.xml|titleBar=false}

Working Example

This was rendered using the wiki markup

{rss:url=http://www.abc.net.au/news/syndicate/breakingrss.xml|max=5|showTitlesOnly=true}

Enabling Feed Caching For Faster Pages

This requires the installing the Cache Macro. To enable caching:

  1. Install the Confluence Repository Client into Confluence.
  2. Once setup, use the Confluence Repository Client plugin page to install the "Scripting Plugin" and "Utilities Plugin".
  3. For each RSS macro that you wish to cache, surround your RSS Feed call with a Cache macro call. To caching feeds for 60 minutes:
    {cache:refresh=60m}
    {rss:url=http://rss.news.yahoo.com/rss/stocks|max=5}
    {cache}

    As the page will not display feed updates until the cached version is refreshed, you may like to customise the cache behaviour.

Accessing Internal HTTPS Feeds

This only applies to Confluence instances which have enabled HTTPS for all content. If your site is fully HTTPS, the RSS macro cannot access internal feeds. To enable the RSS macro to access internal feeds without affecting your HTTPS setup, enable local-only HTTP access:

  1. Shut down Confluence
  2. Use the SSL guide to re-enable HTTP access to Confluence. This means that Confluence will be accessible via both HTTP and HTTPS
  3. Insert a firewall rule to redirect all HTTP requests not from the Confluence server to the equivalent HTTPS URL. This ensures that users will only be able to access Confluence via HTTPS, as intended. If you have still left HTTP access for attachments enabled (to avoid the IE download bug) you must selectively enable those URLS as well
  4. Modify your Confluence RSS macro feed link to use the HTTP URL, and restart Confluence

Troubleshooting

Check out RSS Feed Troubleshooting And Tasks.

Related Topics

Subscribing to RSS Feeds within Confluence
Tracking Updates Overview
Working with Macros

Return to Confluence 2 Home

Document generated by Confluence on May 01, 2007 02:36