Makes RSS feeds out of Fidonet echomail areas.
npm install fido2rss
Fido2RSS is a Node.js module and a CLI application; both make RSS feeds out of Fidonet echomail areas.
npm install mime (in the directory of Fido2RSS) to run (unless they are used as a module for a Node-powered web application where a web server usually has the mime package already installed anyway). This issue is fixed in Fido2RSS version 3.0.1 and newer.
npm install fido2rss
npm install https://github.com/Mithgol/fido2rss/tarball/master
node_modules/fido2rss. Then use require('fido2rss') to access the module.
README because the package's version is not planned to grow after changes when they happen in README only. (And npm publish --force is forbidden nowadays.)
npm install -g fido2rss
npm install -g https://github.com/Mithgol/fido2rss/tarball/master
PATH. Then use fido2rss command to run the application.
npm install --production in that directory.
npm -g), the application does not appear in the PATH, and thus you'll have to run it directly from the application's directory. You'll also have to run node fido2rss [options] instead of fido2rss [options].
node-webcrypto-ossl (an optional dependency of JavaScript IPFS API) could not be installed. It happens if you do not have C++ build tools for Windows (or their Linux or macOS counterparts) required to build that dependency on your system, or if such tools are incomplete or outdated.
fido2rss [options]
[options] is a space-separated list of the following options and their values:
--type Squish for Squish message bases. The default type is JAM.
host:port is used to contact an IPFS daemon.
--IPFS is given (i.e. without host:port part), the default address --IPFS localhost:5001 is used (i.e. an IPFS daemon is expected to be running locally, alongside Fido2RSS).
--IPFS is missing, UUE-encoded images are left as they are (not IPFS-hosted at all), i.e. this option is off by default.
--IPFS option) UUE-decoded images use large RFC2397-compliant Data URI, while IPFS-hosted images have much shorter URI (only ≈67 characters each) and the RSS feed's size is reduced. This is important for RSS consumers that do not tolerate large entries. (For example, LiveJournal has some small entry size.)
--IPFS) option are both present, then Fido2RSS uses IPFS URLs (pointing to the default https://ipfs.io/ gateway) instead of FGHI URLs as the addresses of RSS items (and also of FGHI URLs encountered inside Fidonet messages).
area: with http: in FGHI URLs, which is wrong.)
--IPFS and --IPFS-URL) options are present, then Fido2RSS uses this option's value as a username of a Twitter's user that each of the processed Fidonet messages should be attributed to. When the message is stored in IPFS, a Summary Card with Large Image will be generated for future references and stored in HTML5 representation's require() the installed module and get a function that asynchronously converts Fidonet messages to RSS output.
null) and RSS output (a string).
js
var Fido2RSS = require('fido2rss');
Fido2RSS(options, function(err, outputRSS){
if( err ){
// an error happened
} else {
// conversion is successful, you may use outputRSS now
}
});
`
The following properties in the object of options are processed:
* options.area — the areatag (echotag) of the echomail area. (Required.)
* options.base — the full path (with the filename, but without extensions) of the message base. (Required.)
* options.msg — how many latest messages are taken from the echomail area and published to the RSS feed. (By default, 23.)
* options.type — the message base's type. By default, 'JAM'; can also be 'Squish' (not case-sensitive). An unknown type is also treated as 'JAM'.
* options.IPFS — this option is used to decide if UUE-encoded images are automatically decoded and put to IPFS. This option may have one of the following values:
* undefined — UUE-encoded images are not put to IPFS.
* true — UUE-encoded images are automatically decoded and put to IPFS. A local IPFS daemon (localhost:5001) is contacted.
* 'host:port' — Same as above, but a remote IPFS daemon is contacted (the given 'host:port' string is used as its address).
* options.IPFSURL — if this option is a truthy value and the previous option (options.IPFS) is not undefined, then Fido2RSS uses IPFS URLs (pointing to the default https://ipfs.io/ gateway) instead of FGHI URLs as the addresses of RSS items, and also of FGHI URLs encountered inside Fidonet messages.
* For inner FGHI URLs these IPFS URLs are addresses of a small IPFS-hosted page that receives real FGHI URLs in its query string and generates a hyperlink by JavaScript. (Such page is automatically generated by Fido2RSS and published in IPFS on the fly.)
* For items' FGHI URLs an intermediate web page (containing the necessary FGHI URL and the whole Fidonet message) is automatically generated, and stored in IPFS, and then hyperlinked from the RSS.
* This option is designed as a workaround for RSS consumers that do not expect FGHI URLs to appear as addresses of RSS items. (For example, LiveJournal simply replaces area: with http: in FGHI URLs, which is wrong.)
* options.areaPrefixURL — the prefix to be added before area://… URLs that appear in RSS output. (For example, if .areaPrefixURL is 'https://example.org/fidonet?', then the URL 'https://example.org/fidonet?area://Test/' will appear instead of original 'area://Test/'.) Some WebBBS support is necessary on the server side (of the given server) for such URLs to be working.
* This property also affects URLs of images and other files decoded from UUE codes. When the property is defined, these files are given with prefixed area://… URLs instead of RFC2397-compliant data: URLs.
* However, images are not affected if they were already decoded and put to IPFS (because of options.IPFS). Only other files are affected.
* By default, .areaPrefixURL is not defined. It means that prefixing does not happen and files use data: URLs (unless put to IPFS).
* This property is useful when RSS output is known to be consumed by RSS readers or web sites that are not ready to encounter FGHI URLs or impose length limits on individual RSS items or the whole RSS feed (data: URLs tend to be rather lengthy).
* For example, LiveJournal has some small entry size.
Note: options.IPFSURL and options.areaPrefixURL are mutually exclusive. Therefore options.areaPrefixURL works only if options.IPFSURL is a falsy value or if options.IPFS is undefined.
* options.twitter — if this option's value is a string and the previous two options (options.IPFS and options.IPFSURL) are in effect, then Fido2RSS uses this option's value as a username of a Twitter's user that each of the processed Fidonet messages should be attributed to. When the message is stored in IPFS, a Summary Card with Large Image will be generated for future references and stored in HTML5 representation's , but only if an image for that card can be found in the Fidonet message's text. Notes:
* An image in the Fidonet message's text is expected to appear in the form of a Fidonet Rune markup (similar to a Markdown's inline image markup).
* If several images are present in the message, only the first image is used in the card.
* Twitter may decide to ignore the card if it feels that the image is too small (less than 280×150 pixels) or too large (more than 1 megabyte); compose your Fidonet messages accordingly and sometimes check the related Twitter Card docs to see if these expected values change in the future.
Testing Fido2RSS
It is necessary to install JSHint for testing.
* You may install JSHint globally (npm install jshint -g) or locally (npm install jshint in the directory of Fido2RSS).
After that you may run npm test (in the directory of Fido2RSS). Only the JS code errors are caught; the code's behaviour is not tested.
Note: if you also test a generated local RSS file by dragging and dropping it to Firefox, the file is not recognized as RSS. That's a known Firefox bug (#420004) discovered in 2008.
License
MIT License (see the LICENSE file), with the following exceptions:
* The file redirector/jquery.min.js contains jQuery under the terms of jQuery's license.
* The file redirector/underscore-min.js contains Underscore.js under the terms of Underscore's license.
* The file redirector/jsload.gif` is generated on http://ajaxload.info/ where the terms of the Do What The Fuck You Want To Public License are said to apply.