NewsBlur

新闻模糊

• NewsBlur 是一款个人新闻阅读器，让人们聚集在一起谈论世界。旧乐器的新声音。
• www.newsblur.com。
• 由塞缪尔·克莱创建。
• X/Twitter：@samuelclay 和 @newsblur。

特征

1. 显示原始站点（您必须亲眼所见才能相信）。
2. 根据标签、关键字、作者等隐藏您不想阅读的故事。
3. 根据相同的标准突出显示您想阅读的故事。

技术

服务器端

• Python 3.7+：首选语言。
• Django：用Python编写的Web框架，用于服务所有页面。
• Celery & RabbitMQ：异步队列服务器，用于获取和解析 RSS feed。
• MongoDB、Pymongo 和 Mongoengine：非关系数据库，用于存储故事、阅读故事、提要/页面获取历史记录和代理站点。
• PostgreSQL：关系数据库，用于存储源、订阅和用户帐户。
• Redis：程序员的数据库，用于组装河流的故事、存储故事 ID、管理提要获取计划以及 NewsBlur 使用的微小缓存。
• Elasticsearch：搜索数据库，用于搜索故事。选修的。

客户端和设计

• jQuery：跨浏览器兼容的 JavaScript 代码。 IE 毫不费力地工作。
• Underscore.js：JavaScript 函数式编程。必不可少。
• Backbone.js：Web 应用程序的框架。也是不可或缺的。
• 其他 jQuery 插件：从可调整大小的布局到进度条、可排序、日期处理、颜色、角点、JSON、动画。查看完整列表。

先决条件

 * Docker
* Docker-compose

安装说明

1. 克隆这个仓库

2. 运行make nb来构建所有 NewsBlur 容器。这将设置所有必要的数据库、前端 django 应用程序、celery 任务、节点应用程序、flask 数据库监视器和指标、nginx 和 haproxy 负载均衡器。

3. 导航至：

    https://localhost
   

   注意：系统会警告您正在使用自签名证书。为了绕过此警告，您必须按照此博客文章输入“thisisunsafe”。

使用自定义域

1. 运行自定义域脚本

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

   该脚本将执行以下操作：

   • 更改newsblur_web/docker_local_settings.py中的NEWSBLUR_URL和SESSION_COOKIE_DOMAIN
   • 更改config/fixtures/bootstrap.json中的域

您还可以更改域： bash ./utils/custom_domain.sh <old domain> <new domain>

2. 如果您使用自定义子域，您还需要将其添加到apps/reader/views.py中的ALLOWED_SUBDOMAINS中

3. 确保更新所有正确位置的方法：

   • 在浏览器中访问网站地址
   • 打开开发者工具并查看网络选项卡
   • 尝试登录
   • 再看看开发者工具，应该有一个对/login的POST调用
   • 观察该调用的响应标头
   • “set-cookie”标头的值应包含“Domain=”字符串

   如果Domain=后面的字符串不是您用于访问网站的域，则您的配置仍然需要您的自定义域。

   您还可以通过运行make shell并输入Site.objects.all()[0]以显示 NewsBlur 期望的域来确认数据库中是否存在域名不匹配。

让 docker-compose 与您现有的数据库一起工作

要使 docker-compose 与您的数据库配合使用，请将本地数据库升级到 docker-compose 版本，然后通过更改服务中 Volume 指令的./docker/volumes/部分以指向本地数据库的数据目录。

要使 docker-compose 使用较旧的数据库版本，请在 docker-compose 文件中更改数据库服务的映像版本。

投稿须知

• 做出改变：

  • 要将更改应用到 Python 或 JavaScript 代码，请使用make命令。
  • 要将更改应用到 docker-compose.yml 文件，请使用make rebuild命令。
  • 要将更改应用到 docker/haproxy/haproxy.conf 文件、节点包或任何新的数据库迁移，您需要使用make nb命令。

• 添加Python包：目前，docker-compose.yml文件使用newsblur/newsblur_python3图像。它是使用docker/newsblur_base_image.Dockerfile中的 Dockerfile 构建的。由于 docker 映像的设置方式，您需要创建自己的映像并指示 docker-compose.yml 文件来使用它。请按照以下步骤操作。

  1. 将新站点包添加到 config/requirements.txt。
  2. 将以下代码行添加到 docker-compose.yml 文件中，以替换显示image: newsblur/newsblur_python3
  build: context: . dockerfile: docker/newsblur_base_image.Dockerfile
  3. 运行make nb命令来重建 docker-compose 容器

• 调试Python

  • 要调试代码，请删除import pdb; pdb.set_trace()进入您想要开始调试的 Python 代码并运行make ，然后make debug 。

• 在 Docker 中使用 Django shell

  • 确保您的 docker 容器已启动并运行make shell以在 newsblur_web 容器中打开 Django shell。

运行单元和集成测试

NewsBlur 附带了一个测试套件，用于测试 rss_feeds、阅读器和提要导入器的功能。运行测试套件：

 `make test`

运行性能测试

性能测试使用Locust性能测试工具。要通过 CLI 运行性能测试，请使用make perf-cli users=1 rate=1 host=https://localhost 。您可以随意更改命令中的用户、速率和主机变量以满足您的需求。

您还可以使用 UI 运行 Locust 性能测试，方法是运行make perf-ui ，然后导航到 http://127.0.0.1:8089。这允许您绘制图表并导出性能数据。

要使用 docker 运行 locust，只需运行make perf-docker并导航到 http://127.0.0.1:8089

作者

• 由塞缪尔·克莱创建。
• 电子邮件地址：[email protected]
• X/Twitter 上的@samuelclay。

执照

NewsBlur 根据 MIT 许可证获得许可。 （参见许可证）