orrg

online rss & atom feed reader for gemini (cgi script)
git clone git://git.clttr.info/orrg.git
Log (Feed) | Files | Refs (Tags) | README | LICENSE

README.md (1399B)


      1 # orrg (online rss feed reader for gemini) 
      2 
      3 public instance: [gemini://orrg.clttr.info]
      4 
      5 *orrg* is a cgi script for [gemini](gemini://gemini.circumlunar.space) servers.
      6 It delivers an easy way to consume atom or rss feeds shipped over gemini or https.
      7 
      8 Lists of popular and recently visited feeds as well as viewing a random feed help you discover new things.
      9 
     10 ## features
     11 
     12 - load an atom/rss feed from gemini or https (http is deliberately not supported!) given by user input
     13 - render feed (channel info & entrys) as a gemini site
     14 	- include links to originating site and every article
     15 	- strip html tags from item description
     16 - lists of popular and recently visited feeds
     17 - random feed selector
     18 
     19 ## non-features
     20 
     21 *orrg* will never be a full-fletched feed aggregator with archiving and searching capabilities.
     22 
     23 Given this restrictions is not suitable for high traffic feeds which are updated very often. But it should work quite well for slow paced feeds of blogs and so on.
     24 
     25 # installation
     26 
     27 - setup your geminiserver with cgi enabled
     28 - `git clone` the repo to the directory
     29 - open the capsule in a gemini client
     30 
     31 ## requirements
     32 
     33 - gemini server with cgi enabled (like gmnisrv or stargazer)
     34 - Perl >= 5.28 with modules
     35 	- URI::Escape
     36 	- XML::FeedPP
     37 	- DateTime
     38 	- DateTime::Format::ISO8601
     39 	- HTML::Strip
     40 - gmni (from https://git.sr.ht/~sircmpwn/gmni or https://src.clttr.info/rwa/cgmnlm)
     41 - wget