Feedbin is a simple, fast and nice looking RSS reader.
Support is available to Feedbin customers by emailing [email protected]. This is also the best way to submit feature requests.
No support is provided for installing/running Feedbin.
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.
- Linux or macOS
- Ruby 3.2
- Postgres 11
- Redis 6
- Elasticsearch 8.5
First
git clone https://github.com/feedbin/feedbin.git
cd feedbin
Inside the server_scripts folder, there is a file that installs all the necessary dependencies for the project. Executing this command you will install, postgres (+ pasword user), ruby and ruby on rails. After this command, the server will reboot.
./server-scripts/pre-fligth.sh
There are some credentials defined on the project. These are necesary to connect with the database. You can acces to this credentials using
EDITOR="vi" rails credentials:edit
On this file you must put the same password defined on the pre-fligth.sh:
USER_PASSWORD_DB="CHANGE ME"
Finally for acces to credentials:edit, you must create inside the folder config/ a master.key file.
touch master.key
Ask the admin to get this key.
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
