Skip to content
Branch: master
Clone or download
Pull request Compare This branch is 29 commits ahead, 141 commits behind feedbin:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
app Add analytics script to body if ANALYTICS_GTAG exists Jan 5, 2019
bin Add bootsnap. Jan 2, 2018
config Merge branch 'master' of https://github.com/feedbin/feedbin Jan 4, 2019
db Format with rufo. Aug 13, 2018
doc Update ruby. Sep 20, 2016
lib Image Saver. Dec 6, 2018
log
script Initial commit. Aug 24, 2013
test Expire link caching jobs when they're no longer relevant. Nov 6, 2018
vendor Defer loading web fonts until one is selected. Sep 10, 2018
.codeclimate.yml yaml fixes Aug 1, 2016
.env.example README updates. Jun 9, 2017
.env.test Marketing email logic. May 9, 2017
.gitignore Only run if found on page. Jan 15, 2018
.rubocop.yml Added rubocop Aug 1, 2016
.ruby-version Dependency updates. Feb 6, 2018
.travis.yml Test update. Aug 23, 2018
Capfile Upgrade Capistrano. Sep 9, 2017
Dockerfile Update Dockerfile Ruby Version, improve Dockerfile dependency caching Jan 5, 2019
Gemfile Updated dependencies. Dec 11, 2018
Gemfile.lock Update depencencies. Jan 2, 2019
LICENSE.md Switch to feedbin.com. Mar 14, 2014
Procfile Low priority queue. Jan 11, 2018
README.md Update README.md Feb 25, 2019
Rakefile Initial commit. Aug 24, 2013
coffeelint.json Added coffeelint Aug 2, 2016
config.ru Remove middleware. Aug 10, 2017
docker-compose.yml Updating README Aug 18, 2018
startup_script.sh Dockerfile stuff from other repo Aug 18, 2018

README.md

Freedbin 🍔

Feedbin is a simple, fast and nice looking RSS reader - this fork provides a version intended for users who want to host their own copy of it for free, that can be run anywhere with Docker.

Requirements

  • Docker
  • docker-compose

Installation

  • wget https://raw.githubusercontent.com/rach-sharp/freedbin/master/docker-compose.yml
  • Set config values in the docker-compose.yml file
  • docker-compose up
  • Access the app from localhost:9292 (first request can take a little while)

All the minimum necessary config parameters required for it to run are set in the Dockerfile. All the config parameters required for interconnectivity with the db etc, are specified in the docker compose file.

The container images are hosted on dockerhub:

Differences to the original

Batteries Included

  • Will work without a payment system like stripe
  • Doesn't require HTTPS to be enabled (for if you are using at home, or from behind a reverse proxy)
  • API is served from the main domain rather than an API subdomain.
  • Use open source fonts

Optional Extras

  • When ANALYTICS_GTAG environment variable is set, Google Analytics will be enabled

Contributing

Feel free to file PRs for features or fixes you think are specifically useful to the self-hosted version, but if it's generally applicable then contribute to the original Feedbin project which will be merged into this fork periodically.

Roadmap

  • Restricting signups to be admin-managed.
  • Adding Helm Chart for Kubernetes deployment
You can’t perform that action at this time.