Admin Guide

Synapse-RSS Admin Guide

Configuration

Dependencies

Synapse-RSS requires the following Power-Ups to be installed:

Name   : synapse-fileparser
Version: >=4.2.1,<=5.0.0
Desc   : Synapse-FileParser is required to parse the RSS feed items.

Name   : synapse-playwright
Version: >=1.18.0,<=2.0.0
Desc   : Synapse-Playwright is required to ingest dynamic HTML pages and save them as PDFs.

Synapse-RSS will conflict with the following Power-Ups:

Name   : rss
Version: any
Desc   : Synapse-RSS conflicts with the deprecated Synapse-RSS Advanced Power-Up.

Permissions

Package (synapse-rss) defines the following permissions:
power-ups.rss.user               : Controls user access to Synapse-RSS. ( default: false )

You may add rules to users/roles directly from storm:

> auth.user.addrule visi power-ups.rss.user
Added rule power-ups.rss.user to user visi.

or:

> auth.role.addrule ninjas power-ups.rss.user
Added rule power-ups.rss.user to role ninjas.

Re-ingesting files for older articles

By default, Synapse-RSS will not download and ingest files for articles that already have media:news:file set. Overriding this behavior can be useful if the file ingest method has changed, e.g. using rss.read --pdf. To do so, a Storm API can be used to re-ingest all files for a particular feed using the new options that are intended to be used with rss.read.

init {
    $rss = $lib.import(rss)
}
inet:url#rss.feed -> media:news:rss:feed
$rss.ingestFeedNews($node, pdf=$lib.true)

Exported APIs

Synapse-RSS does not currently export any APIs.

Workflows

Synapse-RSS does not currently provide any workflows in Optic.

Node Actions

Synapse-RSS provides the following node actions in Optic:

Name : read
Desc : Retrieve the RSS feed and ingest the items.
Forms: inet:url

Onload Events

Synapse-RSS does not use any onload events.