text sherlock

텍스트 셜록 (또는 셜록)

빠르고 설치하기 쉽고 텍스트에 검색 엔진을 사용하기 쉽지만 소스 코드에 최적화되어 있습니다. 대안 인 Opengrok은 설치하는 데 너무 많은 시간이 필요하지만 (일부는 가치가 있지만) 더 많은 기능이 풍부합니다. Text Sherlock은 훨씬 쉬운 설정, 텍스트 인덱서 및 웹 앱 인터페이스를 제공하여 거의 노력하지 않습니다 .

솔리 데오 글로리아

기본 설정

지침:

1. Github에서 Sherlock 소스를 다운로드하십시오.
2. Sherlock 소스 코드를 원하는 (설치) 디렉토리에 추출/배치하십시오. 이것은 셜록이 사는 곳이 될 것입니다.
3. sh setup/virtualenv-setup.sh 실행하여 고립 된 환경을 설정하고 핵심 패키지를 다운로드하십시오.
4. 설정을 구성합니다. settings.py 의 기본값은 각 설정에 대한 문서를 제공합니다.
   • example.local_settings.yml to 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 로 이동하십시오. UI의 부트 스트랩 툴킷을 사용합니다.

우분투 설치가 오류없이 실행되기 전에 일부 패키지를 설치해야 할 수도 있습니다.

• 컬을 설치하십시오 : 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 실행하십시오.
• 엔드 투 엔드 인터페이스
  • 인덱싱 및 검색 텍스트 (소스 코드). Whoosh (빠른 검색) 또는 Xapian (훨씬 빠른 검색)에 대한 내장 지원.
    • 사용자 정의 백엔드를 통해 인덱싱 또는 검색을 쉽게 확장합니다.
  • Werkzeug 또는 Cheroot를 사용하여 제공되는 프론트 엔드 웹 앱.
    • werkzeug 트래픽을 적게 개발하기위한 것입니다.
    • cheroot Cherrypy가 사용하는 고성능 순수한 파이썬 HTTP 서버입니다.
  • 파이썬을 사용한 설정 및 구성.

웹 인터페이스

특징:

문서화 URL에 추가하십시오.

• 선을 강조하려면 URL에 추가하십시오 : &hl=3,7,12-14,21
• 라인으로 점프하려면 URL의 끝에 추가하십시오 : #line-3

다른 백엔드 사용

settings.py 에서 :

• 백엔드에 주어진 이름과 일치하도록 default_indexer 및 default_searcher 값을 변경하십시오.
  • 가능한 값 :
    • 채무 whoosh , 추가 작업이 필요하지 않습니다.
    • 포함 된 setup/install-xapian.sh 설정 스크립트를 사용하여 xapian 별도로 설치해야합니다.

다른 웹 서버 사용

Text Sherlock에는 Werkzeug 및 Cheroot WSGI 호환 서버를 지원합니다.

settings.py 에서 :

• server_type 값을 사용 가능한 서버 유형 중 하나로 변경하십시오.
  • 가능한 값 :
    • default , Werkzeug 웹 서버 (기본값).
    • cheroot , Production Ready Web Server.

핵심 패키지

파이썬 3.5+가 필요합니다

• 우시
• 플라스크
• Jinja2
• Pygments
• Peewee
• 부트 스트랩 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 기고자에게 영향을 미쳐 더 간단한 설정 프로세스를 제공합니다.
   • Centos와 Ubuntu 11.x에서 Opengrok의 두 설치를 성공적으로 설정했습니다. 2 시간 이상이 걸릴 때마다. 텍스트 Sherlock 설정은 5 분도 채 걸리지 않습니다 (패키지 다운로드 시간 제외).

기고자

• 크리스토퍼 베스
• 라파엘 보이 돌
• 그리고 다른 것들 ...