หน้าแรก>การเขียนโปรแกรมที่เกี่ยวข้อง>ซอร์สโค้ดอื่น ๆ
ดาวน์โหลด

ข้อความ Sherlock (หรือ Sherlock)

ให้การติดตั้งที่รวดเร็วง่ายต่อการติดตั้งและใช้งานจริงสำหรับข้อความ แต่ปรับให้เหมาะกับซอร์สโค้ด อีกทางเลือกหนึ่ง OpenGrok ต้องใช้เวลามากเกินไปในการติดตั้ง (แม้ว่ามันอาจจะคุ้มค่าสำหรับบางคน) แต่มีคุณสมบัติที่หลากหลายมากกว่า ข้อความ Sherlock จะช่วยให้คุณติดตั้งตัวดัชนีข้อความได้ง่ายขึ้นและอินเทอร์เฟซเว็บแอปสำหรับการค้นหาด้วยความพยายาม เพียงเล็กน้อย

Soli Deo Gloria

การตั้งค่าพื้นฐาน

คำแนะนำ:

  1. ดาวน์โหลดแหล่งที่มาของ Sherlock จาก GitHub
  2. แยก/วางซอร์สโค้ด Sherlock ในไดเรกทอรี (ติดตั้ง) ที่ต้องการ นี่จะเป็นที่ที่เชอร์ล็อคอาศัยอยู่
  3. เรียกใช้ sh setup/virtualenv-setup.sh เพื่อตั้งค่าสภาพแวดล้อมที่แยกได้และดาวน์โหลดแพ็คเกจหลัก
  4. กำหนดค่าการตั้งค่า ค่าเริ่มต้นใน settings.py ให้เอกสารสำหรับการตั้งค่าแต่ละครั้ง
    • example.local_settings.yml ถึง local_settings.yml
    • แทนที่/คัดลอกการตั้งค่าใด ๆ จาก settings.py เป็น local_settings.yml (เปลี่ยนค่าตามต้องการ) คีย์/ตัวเลือก YAML ทั้งหมด จะต้อง เป็นตัวพิมพ์เล็ก
  5. เรียกใช้ source sherlock_env/bin/activate เพื่อเข้าสู่สภาพแวดล้อมเสมือนจริง
  6. เรียกใช้ python main.py --index update หรือ --index rebuild เพื่อจัดทำดัชนีพา ธ ที่ระบุในการตั้งค่า ดูเอาต์พุตดัชนี
  7. เรียกใช้ python main.py --runserver เพื่อเริ่มต้นเว็บเซิร์ฟเวอร์
  8. ไปที่ http://localhost:7777 เพื่อเข้าถึงเว็บอินเตอร์เฟส ใช้ชุดเครื่องมือ bootstrap สำหรับ UI

คุณอาจต้องติดตั้งแพ็คเกจบางอย่างก่อนที่การติดตั้ง Ubuntu จะทำงานโดยไม่มีข้อผิดพลาด

  • ติดตั้ง Curl: sudo apt-get install curl
  • ติดตั้ง uuid libs: sudo apt-get install uuid-dev
  • ติดตั้ง Python Dev: sudo apt-get install python-dev

รวมถึง:

  • การตั้งค่า/การกำหนดค่า
    • ดู settings.py สำหรับรายละเอียด
  • การตั้งค่าสคริปต์ (อ่านเนื้อหาของสคริปต์สำหรับข้อมูลเพิ่มเติม)
    • เรียกใช้ virtualenv-setup.sh เพื่อทำการติดตั้งแบบแยก
  • สคริปต์ตัวควบคุมหลัก
    • เรียกใช้ main.py -h สำหรับข้อมูลเพิ่มเติม
  • อินเทอร์เฟซแบบ end-to-end
    • การจัดทำดัชนีและการค้นหาข้อความ (ซอร์สโค้ด) การสนับสนุนในตัวสำหรับ whaosh (การค้นหาอย่างรวดเร็ว) หรือ xapian (การค้นหาเร็วกว่ามาก)
      • ขยายการจัดทำดัชนีหรือค้นหาผ่านแบ็กเอนด์ที่กำหนดเองได้อย่างง่ายดาย
    • เว็บแอปพลิเคชันส่วนหน้าทำหน้าที่โดยใช้ werkzeug หรือ cheroot
      • werkzeug มีไว้สำหรับการพัฒนาเพื่อการจราจรขนาดเล็ก
      • cheroot เป็นเซิร์ฟเวอร์ HTTP Pure-Python ที่มีประสิทธิภาพสูงที่ใช้โดย CherryPy
    • การตั้งค่าและการกำหนดค่าโดยใช้ Python

เว็บอินเตอร์เฟส

คุณสมบัติ:

ผนวกเข้ากับ URL เอกสาร

  • ในการเน้นบรรทัดให้ผนวกกับ URL: &hl=3,7,12-14,21
  • หากต้องการข้ามไปยังบรรทัดต่อท้าย URL: #line-3

ภาพหน้าจอ

ภาพหน้าจอ

ใช้แบ็กเอนด์อื่น ๆ

ใน settings.py :

  • เปลี่ยนค่า default_indexer และ default_searcher เพื่อให้ตรงกับชื่อที่ให้กับแบ็กเอนด์
    • ค่าที่เป็นไปได้:
      • whoosh ค่าเริ่มต้นไม่จำเป็นต้องทำงานพิเศษ
      • xapian จะต้องติดตั้งแยกต่างหากโดยใช้สคริปต์การตั้งค่า setup/install-xapian.sh ที่รวมอยู่ด้วย

ใช้เว็บเซิร์ฟเวอร์อื่น ๆ

Text Sherlock มีการสนับสนุนในตัวสำหรับเซิร์ฟเวอร์ที่สอดคล้องกับ Werkzeug และ Cheroot WSGI

ใน settings.py :

  • เปลี่ยนค่า server_type เป็นหนึ่งในประเภทเซิร์ฟเวอร์ที่มีอยู่
    • ค่าที่เป็นไปได้:
      • default เว็บเซิร์ฟเวอร์ Werkzeug (ค่าเริ่มต้น)
      • cheroot เว็บเซิร์ฟเวอร์พร้อมผลิต

แพ็คเกจหลัก

ต้องใช้ Python 3.5+

  • หวือหวา
  • ขวด
  • jinja2
  • การทำนาย
  • แอบดู
  • bootstrap v4.x
  • pyyaml

ข้อมูลอ้างอิงอื่น ๆ

  • https://pygments.org/
  • http://docs.peewee-orm.com/
  • https://cheroot.cherrypy.org/
  • https://xapian.org/
  • https://pyyaml.org/wiki/pyyamldocumentation
  • https://zeptojs.com

เป้าหมายโครงการ

  1. จัดหาโซลูชันเครื่องมือค้นหาข้อความที่รวดเร็วและเพียงพอ
  2. เป็นทางเลือกที่น่านับถือสำหรับ OpenGrok
  3. มีอิทธิพลต่อผู้สนับสนุน OpenGrok เพื่อให้กระบวนการตั้งค่าที่ง่ายขึ้น
    • ฉันตั้งค่าการติดตั้ง OpenGrok บน CentOS และ Ubuntu 11.x ได้สำเร็จ ทุกครั้งที่ใช้เวลามากกว่า สองชั่วโมง การตั้งค่าข้อความ Sherlock ใช้เวลาน้อยกว่า 5 นาที (ไม่รวมเวลาดาวน์โหลดแพ็คเกจ)

ผู้มีส่วนร่วม

  • Christopher Bess
  • Raphael Boidol
  • และคนอื่น ๆ ...
ขยาย
ข้อมูลเพิ่มเติม
แอปที่เกี่ยวข้อง
แนะนำสำหรับคุณ
ข้อมูลที่เกี่ยวข้อง ทั้งหมด