NewsBlur

ข่าวเบลอ

• NewsBlur เป็นโปรแกรมอ่านข่าวส่วนตัวที่นำผู้คนมารวมตัวกันเพื่อพูดคุยเกี่ยวกับโลก เสียงใหม่ของเครื่องดนตรีเก่า
• www.newsblur.com.
• สร้างโดยซามูเอลเคลย์
• X/Twitter: @samuelclay และ @newsblur

คุณสมบัติ

1. แสดงไซต์ดั้งเดิม (คุณต้องเห็นจึงจะเชื่อ)
2. ซ่อนเรื่องราวที่คุณไม่ต้องการอ่านตามแท็ก คำสำคัญ ผู้แต่ง ฯลฯ
3. ไฮไลท์เรื่องราวที่คุณต้องการอ่านตามเกณฑ์เดียวกัน

เทคโนโลยี

ฝั่งเซิร์ฟเวอร์

• Python 3.7+: ภาษาที่คุณเลือก
• Django: เว็บเฟรมเวิร์กที่เขียนด้วย Python ใช้เพื่อให้บริการทุกหน้า
• Celery & RabbitMQ: เซิร์ฟเวอร์เข้าคิวแบบอะซิงโครนัส ใช้ในการดึงข้อมูลและแยกวิเคราะห์ฟีด RSS
• MongoDB, Pymongo และ Mongoengine: ฐานข้อมูลที่ไม่เกี่ยวข้อง ใช้เพื่อจัดเก็บเรื่องราว อ่านเรื่องราว ประวัติการดึงข้อมูลฟีด/เพจ และไซต์พรอกซี
• PostgreSQL: ฐานข้อมูลเชิงสัมพันธ์ ใช้เพื่อจัดเก็บฟีด การสมัครสมาชิก และบัญชีผู้ใช้
• Redis: ฐานข้อมูลของโปรแกรมเมอร์ ใช้เพื่อรวบรวมเรื่องราวของแม่น้ำ จัดเก็บรหัสเรื่องราว จัดการกำหนดการดึงฟีด และแคชเล็กๆ น้อยๆ ที่ NewsBlur ใช้
• Elasticsearch: ค้นหาฐานข้อมูล ใช้สำหรับค้นหาเรื่องราว ไม่จำเป็น.

ฝั่งไคลเอ็นต์และการออกแบบ

• jQuery: โค้ด JavaScript ที่รองรับข้ามเบราว์เซอร์ IE ทำงานโดยไม่ต้องใช้ความพยายาม
• Underscore.js: การเขียนโปรแกรมเชิงฟังก์ชันสำหรับ JavaScript ที่ขาดไม่ได้
• Backbone.js: กรอบงานสำหรับเว็บแอป ที่ขาดไม่ได้อีกด้วย
• ปลั๊กอิน jQuery เบ็ดเตล็ด: ทุกอย่างตั้งแต่เค้าโครงที่ปรับขนาดได้ ไปจนถึงแถบความคืบหน้า การเรียงลำดับ การจัดการวันที่ สี มุม JSON และภาพเคลื่อนไหว ดูรายการทั้งหมด

ข้อกำหนดเบื้องต้น

 * Docker
* Docker-compose

คำแนะนำในการติดตั้ง

1. โคลนที่เก็บนี้

2. เรียกใช้ make nb เพื่อสร้างคอนเทนเนอร์ NewsBlur ทั้งหมด สิ่งนี้จะตั้งค่าฐานข้อมูลที่จำเป็นทั้งหมด แอป django ส่วนหน้า งานคื่นฉ่าย แอปโหนด การตรวจสอบฐานข้อมูลขวดและตัววัด nginx และโหลดบาลานเซอร์ haproxy

3. นำทางไปยัง:

    https://localhost
   

   หมายเหตุ: คุณจะได้รับคำเตือนว่าคุณกำลังใช้ใบรับรองที่ลงนามด้วยตนเอง เพื่อแก้ไขคำเตือนนี้ คุณต้องพิมพ์ "thisisunsafe" ตามโพสต์ในบล็อกนี้

การใช้โดเมนที่กำหนดเอง

1. เรียกใช้สคริปต์โดเมนแบบกำหนดเอง

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

   สคริปต์นี้จะทำสิ่งต่อไปนี้:

   • เปลี่ยน NEWSBLUR_URL และ SESSION_COOKIE_DOMAIN ใน newsblur_web/docker_local_settings.py
   • เปลี่ยนโดเมนใน config/fixtures/bootstrap.json

คุณยังสามารถเปลี่ยนโดเมน: bash ./utils/custom_domain.sh <old domain> <new domain>

2. หากคุณใช้โดเมนย่อยที่กำหนดเอง คุณจะต้องเพิ่มโดเมนดังกล่าวลงใน ALLOWED_SUBDOMAINS ใน apps/reader/views.py

3. วิธีตรวจสอบให้แน่ใจว่าคุณอัปเดตสถานที่ที่ถูกต้องทั้งหมด:

   • ไปที่ที่อยู่เว็บไซต์ในเบราว์เซอร์ของคุณ
   • เปิดเครื่องมือสำหรับนักพัฒนาซอฟต์แวร์แล้วดูที่แท็บเครือข่าย
   • ลองเข้าสู่ระบบ
   • ดูเครื่องมือสำหรับนักพัฒนาอีกครั้ง ควรมีการโทร POST ไปที่ /login
   • สังเกตส่วนหัวการตอบกลับสำหรับการโทรนั้น
   • ค่าของส่วนหัว "set-cookie" ควรมีสตริง "Domain="

   หากสตริงหลัง Domain= ไม่ใช่โดเมนที่คุณใช้ในการเข้าถึงเว็บไซต์ แสดงว่าการกำหนดค่าของคุณยังคงต้องใช้โดเมนที่คุณกำหนดเอง

   คุณยังสามารถยืนยันได้ว่าชื่อโดเมนไม่ตรงกันในฐานข้อมูลด้วยการเรียกใช้ make shell และพิมพ์ Site.objects.all()[0] เพื่อแสดงโดเมนที่ NewsBlur คาดหวัง

การทำให้นักเทียบท่าเขียนงานกับฐานข้อมูลที่มีอยู่ของคุณ

เพื่อให้นักเทียบท่าทำงานกับฐานข้อมูลของคุณ ให้อัปเกรดฐานข้อมูลในเครื่องของคุณเป็นเวอร์ชันเขียนนักเทียบท่า จากนั้นเพิ่มระดับเสียงพาธข้อมูลฐานข้อมูลโดยการเปลี่ยน ./docker/volumes/ ส่วนหนึ่งของคำสั่งปริมาณในบริการให้ชี้ไปที่ฐานข้อมูลในเครื่องของคุณ ไดเร็กทอรีข้อมูล

หากต้องการให้นักเทียบท่าทำงานกับฐานข้อมูลเวอร์ชันเก่า ให้เปลี่ยนเวอร์ชันอิมเมจสำหรับบริการฐานข้อมูลในไฟล์นักเทียบท่าเขียน

คำแนะนำการบริจาค

• ทำการเปลี่ยนแปลง:

  • หากต้องการนำการเปลี่ยนแปลงไปใช้กับโค้ด Python หรือ JavaScript ให้ใช้คำสั่ง make
  • หากต้องการใช้การเปลี่ยนแปลงกับไฟล์ docker-compose.yml ให้ใช้คำสั่ง make rebuild
  • หากต้องการใช้การเปลี่ยนแปลงกับไฟล์ docker/haproxy/haproxy.conf แพ็กเกจโหนด หรือการย้ายฐานข้อมูลใหม่ คุณจะต้องใช้คำสั่ง make nb

• การเพิ่มแพ็คเกจ Python: ปัจจุบันไฟล์ docker-compose.yml ใช้อิมเมจ newsblur/newsblur_python3 มันถูกสร้างขึ้นโดยใช้ Dockerfile ที่พบใน docker/newsblur_base_image.Dockerfile เนื่องจากวิธีการตั้งค่าอิมเมจนักเทียบท่า คุณจะต้องสร้างอิมเมจของคุณเองและกำหนดให้ไฟล์ 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 เพื่อสร้างคอนเทนเนอร์ที่เขียนนักเทียบท่าของคุณใหม่

• การดีบัก Python

  • หากต้องการแก้ไขโค้ดของคุณ ให้วาง import pdb; pdb.set_trace() ลงในโค้ด Python ที่คุณต้องการเริ่มการดีบักและรัน make จากนั้น make debug

• การใช้เชลล์ Django ภายใน Docker

  • ตรวจสอบให้แน่ใจว่าคอนเทนเนอร์นักเทียบท่าของคุณพร้อมใช้งานและรัน make shell เพื่อเปิดเชลล์ Django ภายในคอนเทนเนอร์ newsblur_web

การทดสอบหน่วยที่กำลังรันและการรวมระบบ

NewsBlur มาพร้อมกับชุดทดสอบที่ทดสอบการทำงานของ rss_feeds โปรแกรมอ่าน และผู้นำเข้าฟีด หากต้องการรันชุดทดสอบ:

 `make test`

กำลังดำเนินการทดสอบประสิทธิภาพ

การทดสอบประสิทธิภาพใช้เครื่องมือทดสอบประสิทธิภาพของตั๊กแตน หากต้องการรันการทดสอบประสิทธิภาพผ่าน CLI ให้ใช้ make perf-cli users=1 rate=1 host=https://localhost คุณสามารถเปลี่ยนผู้ใช้ อัตรา และตัวแปรโฮสต์ในคำสั่งเพื่อตอบสนองความต้องการของคุณได้

คุณยังสามารถรันการทดสอบประสิทธิภาพตั๊กแตนโดยใช้ UI ได้โดยการรัน make perf-ui จากนั้นไปที่ http://127.0.0.1:8089 ซึ่งจะทำให้คุณสามารถสร้างแผนภูมิและส่งออกข้อมูลประสิทธิภาพของคุณได้

หากต้องการเรียกใช้ locust โดยใช้ docker เพียงเรียกใช้ make perf-docker แล้วไปที่ http://127.0.0.1:8089

ผู้เขียน

• สร้างโดยซามูเอลเคลย์
• ที่อยู่อีเมล: [email protected]
• @samuelclay บน X/Twitter

ใบอนุญาต

NewsBlur ได้รับอนุญาตภายใต้ใบอนุญาต MIT (ดูใบอนุญาต)