NewsBlur

NoticiasDesenfocar

• NewsBlur es un lector de noticias personal que reúne a las personas para hablar sobre el mundo. Un nuevo sonido de un viejo instrumento.
• www.newsblur.com.
• Creado por Samuel Clay.
• X/Twitter: @samuelclay y @newsblur.

Características

1. Muestra el sitio original (hay que verlo para creerlo).
2. Oculta historias que no deseas leer según etiquetas, palabras clave, autores, etc.
3. Destaca las historias que deseas leer, según los mismos criterios.

Tecnologías

Del lado del servidor

• Python 3.7+: el lenguaje elegido.
• Django: marco web escrito en Python, utilizado para servir todas las páginas.
• Celery & RabbitMQ: servidor de cola asincrónico, utilizado para buscar y analizar fuentes RSS.
• MongoDB, Pymongo y Mongoengine: base de datos no relacional, utilizada para almacenar historias, leer historias, historiales de búsqueda de páginas/feed y sitios proxy.
• PostgreSQL: base de datos relacional, utilizada para almacenar feeds, suscripciones y cuentas de usuario.
• Redis: base de datos del programador, utilizada para recopilar historias para el río, almacenar identificadores de historias, administrar horarios de búsqueda de feeds y el minúsculo almacenamiento en caché que utiliza NewsBlur.
• Elasticsearch: base de datos de búsqueda, utilizada para buscar historias. Opcional.

Lado del cliente y diseño.

• jQuery: código JavaScript compatible con varios navegadores. IE funciona sin esfuerzo.
• Underscore.js: Programación funcional para JavaScript. Indispensable.
• Backbone.js: Framework para la aplicación web. También indispensable.
• Complementos varios de jQuery: todo, desde diseños redimensionables hasta barras de progreso, elementos ordenables, manejo de fechas, colores, esquinas, JSON y animaciones. Ver la lista completa.

Requisitos previos

 * Docker
* Docker-compose

Instrucciones de instalación

1. Clonar este repositorio

2. Ejecute make nb para crear todos los contenedores de NewsBlur. Esto configurará todas las bases de datos necesarias, aplicaciones front-end de Django, tareas de apio, aplicaciones de nodo, monitor y métricas de la base de datos de flask, nginx y un equilibrador de carga haproxy.

3. Navega a:

    https://localhost
   

   Nota: Se le advertirá que está utilizando un certificado autofirmado. Para evitar esta advertencia, debe escribir "thisisunsafe" según esta publicación de blog.

Usando un dominio personalizado

1. Ejecute el script de dominio personalizado

    bash ./utils/custom_domain.sh <domain name>
   

   Este script hará lo siguiente:

   • Cambie NEWSBLUR_URL y SESSION_COOKIE_DOMAIN en newsblur_web/docker_local_settings.py
   • Cambie el dominio en config/fixtures/bootstrap.json

También puede cambiar los dominios: bash ./utils/custom_domain.sh <old domain> <new domain>

2. Si está utilizando un subdominio personalizado, también querrá agregarlo a ALLOWED_SUBDOMAINS en apps/reader/views.py

3. Una forma de asegurarse de haber actualizado todos los lugares correctos:

   • Vaya a la dirección del sitio web en su navegador
   • Abra las herramientas de desarrollador y mire la pestaña de red.
   • Intenta iniciar sesión
   • Mire nuevamente las herramientas de desarrollo, debería haber una llamada POST a /login
   • Observe los encabezados de respuesta para esa llamada.
   • El valor del encabezado "set-cookie" debe contener una cadena "Dominio="

   Si la cadena después de Domain= no es el dominio que está utilizando para acceder al sitio web, entonces su configuración aún necesita su dominio personalizado.

   También puede confirmar que hay una discrepancia en el nombre de dominio en la base de datos ejecutando make shell y escribiendo Site.objects.all()[0] para mostrar el dominio que NewsBlur espera.

Hacer que docker-compose funcione con su base de datos existente

Para que docker-compose funcione con su base de datos, actualice su base de datos local a la versión de docker-compose y luego volumice la ruta de datos de la base de datos cambiando la parte ./docker/volumes/ de la directiva de volumen en el servicio para que apunte a su base de datos local. directorio de datos.

Para que Docker-Compose funcione con una versión anterior de la base de datos, cambie la versión de la imagen del servicio de base de datos en el archivo Docker-Compose.

Instrucciones de contribución

• Hacer cambios:

  • Para aplicar cambios al código Python o JavaScript, use el comando make .
  • Para aplicar cambios al archivo docker-compose.yml, use el comando make rebuild .
  • Para aplicar cambios al archivo docker/haproxy/haproxy.conf, paquetes de nodos o cualquier nueva migración de base de datos, deberá utilizar el comando make nb .

• Agregar paquetes de Python: actualmente, el archivo docker-compose.yml usa la imagen newsblur/newsblur_python3. Se construye utilizando el Dockerfile que se encuentra en docker/newsblur_base_image.Dockerfile . Debido a cómo está configurada la imagen de la ventana acoplable, deberá crear su propia imagen y dirigir su archivo docker-compose.yml para usarla. Siga los siguientes pasos para hacerlo.

  1. Agregue sus nuevos paquetes de sitio a config/requirements.txt.
  2. Agregue las siguientes líneas de código a su archivo docker-compose.yml para reemplazarlo en cualquier lugar donde diga image: newsblur/newsblur_python3
  build: context: . dockerfile: docker/newsblur_base_image.Dockerfile
  3. Ejecute el comando make nb para reconstruir sus contenedores docker-compose

• Depuración de Python

  • Para depurar su código, suelte import pdb; pdb.set_trace() en el código Python donde le gustaría comenzar a depurar y ejecutar make y luego make debug .

• Usando Django Shell dentro de Docker

  • Asegúrese de que sus contenedores acoplables estén activos y ejecute make shell para abrir el shell de Django dentro del contenedor newsblur_web.

Ejecución de pruebas unitarias y de integración.

NewsBlur viene completo con un conjunto de pruebas que prueba la funcionalidad de rss_feeds, el lector y el importador de feeds. Para ejecutar el conjunto de pruebas:

 `make test`

Realizar una prueba de rendimiento

Las pruebas de rendimiento utilizan la herramienta de prueba de rendimiento Locust. Para ejecutar pruebas de rendimiento a través de CLI, utilice make perf-cli users=1 rate=1 host=https://localhost . No dude en cambiar los usuarios, la tarifa y las variables del host en el comando para satisfacer sus necesidades.

También puede ejecutar pruebas de rendimiento de langosta utilizando una interfaz de usuario ejecutando make perf-ui y luego navegando a http://127.0.0.1:8089. Esto le permite trazar y exportar sus datos de rendimiento.

Para ejecutar locust usando Docker, simplemente ejecute make perf-docker y navegue hasta http://127.0.0.1:8089

Autor

• Creado por Samuel Clay.
• Dirección de correo electrónico: [email protected]
• @samuelclay en X/Twitter.

Licencia

NewsBlur tiene la licencia MIT. (Ver LICENCIA)