rss2ctdl/README.txt

   1                  RSS2CTDL -- an RSS to Citadel gateway
   2
   3 Main program (c)2004 by Art Cancro <http://uncensored.citadel.org>
   4 RSS parser (c)2003-2004 by Oliver Feiler <kiza@kcore.de / http://kiza.kcore.de>
   5                         and Rene Puls <rpuls@gmx.net>
   6
   7 RSS2CTDL is an RSS-to-Citadel gateway.  It allows you to pull external RSS
   8 feeds into Citadel rooms.  Feed URL's are polled whenever you run the program.
   9 Each item is converted to a Citadel message and submitted into the network
  10 queue.  The message-ID is derived from a unique hash of the GUID tag of
  11 each item.  If there is no GUID tag (which, unfortunately, is the case for
  12 the vast majority of feeds) then we hash the title/description/link tags
  13 instead.  We then dump it all into the queue and let the loopzapper handle
  14 the dupes.
  15
  16 We are distributing RSS2CTDL as a standalone utility, only as a temporary
  17 measure.  Eventually it will be bundled with the Citadel server, and it will
  18 be invoked by the main server process.  At that time, this standalone
  19 distribution will be discontinued.
  20
  21 RSS2CTDL requires the "libxml2" library, which is probably already installed
  22 on your host system.  If not, get it from http://www.xmlsoft.org
  23
  24 Here's how to make it work:
  25
  26 1. Run "make" to build the program.
  27    (There is no "configure" and there is no "make install" either.  The
  28    makefile will produce an "rss2ctdl" binary, which is all you need.)
  29 2. Edit the "do_feeds.sh" script to your liking.  Tell it the feeds you
  30    want to receive, and the rooms you want to deposit them into.
  31 3. Create those rooms if they do not already exist.
  32 4. Configure your crontab to run do_feeds.sh every half hour.  (You can go
  33    more or less often if you wish, but once every half hour seems to be the
  34    frequency generally agreed upon in the community to be optimal.)
  35
  36 Do be aware that rss2ctdl must have write access to $CTDL/network/spoolin
  37 in order to submit its messages into the Citadel spool.  In practice, this
  38 generally means that it should be run by the crontab of the user under which
  39 the Citadel service is running ... or by root if you wish.