Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/feedbin/feedbin
A nice place to read on the web.
https://github.com/feedbin/feedbin
Last synced: 1 day ago
JSON representation
A nice place to read on the web.
- Host: GitHub
- URL: https://github.com/feedbin/feedbin
- Owner: feedbin
- License: mit
- Created: 2013-08-24T00:31:31.000Z (over 11 years ago)
- Default Branch: main
- Last Pushed: 2024-10-28T13:09:03.000Z (about 2 months ago)
- Last Synced: 2024-10-29T15:34:58.722Z (about 1 month ago)
- Language: Ruby
- Homepage: https://feedbin.com
- Size: 22.7 MB
- Stars: 3,478
- Watchers: 105
- Forks: 276
- Open Issues: 171
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-starred-test - feedbin/feedbin - A nice place to read on the web. (Ruby)
- Open-Source-Ruby-and-Rails-Apps - feedbin - a simple, fast and nice looking RSS reader. 🔥 ✅ 🚀 (Happy Exploring 🤘)
- starred-awesome - feedbin - RSS Reader (Ruby)
- awesome-hacking-lists - feedbin/feedbin - A nice place to read on the web. (Ruby)
- awesome-starred - feedbin/feedbin - A nice place to read on the web. (others)
- awesome-homelab - Feedbin
README
Feedbin
=======
Feedbin is a simple, fast and nice looking RSS reader.
Support
-------
Support is available to Feedbin customers by emailing [[email protected]](mailto:[email protected]). This is also the best way to [submit feature requests](https://feedbin.com/help/making-a-feature-request/).
No support is provided for installing the open-source project.
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](https://github.com/feedbin/feedbin-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:
- [yarr](https://github.com/nkanaev/yarr)
- [Tiny Tiny RSS](https://tt-rss.org)
- [Fresh RSS](https://freshrss.org)
And if you really want to run the whole Feedbin stack, take a look at this [Docker version](https://github.com/angristan/feedbin-docker). If you would like to try Feedbin out you can [sign up](https://feedbin.com/) for an account.
The main Feedbin project is a [Ruby on Rails](https://rubyonrails.org/) 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:**](https://github.com/feedbin/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:**](https://github.com/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:**](https://github.com/esimov/pigo/releases)
pigo provides face detection for better [preview image cropping](https://feedbin.com/blog/2015/10/22/image-previews/). Make sure it's available in your PATH or provide a PIGO_PATH environment variable.
Requirements
------------
- Linux or macOS
- [Ruby 3.3](http://www.ruby-lang.org/en/)
- [Postgres 11](http://www.postgresql.org/)
- [Redis 6](http://redis.io/)
- [Elasticsearch 8.5](https://www.elastic.co/downloads/past-releases/#elasticsearch)
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](.env.example) to `.env` and customize it with your settings.
**Setup the database**
rake db:setup
**Start the processes**
bundle exec foreman start