NewsBlur is a personal news reader that brings people together to talk about the world. A new sound of an old instrument.
MIT License
* Docker
* Docker-compose
Clone this repo
Run make nb
to build all of the NewsBlur containers. This will set up all necessary databases, front-end django apps, celery tasks, node apps, flask database monitor and metrics, nginx, and a haproxy load balancer.
Navigate to:
https://localhost
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 this blog post.
Run the custom domain script
bash ./utils/custom_domain.sh <domain name>
This script will do the following:
NEWSBLUR_URL
and SESSION_COOKIE_DOMAIN
in newsblur_web/docker_local_settings.py
config/fixtures/bootstrap.json
You can also change domains: bash ./utils/custom_domain.sh <old domain> <new domain>
If you're using a custom subdomain, you'll also want to add it to ALLOWED_SUBDOMAINS
in apps/reader/views.py
A way to make sure you updated all the correct places:
If the string after Domain=
is not the domain you are using to access the website, then your configuration still needs your custom domain.
You can also confirm that there is a domain name mismatch in the database by running make shell
& typing Site.objects.all()[0]
to show the domain that NewsBlur is expecting.
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.
Making Changes:
make
command.make rebuild
command.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.
image: newsblur/newsblur_python3
make nb
command to rebuild your docker-compose containersDebugging Python
import pdb; pdb.set_trace()
into the Python code where you would like to start debuggingmake
and then make debug
.Using Django shell within Docker
make shell
to openNewsBlur 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`
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-ui
and 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-docker
and navigate to http://127.0.0.1:8089
NewsBlur is licensed under the MIT License. (See LICENSE)