text sherlock

文字夏洛克（或夏洛克）

提供快速，易於安裝和易於使用的文本搜索引擎，但針對源代碼進行了優化。替代性的OpenGrok需要太多時間來安裝（儘管對某些人來說可能值得），但功能更豐富。短信Sherlock將為您提供更輕鬆的設置，文本索引器和Web應用程序接口，以便在很少的努力中進行搜索。

Soli Deo Gloria

基本設置

指示：

1. 從Github下載Sherlock來源。
2. 提取/將Sherlock源代碼放在所需（install）目錄中。這將是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以啟動Web服務器。
8. 轉到http://localhost:7777以訪問Web界面。使用Bootstrap工具包進行UI。

您可能需要安裝一些軟件包，然後再進行Ubuntu安裝而不會出錯。

• 安裝捲髮： 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（更快的搜索速度）。
    • 通過自定義後端輕鬆擴展索引或搜索。
  • 前端Web應用程序使用Werkzeug或Cheroot提供。
    • werkzeug用於開發到小型交通。
    • cheroot是Cherrypy使用的高性能，純淨的HTTP服務器。
  • 使用Python的設置和配置。

Web界面

特徵：

附加文檔URL。

• 要突出顯示線路，請附加到URL： &hl=3,7,12-14,21
• 要跳到一條線，請附加到URL的結尾： #line-3

使用其他後端

在settings.py中：py：

• 更改default_indexer和default_searcher值，以匹配給後端的名稱。
  • 可能的值：
    • whoosh情況下，無需額外的工作。
    • xapian必須使用隨附的setup/install-xapian.sh設置腳本單獨安裝。

使用其他Web服務器

Sherlock對Werkzeug和Cheroot WSGI符合符合人物的服務器具有內置支持。

在settings.py中：py：

• 將server_type值更改為可用服務器類型之一。
  • 可能的值：
    • default ，Werkzeug Web服務器（默認值）。
    • cheroot ，生產準備的Web服務器。

核心軟件包

需要python 3.5+

• 哇
• 燒瓶
• Jinja2
• py
• 皮尤
• Bootstrap v4.x
• Pyyaml

其他參考

• https://pygments.org/
• http://docs.peewee-morm.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的兩個安裝。每次花費兩個多小時。短信Sherlock設置需要少於5分鐘（不包括包裝下載時間）。

貢獻者

• 克里斯托弗·貝絲（Christopher Bess）
• 拉斐爾·鮑都爾（Raphael Boidol）
• 還有其他...