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 許可證獲得許可。 （參見許可證）