Skip to content

feedbin/feedbin

master
Switch branches/tags
Code

Feedbin

Feedbin is a simple, fast and nice looking RSS reader.

Feedbin Screenshot

Support

Support is available to Feedbin customers by emailing support@feedbin.com. This is also the best way to submit feature requests.

No support is provided for installing/running Feedbin.

Introduction

Feedbin is a web based RSS reader. It provides a user interface for reading and managing feeds as well as a REST-like API for clients to connect to.

Feedbin's goal is to be a great web-based RSS service. This goal is at odds with being a great self-hosted RSS reader. There are a lot of moving parts and things to configure, and for that reason I do not recommend that you run Feedbin in production unless you have plenty of time to get it properly configured.

If you're looking for a self-hosted RSS reader check out:

And if you really want to run the whole Feedbin stack, take a look at this Docker version. If you would like to try Feedbin out you can sign up for an account.

The main Feedbin project is a Rails 7 application. In addition to the main project there are several other services that provide additional functionality. None of these services are required to get Feedbin running locally.

Optional Extras

  • Privacy Please: Privacy Please is an https image proxy. In production Feedbin is https only. One issue with https is all assets must be served over https as well or the browser will show insecure content warnings. Privacy Please proxies all image requests through an https enabled host to prevent this. Using a proxy has the added benefit of providing privacy while using Feedbin.
  • extract: Extract is a Node.js service that extract content from web pages. It is used to extract the full content of an article when a feed only provide excerpts.
  • pigo: pigo provides face detection for better preview image cropping. Make sure it's available in your PATH or provide a PIGO_PATH environment variable.

Requirements

Installation

Ultimately, you'll need a Ruby environment and a Rack compatible application server.

First, install the dependencies listed under requirements.

Next clone the repository and install the application dependencies

git clone https://github.com/feedbin/feedbin.git
cd feedbin
bundle

If you encounter any errors after running bundle there is a problem installing one of the dependencies. You must find out how to get this dependency installed on your platform.

Configure

Feedbin uses environment variables for configuration. Feedbin will run without most of these, but various features and functionality will be turned off.

Rename .env.example to .env and customize it with your settings.

Setup the database

rake db:setup

Start the processes

bundle exec foreman start

Status Badges

Ruby CI