The RSS feed macro embeds an RSS feed on a page. It can display the contents of external feeds, or of internal feeds generated by Confluence. To display blog posts or to list recently updated pages in a space, use the Feed Builder to create an internal feed, then render it using this macro.
 | CAUTION: Including unknown HTML inside a webpage is dangerous. HTML inside an RSS feed can contain active scripting components. This means that it would be possible for a malicious attacker to present a user of your site with script that their web browser would believe came from you. Such code could be used, for example, to steal a user's authentication cookie and give the attacker their Confluence login password. |
The RSS macro will only be available if it has been enabled by your Confluence administrator. Also, your Confluence Administrator can define a whitelist of trusted URLs. You will see an error message on the Confluence page, if the included URL is not in the whitelist.
On this page:
- Usage with the Macro Browser
- Usage with the Wiki Markup Editor
- Parameters
- Examples
- 1. Limit the number of entries displayed
- 2. Show only the RSS feed titles
- 3. Hide the feeds titlebar
- Working Example
- How Up to Date is the Feed?
- What Happens to a Page Containing a Disallowed URL?
- Authentication
- Accessing Internal HTTPS Feeds
Usage with the Macro Browser
To insert the RSS feed macro into a page using the Macro Browser,
- Open your desired Confluence page or blog post, then click the 'Edit' button. The page or blog post opens in edit mode.
- Click the Macro Browser icon
on the toolbar. The macro browser window opens in the middle of the screen in 'macro selection' mode. - Scroll through the list of macros. Alternatively, start typing part of the name of your desired macro into the search box at the top right of the macro browser window. Macros with a matching name will appear in the main pane.
- Click on the desired macro to access its parameters and preview parameter changes ('preview mode').
- Set the macro parameters to your requirements. If desired, you can preview these changes by clicking 'Refresh'.
- Click 'Insert' to put the macro into the page.
Once you've found the RSS feed macro and have added the required parameter values, click 'insert' to add it to your page.
Usage with the Wiki Markup Editor
Use the Wiki Markup editor to edit the page and insert the RSS macro. Replace the 'http://www.example.com/rss/' URL with your own feed link in this example:
{rss:url=http://www.example.com/rss/}
Parameters
Parameters are settings for Confluence macros that allow the user to control their content or presentation. The table below lists relevant parameters for this macro.
Parameter names are displayed differently in the macro browser interface and in wiki markup. Below, parameter names used in the macro browser are indicated in Bold text, while their equivalents in wiki markup are indicated in (bracketed) text. If the latter is not shown, then in wiki markup, the parameter's name should be omitted and only its value should be added immediately after the colon symbol (:).
| Parameter | Required? | Default | Description |
|---|---|---|---|
| RSS Feed URL (url) |
yes | none | The URL of the RSS feed link you want to show. |
| Maximum Number of Entries (max) |
no | 15 | Limit the number of entries displayed. |
| Show Item Titles Only (showTitlesOnly) |
no | false | Show only the titles of the news items, not the content. |
| Show Name/Title of RSS Feed (titleBar) |
no | true | Hide the feeds title bar. |
Examples
1. Limit the number of entries displayed
{rss:url=http://host.com/rss.xml|max=5}
2. Show only the RSS feed titles
{rss:url=http://host.com/rss.xml|showTitlesOnly=true}
3. Hide the feeds titlebar
{rss:url=http://host.com/rss.xml|titleBar=false}
Working Example
What you need to type:
{rss:url=http://www.abc.net.au/news/syndicate/breakingrss.xml|max=5|showTitlesOnly=true}
What you will get:
How Up to Date is the Feed?
By default, the RSS Feed macro caches the feed results for 60 minutes before fetching the data again.
If you wish to change the default caching, use the {cache} macro to define how often the RSS Feed macro fetches the feed updates. You may want to set the cache to a longer period, so that your page loads faster. Or you may want to retrieve feed results more often, if you need to see the updates sooner. You will need to install the Cache plugin page onto your Confluence site.
To enable caching:
- Using the Confluence Repository, install the 'Scripting Plugin' and the 'Utilities Plugin'.
- For each RSS macro that you wish to cache, surround your RSS macro with a Cache macro. For example, to cache feeds for 30 minutes:
{cache:refresh=30m} {rss:url=http://rss.news.yahoo.com/rss/stocks|max=5} {cache}The Cache plugin page provides more information on customising the cache behaviour.
What Happens to a Page Containing a Disallowed URL?
Your Confluence Administrator can set up a whitelist of allowed URLs. If this is the case, you may see an error on the pages which contain the RSS macro.
A user can add the RSS macro or the HTML-include macro to a Confluence page. The macro code includes a URL from which the content is drawn. When the page is displayed, Confluence will check the URL against the whitelist. If the URL is not allowed, Confluence will display an error message on the page.
The error message says that Confluence "could not access the content at the URL because it is not from an allowed source" and displays the offending URL. If the person viewing the page is a Confluence Administrator, they will also see a link to the Administration page where they can configure the URL whitelist.
Here is an example of the error message, including the link shown only to Confluence Administrators:
Here is an example of the error message, but without the link.
Authentication
Adding Login Information for Confluence Feeds
You can add your Confluence username and password to the feed URL, so that the RSS Feed Macro can log in to Confluence.
Please note that if you do this, someone with access to your RSS newsreader configuration can read your password.
Private Feeds from External Sites
RSS feeds which require authentication cannot be accessed using the RSS Macro.
Accessing Internal HTTPS Feeds
This applies only 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:
- Shut down Confluence.
- Use the SSL guide to re-enable HTTP access to Confluence. This means that Confluence will be accessible via both HTTP and HTTPS.
- 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.
- Modify your Confluence RSS macro feed link to use the HTTP URL, and restart Confluence.
RELATED TOPICS
Subscribing to RSS Feeds within Confluence
Adding a username and password to Confluence RSS feeds
Tracking Updates Overview
Working with Macros
Configuring a URL Whitelist
Return to the Confluence User's Guide.
Comments (15)
Sep 23, 2008
Anonymous says:
Is there any plans to develop a full RSS reader (similar to Google reader) withi...Is there any plans to develop a full RSS reader (similar to Google reader) within Confluence?
Thank you.
Sep 25, 2008
Azwandi Mohd Aris [Atlassian] says:
Hi there, As far as I am concerned, there has been no plan on that feature yet....Hi there,
As far as I am concerned, there has been no plan on that feature yet. However, there is an improvement request to include RSS reader capability in Confluence dashboard:
http://jira.atlassian.com/browse/CONF-5441
Hope that helps.
Cheers,
Azwandi
Feb 03, 2009
Salimane Adjao Moustapha says:
Hi is there a way to trigger updated space notification when the cache of the ...Hi
is there a way to trigger updated space notification when the cache of the feeds are updated and there is new item in the feeds. or is it like that by default and using the macro to reduce the refresh time from 60mn to let's say 15mn will end up giving notifications every 15mn or only if there is an update in the feeds
Thank you.
Mar 10, 2009
Anonymous says:
I know this may sound complicated, but is there any way an RSS feed from a blog ...I know this may sound complicated, but is there any way an RSS feed from a blog can be streamed into a confluence space and then organized by the publish dates in the news section?
Mar 25, 2009
Azwandi Mohd Aris [Atlassian] says:
I am sorry that I cannot think of any specific solution for this - I cannot find...I am sorry that I cannot think of any specific solution for this - I cannot find any plugins in existence that could cater for this requirement. However, I would suggest you to create a remote client that utilises our remote APIs to digest the external RSS feeds. Then, connect to Confluence to create a news based on the feed's published dates. Hope that could be of some help!
Apr 19, 2009
Gordon Rogier says:
How can I add the username of the current user to an rss macro... not for authen...How can I add the username of the current user to an rss macro... not for authentication, but just as an identifier for the rss feed to look up their related records?? Eg. where username and username-email would be replaced with whomever is currently log into the wiki page.
{rss:url=http://rss.somewhere.org/rss.php?id=username} {rss:url=http://rss.somewhere.org/rss.php?id=username-email}Apr 20, 2009
Arie Murdianto says:
The urls in the rss macro is a url which is generated by the feeder. If your fee...The urls in the rss macro is a url which is generated by the feeder. If your feeder support those urls then, rss macro will display as what rss feeder gives. Please consult to the owner of the site where you take the urls from for better clarification on what parameter that you can put. Please do note that rss macro is only responsible to download the rss data and displaying the data in Confluence page. What data that is displayed in Confluence page is really depending on the feeder.
May 12, 2009
Herman de Boer says:
Hi, our internal company wiki site has been upgraded from 2.5.3 to 2.10.3, yest...Hi,
our internal company wiki site has been upgraded from 2.5.3 to 2.10.3, yesterday. One of the problems we encounter is with this particular use of the rss macro:
{rss:url=http://www.via-nova-architectura.org/ds-syndicate/6.html\|max=25\|titleBar=false}The plugin version is: Confluence HTML Macros (confluence.macros.html, Version: 1.6. This particular macro usage gives an error:
Other usages of the RSS macro run fine.
In a different instance running the 1.5 version of this plugin, with Confluence 2.10.3, this particular one runs well.
Any clues where to look for?
Thanks in advance, regards,
Herman.
Jun 04, 2009
Herman de Boer says:
Hi, for this particular RSS feed, it turned out that reverting to version 1.5 i...Hi,
for this particular RSS feed, it turned out that reverting to version 1.5 is a workaround. See also https://support.atlassian.com/browse/CSP-32575
Regards, Herman.
May 18, 2009
Adam Menter says:
I'm trying to embed an RSS feed into the front page of my Confluence wiki. The d...I'm trying to embed an RSS feed into the front page of my Confluence wiki. The display settings on this macro aren't as robust/functional as some of the other RSS readers available (i.e. Google Gadget Custom RSS). While experimenting with different RSS feed options, I tried embedding HTML script using the HTML macro. It looked great but there were two problems: 1) The script would disappear whenever I'd re-edit the page, and 2) I kept getting security warnings through IE.
I'd love to be able to use this RSS macro or the Widget macro in some way, but I haven't quite found (I'd like to be able to show teasers and embed the feed in a self-contained box in page with other items). Any suggestions?
Aug 11
Azwandi Mohd Aris [Atlassian] says:
Hi, Adam. Sorry if this is a little late. In regards to the disappearing HTML, I...Hi, Adam. Sorry if this is a little late. In regards to the disappearing HTML, I believe that you are using the Rich Text Editor which is infamous of this known bug. Perhaps, you can create a special page for this section/feed and include it in your front page? You can also try the Widget Macro to embed some Google Gadgets to your site.
Jul 21
Anonymous says:
Hi After configuring RSS Macro I am getting following screen , But I can not se...Hi After configuring RSS Macro I am getting following screen , But I can not see anything in logs
Unable to render embedded object: File (\User Profiles\rokulkarni\My Documents\SnagIt Catalog\Conf\SNAG-0018.png) not found.
is this error ?
Jul 28
Azwandi Mohd Aris [Atlassian] says:
Unfortunately, I could not see the attachment. Feel free to raise a support tick...Unfortunately, I could not see the attachment. Feel free to raise a support ticket if you like.
Cheers,
Azwan
Jul 28
Nawaz Quadri says:
Hi there! I am using RSS macro for displaying news. My requirement is to ad...Hi there!
I am using RSS macro for displaying news. My requirement is to add one more colum which shows the date of posing the news (similar to blog-post macro). Can you please suggest, what should I modify in the rss.vm file to show the news posted date.
Best Retards,
Nawaz Quadri
Aug 04
Azwandi Mohd Aris [Atlassian] says:
Hi Nawaz, I am afraid that this will require some changes in the class, not jus...Hi Nawaz,
I am afraid that this will require some changes in the class, not just the .vm files. Feel free to raise a feature request at the plugin's issue tracker if you are keen on it.
Cheers,
Azwandi
Add Comment