4hoa

README

4hoa: 4 Horsemen of the Apocalypse

A Go application that will burn your feeds and retrieve articles of the Internet for you to read in eww (or any other non-graphical web browser).

Install

If you have Go installed in your system, simply "get" this application.

go get bitbucket.org/shackra/4hoa

Configuration

Before running, you need to add some feeds first, to do so create a file called config.yml at ~/.config/4hoa/.

feedsites:
- name: examplename
  url: http://www.examplesite.com/rss/
  readability: true
- name: example-name2
  url: http://www.examplesite-2.com/rss/
- name: example-site-3
  url: http://www.example-site-3.com/rss/
  readability: true

the readability: true will modify all links of each entry in the feed forcing your feed reader to request the article through 4hoa, this is useful for elfeed users that don't want to visit a website using Firefox or Chrome but use eww or w3m instead. 4hoa will remove the excess of gibberish in the website (this may not be perfect).

Use

After registering feeds, simply start 4hoa like this.

4hoa -port=8080 # or any other port of your choice

Now, you can subscribe to any feed you registered in the configuration. Assuming our configuration is the same as the above, the feed url offered by 4hoa will look like this.

http://localhost:8080/feed/example-site-3/rss
http://localhost:8080/feed/example-site-3/atom

Yes! 4hoa offers both RSS 2.0 and Atom 1.0 feeds :). Visit http://localhost:8080/feed/ to get a list of all available feeds.

Bug reports and features

If you find any bug, please report it through the means offered by Bitbucket!. If you want to improve something by youself, please fork this project and do a pull request! (Thank you!).

If there is any feature you may love to have, but you don't know Go (or programming in general), you can sponsor the development of such feature! (just report the feature in the bug tracker and contact me through email or Telegram Messenger).