https://opensemanticsearch.org
เปิดการค้นหาความหมายคือ:
README.md นี้เป็นเอกสารประกอบสำหรับนักพัฒนาซอฟต์แวร์
เอกสารประกอบสำหรับผู้ใช้และผู้ดูแลระบบจะรวมอยู่ในแพ็คเกจซอฟต์แวร์/รูปภาพ และเชื่อมโยงในอินเทอร์เฟซผู้ใช้การค้นหา (เมนู "ความช่วยเหลือ")
คุณสามารถค้นหาเอกสารประกอบของสถาปัตยกรรมเครื่องมือค้นหาได้ใน docs/doc/modules/README.md
เอกสาร HTML แบบผสานรวมนี้สร้างขึ้นโดยตัวสร้างไซต์แบบสแตติก MkDocs พร้อมด้วยไฟล์กำหนดค่า mkdocs.yml
แหล่งที่มาของเอกสาร (รูปแบบ Markdown) และแผนภูมิ (รูปแบบนางเงือก) สามารถแก้ไขได้ในไดเรกทอรี docs
วิธีสร้างแพ็คเกจ deb สำหรับการติดตั้งบนเซิร์ฟเวอร์ Debian หรือ Ubuntu หรืออิมเมจนักเทียบท่าสำหรับทำงานในคอนเทนเนอร์ Docker:
โคลนที่เก็บรวมถึงการขึ้นต่อกัน:
git clone --recurse-submodules --remote-submodules https://github.com/opensemanticsearch/open-semantic-search.git
cd open-semantic-search
หากต้องการสร้างแพ็คเกจ deb
สำหรับ Debian GNU/Linux หรือ Ubuntu Linux ให้เรียกใช้สคริปต์ build-deb
ในฐานะรูทผู้ใช้ (เปลี่ยนผู้ใช้ด้วย su
หรือ sudo su
):
./build-deb
วิธีสร้าง Open Semantic Desktop Search Appliance สำหรับ VirtualBox ได้รับการบันทึกไว้ใน src/open-semantic-desktop-search/README.md
สร้างอิมเมจ Docker โดยใช้การกำหนดค่าเริ่มต้น docker-compose docker-compose.yml
:
docker-compose build
หลังจากสร้างสิ่งเหล่านี้แล้ว Docker image/dependencies/services ทั้งหมดสามารถเริ่มต้นพร้อมกันได้โดย docker-compose ด้วยไฟล์ปรับแต่ง docker-compose.yml
คุณสามารถเริ่มต้นสภาพแวดล้อมทั้งหมดได้โดยการรัน:
docker-compose up
ซึ่งจะเปิดเผยส่วนติดต่อผู้ใช้เว็บบนพอร์ต 8080
คุณสามารถเรียกดูอินเทอร์เฟซผู้ใช้ Open Semantic Search ในเบราว์เซอร์ที่คุณชื่นชอบได้จาก URL นี้:
http://localhost:8080/search/
สำหรับ CI/CD มีการทดสอบอัตโนมัติที่แตกต่างกันออกไป:
เนื่องจากโมดูลย่อย Open Semantic ETL ใช้และต้องการบริการที่มีประสิทธิภาพที่แตกต่างกัน เช่น Solr, spaCy-services หรือ Tika-Server โดย HTTP และ REST-API การทดสอบอัตโนมัติจำนวนมากจึงทำงานเป็นการทดสอบการรวมภายในสภาพแวดล้อมการเขียนนักเทียบท่าที่กำหนดค่าใน docker-compose.etl.test.yml
เพื่อให้บริการเหล่านี้พร้อมใช้งานในขณะที่รันการทดสอบหน่วยและการทดสอบการรวม
docker-compose -f docker-compose.etl.test.yml build
docker-compose -f docker-compose.etl.test.yml up
การทดสอบการรวมระบบอัตโนมัติและการทดสอบแบบ end-to-end (E2E) ภายในเว็บเบราว์เซอร์ที่ควบคุมโดยเฟรมเวิร์กการทำงานอัตโนมัติของเบราว์เซอร์ Playwright และเฟรมเวิร์กการทดสอบที่ใช้ node.js / javascript JEST
คุณสามารถขยายการทดสอบอัตโนมัติได้ใน test/test.js
พวกเขาดำเนินการโดยอิมเมจนักเทียบ Dockerfile-test
และต้องการบริการของสภาพแวดล้อมการเขียนนักเทียบท่า docker-compose.test.yml
:
docker-compose -f docker-compose.test.yml build
docker-compose -f docker-compose.test.yml up
การพึ่งพาได้รับการแก้ไขโดยอัตโนมัติโดยการสร้างหรือโดยการติดตั้งแพ็คเกจ Debian หรือ Ubuntu หรือโดยการสร้างอิมเมจ Docker
เอกสารประกอบเกี่ยวกับการขึ้นต่อกันนี้อาจช่วยแก้ไขจุดบกพร่องปัญหาการขึ้นต่อกันหรือการติดตั้งในสภาพแวดล้อมอื่น:
การพึ่งพาพื้นที่เก็บข้อมูล Git อื่นๆ / โมดูลย่อยของส่วนประกอบ เช่น Open Semantic ETL ถูกกำหนดไว้ในไฟล์กำหนดค่า Git .gitmodules
โมดูลย่อยจะถูกตรวจสอบโดยอัตโนมัติไปยังไดเร็กทอรีย่อย src
หากคุณตรวจสอบที่เก็บข้อมูลนี้โดย git ในโหมดเรียกซ้ำ
โมดูลย่อย src/tika-server.deb
และ src/solr.deb
จำเป็นต้องมี JAR ของ Apache Tika-Server และ Apache Solr
หากไม่มี พวกเขาจะถูกดาวน์โหลดจาก Apache Software Foundation โดย wget ในสคริปต์ build-deb
หรือโมดูลย่อย Dockerfile
การพึ่งพาเครื่องมือและไลบรารีซึ่งมีอยู่ในที่เก็บแพ็คเกจ Debian หรือ Ubuntu ถูกกำหนดไว้ในส่วน Depends
กับไฟล์กำหนดค่าแพ็คเกจ deb DEBIAN/control
การขึ้นต่อกันของไลบรารี Python ที่ไม่สามารถใช้เป็นแพ็คเกจของการแจกจ่าย Linux แต่ใน Python Package Index (PyPI) ถูกกำหนดไว้ใน
src/open-semantic-etl/src/opensemanticetl/requirements.txt
การขึ้นต่อกันนี้จะถูกติดตั้งโดยอัตโนมัติในการติดตั้งแพ็คเกจ Debian/Ubuntu โดยสคริปต์ DEBIAN/postinst
ของแพ็คเกจ Debian/Ubuntu หรือโดย docker build ที่กำหนดค่าโดย Dockerfile
โดย
pip3 install -r /usr/lib/python3/dist-packages/opensemanticetl/requirements.txt
ผู้มีส่วนร่วมส่วนใหญ่จะไม่แสดงโดยอินเทอร์เฟซผู้ใช้ Github เป็น " ผู้มีส่วนร่วม " ของที่เก็บนี้ เนื่องจากที่เก็บหลักนี้มีโครงสร้างโดยโมดูลย่อย Git เช่น Open Semantic ETL และโมดูลอื่นๆ ซึ่งได้รับการจัดการในที่เก็บ Git(hub) ที่แยกจากกัน
ขอขอบคุณผู้มีส่วนร่วมทุกคน (ปัจจุบันและอดีต):
อย่าลังเลที่จะขยายเวลาหากคุณสนับสนุน/สนับสนุน/สนับสนุนในรูปแบบที่แตกต่างกัน