NewsBlur is a personal news reader that brings people together to talk about the world. A new sound of an old instrument.
Find a file
Samuel Clay 3ad5295a33 Merge branch 'master' into docker_django3.1
* master:
  Upgrading to mongo 3.4.
  Use email if username doesnt work.
  Removing old types field. Needed to upgrade to mongo 3.4.
  Checking if a feed has any notifications on it, set a max of 30 min fetch (yes this is a pretty good way of getting your feeds to fetch faster, but youll have to deal with the notifications).
  Fix task fetch monitor.
  Attempting to see iOS premium status over email.
  Handling work queue missing error.
  Limiting work queue checks.
  Executable monitor work queue.
  Adding monitor for work queue.
  Pointing to the new ssl cert.
  More descriptive failure email
  No default value
  Spitting out error on failure.
  Handling missing values
  Needs redis
  Only warn about falling feed fetches when actually falling.
  Revert "Removing unused types key from index."
  Don't need full health checks in debug.
2021-01-23 19:29:11 -05:00
.vscode Proper base64 encode/decode 2020-07-01 16:59:21 -04:00
api 2to3 api/ 2020-06-22 23:44:58 -04:00
apps Merge branch 'master' into docker_django3.1 2021-01-23 19:29:11 -05:00
clients v10.2.1b1. 2020-12-21 18:11:20 -05:00
config Merge branch 'master' into docker_django3.1 2021-01-23 19:29:11 -05:00
docker add swarm_instructions.sh 2021-01-19 11:42:07 -05:00
documents Initial stab at spec for Android app. Feel free to comment on expected features. 2012-05-10 17:37:24 -07:00
flask_monitor update newsblur dir to newsblur_web in code 2021-01-19 09:40:13 -05:00
logs Geometrically decaying feed fetches on known good feeds that have gone bad. 2012-02-23 13:20:10 -08:00
media Adding RSS Tracker for Windows to Goodies. 2021-01-04 20:03:26 -05:00
newsblur_web update celery task name to cron_queue in settings.py.orig 2021-01-19 09:56:55 -05:00
node Adding docker to node scripts. 2021-01-05 19:34:28 -05:00
r Adding experimental recommendations in R. 2014-03-17 14:50:07 -07:00
templates Merge branch 'django1.11' into django2.0 2020-12-03 14:04:26 -05:00
utils Merge branch 'master' into docker_django3.1 2021-01-23 19:29:11 -05:00
vendor correct newsblur to newsblur_web in tasks 2021-01-04 13:33:56 -05:00
.dockerignore add .dockerignore 2021-01-19 09:40:51 -05:00
.gitignore Merge branch 'master' into docker_django3.1 2021-01-11 17:50:35 -05:00
.tm_properties Removing unused south calls. 2020-06-08 11:07:05 -04:00
.venv Auto-enabling newsblur3 virtualenv. 2020-12-08 12:59:46 -05:00
celery-settings.py use newsblur_web instead of newsblur as directory for settings file 2020-10-13 22:04:24 +07:00
docker-compose.yml correct docker-compose images 2021-01-18 11:59:29 -05:00
fabfile.py Merge branch 'master' into docker_django3.1 2021-01-23 19:29:11 -05:00
LICENSE.md Copyright 2009. 2014-12-20 11:25:54 -08:00
Maintenance.md update README and create a Maintenance.md file 2020-11-06 14:40:58 +07:00
Makefile add image building and deployment functionality to Makefile 2021-01-19 09:54:14 -05:00
manage.py use newsblur_web instead of newsblur as directory for settings file 2020-10-13 22:04:24 +07:00
pytest.ini use pytest and add pytest.ini file 2020-11-06 14:47:41 +07:00
README.md Merge branch 'django1.11' into django2.0 2020-12-03 14:04:26 -05:00
requirements.txt Cleanup in root dir. 2013-06-15 12:56:34 -07:00
stack-compose.yml adjust resource limits on containers in stack-compose and correct monitor command 2021-01-19 00:40:56 -05:00
UPGRADING.md Vendorizing new feedparser. 2020-07-01 18:38:37 -04:00

NewsBlur

Get it on F-Droid Get it on Google Play

Features

  1. Shows the original site (you have to see it to believe it).
  2. Hides stories you don't want to read based on tags, keywords, authors, etc.
  3. Highlights stories you want to read, based on the same criteria.

Technologies

Server-side

  • Python 3.7+: The language of choice.
  • Django: Web framework written in Python, used to serve all pages.
  • Celery & RabbitMQ: Asynchronous queueing server, used to fetch and parse RSS feeds.
  • MongoDB, Pymongo, & Mongoengine: Non-relational database, used to store stories, read stories, feed/page fetch histories, and proxied sites.
  • PostgreSQL: Relational database, used to store feeds, subscriptions, and user accounts.
  • Redis: Programmer's database, used to assemble stories for the river, store story ids, manage feed fetching schedules, and the minuscule bit of caching that NewsBlur uses.
  • Elasticsearch: Search database, use for searching stories. Optional.

Client-side and design

  • jQuery: Cross-browser compliant JavaScript code. IE works without effort.
  • Underscore.js: Functional programming for JavaScript. Indispensable.
  • Backbone.js: Framework for the web app. Also indispensable.
  • Miscellaneous jQuery Plugins: Everything from resizable layouts, to progress bars, sortables, date handling, colors, corners, JSON, animations. See the complete list.

Prerequisites

* Docker
* Docker-Compose

Installation Instructions

  1. Run make nb to build Newsblur containers. This will set up all necessary databases, celery tasks, node applications, flask database monitor, NGINX, and a Haproxy load balancer.

  2. Navigate to:

     https://nb.local.com 
    

    Create an account. At the end of the account creation process, you will be redirected to https://localhost/profile/stripe_form. Hit the back button a few times, and you will be inside the app.

Contribution Instructions

  • Making Changes:

    • To apply changes to the Python or JavaScript code, use the make command.
    • To apply changes to the docker-compose.yml file, use the make rebuild command.
    • To apply changes to the docker/haproxy/haproxy.conf file, node packages, or any new database migrations you will need to use the make nb command.
  • Adding Python packages: Currently, the docker-compose.yml file uses the newsblur/newsblur_python3 image. It is built using the Dockerfile found in docker/newsblur_base_image.Dockerfile. Because of how the docker image is set up, you will need to create your own image and direct your docker-compose.yml file to use it. Please follow the following steps to do so.

    1. Add your new site-packages to config/requirements.txt.
    2. Add the following lines of code to your docker-compose.yml file to replace anywhere where it says image: newsblur/newsblur_python3
    build: context: . dockerfile: docker/newsblur_base_image.Dockerfile
    1. Run the make nb command to rebuild your docker-compose containers
  • Debugging Python

    • To debug your code, drop import pdb; pdb.set_trace() into the Python code where you would like to start debugging and run make and then make debug.
  • Using Django shell within Docker

    • Make sure your docker containers are up and run make shell to open the Django shell within the newsblur_web container.

Running unit and integration tests

NewsBlur comes complete with a test suite that tests the functionality of the rss_feeds, reader, and feed importer. To run the test suite:

`make test`

Author

License

NewsBlur is licensed under the MIT License. (See LICENSE)