NewsBlur is a personal news reader that brings people together to talk about the world. A new sound of an old instrument.
* Docker * Docker-Compose
make nbto build Newsblur containers. This will set up all necessary databases, celery tasks, node applications, flask database monitor, NGINX, and a Haproxy load balancer.
Note: You will be warned that you are using a self signed certificate. In order to get around this warning you must type "thisisunsafe" as per https://dblazeski.medium.com/chrome-bypass-net-err-cert-invalid-for-development-daefae43eb12
config/fixtures/bootstrap.json, or if you've already created a site, edit the
Site.objects.all()domain in the shell, which you can access with
To make docker-compose work with your database, upgrade your local database to the docker-compose version and then volumize the database data path by changing the
./docker/volumes/part of the volume directive in the service to point to your local database's data directory.
To make docker-compose work with an older database version, change the image version for the database service in the docker-compose file.
Adding Python packages: Currently, the docker-compose.yml file uses the newsblur/newsblurpython3 image. It is built using the Dockerfile found in `docker/newsblurbase_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
- Run the
make nbcommand to rebuild your docker-compose containers
import pdb; pdb.set_trace()into the Python code where you would like to start debugging and run
Using Django shell within Docker
make shellto open the Django shell within the newsblur_web container.
NewsBlur comes complete with a test suite that tests the functionality of the rss_feeds, reader, and feed importer. To run the test suite:
Performance tests use the locust performance testing tool. To run performance tests via CLI, use
make perf-cli users=1 rate=1 host=https://localhost. Feel free to change the users, rate, and host variables in the command to meet you needs.
You can also run locust performance tests using a UI by running
make perf-uiand then navigating to http://127.0.0.1:8089. This allows you to chart and export your performance data.
To run locust using docker, just run
make perf-dockerand navigate to http://127.0.0.1:8089
NewsBlur is licensed under the MIT License. (See LICENSE)