====== RSS Configuration ======

The ''rss.ini'' file (located in the Synchronet ''[[dir:ctrl]]'' directory) is used to configure the [[https://en.wikipedia.org/wiki/RSS|RSS feed]] exported by the ''[[dir:exec]]/rss.ssjs'' script.  This script can be used to export a set of message sub-boards as channels in an RSS feed.

To make the ''rss.ssjs'' script available to web clients, you'll need to copy or symlink the ''[[dir:exec]]/rss.ssjs'' file into your configured Web Server RootDirectory.

In the root section of ''rss.ini'', global/default configuration options can be specified:

^ Option ^ Default ^ Description ^
| maxmessages | 15 | How many messages to export from a sub-board (from newest to oldest) |
| maxdesclength | 500 | How many characters of a message body to include in an RSS item's ''description'' field |
| scheme | %%https://%% | Specify the URL scheme (either ''%%http://%%'' or ''%%https://%%'') |
| msg_link_fmt | suitable for ecWebv4 | See ''rss.ssjs'' for details |

Each [[ini_files#named section]] configures a 'channel' which will be included in the RSS feed.  Each channel represents a message sub-board.  You may override any of the above ''global options'' inside of a [[ini_files#named section]].

^ Option ^ Default ^ Description ^
| sub | ''none'' | The ''internal code'' of a message sub-board you wish to export |
| title | ''Sub-board name'' | The title of this ''channel'' in the RSS feed |
| description | ''Sub-board description'' | The description of this ''channel'' in the RSS feed |
| link | ''http://your-bbs-address/'' | The ''link'' property of this ''channel'' in the RSS feed |
| language | en-us | The language of this channel's content ([[https://en.wikipedia.org/wiki/Language_localisation#Language_tags_and_codes|codes]]) |
| image_url | ''/images/default/sync_pbgj1_white_bg.gif'' | URL of an image / icon for this channel |
| image_link | Same as ''link'' | Link to bring visitors to if they click on the image |
| image_title | Same as ''title'' | Alternate text for the image |

  * ''internal code'', ''sub-board name'', and ''sub-board description'' are configured in [[util:scfg|SCFG]]

Example ''rss.ini'':
<code ini>
maxmessages = 15
maxdesclength = 500
useentities = false

[syncanno]
sub = syncanno
title = Synchronet Announcements
description = Synchronet Announcements
link = http://www.synchro.net/
language = en-us
image_url = http://www.synchro.net/images/synchronet2.png
image_link = http://www.synchro.net/
image_title = Synchronet
maxmessages = 15
maxdesclength = 500
</code>

===== See Also =====
  * [[:config:|config index]]


{{tag>configuration web_server ini}}