text sherlock

Teks Sherlock (atau Sherlock)

Menyediakan cepat, mudah diinstal dan mudah digunakan mesin pencari untuk teks, tetapi dioptimalkan untuk kode sumber. Alternatif, OpenGrok, membutuhkan terlalu banyak waktu untuk menginstal (meskipun mungkin layak untuk beberapa orang), tetapi lebih kaya fitur. Teks Sherlock akan memberi Anda pengaturan yang jauh lebih mudah, pengindeks teks, dan antarmuka aplikasi web untuk mencari dengan sedikit usaha.

Soli Deo Gloria

Pengaturan Dasar

Instruksi:

1. Unduh Sumber Sherlock dari GitHub.
2. Ekstrak/Tempatkan Kode Sumber Sherlock di direktori yang diinginkan (instal). Di sinilah Sherlock tinggal.
3. Jalankan sh setup/virtualenv-setup.sh untuk mengatur lingkungan yang terisolasi dan mengunduh paket inti.
4. Konfigurasikan Pengaturan. Default di settings.py memberikan dokumentasi untuk setiap pengaturan.
   • Salin example.local_settings.yml ke local_settings.yml .
   • Override/Salin pengaturan apa pun dari settings.py ke local_settings.yml (ubah nilai sesuai kebutuhan). Semua kunci/opsi YAML harus menjadi huruf kecil.
5. Jalankan source sherlock_env/bin/activate untuk memasuki lingkungan virtual.
6. Jalankan python main.py --index update atau --index rebuild untuk mengindeks jalur yang ditentukan dalam pengaturan. Tonton output pengindeksan.
7. Jalankan python main.py --runserver untuk memulai server web.
8. Pergi ke http://localhost:7777 untuk mengakses antarmuka web. Menggunakan bootstrap toolkit untuk UI.

Anda mungkin perlu menginstal beberapa paket sebelum instalasi Ubuntu akan berjalan tanpa kesalahan.

• Instal Curl: sudo apt-get install curl
• Instal uuid libs: sudo apt-get install uuid-dev
• Instal Python Dev: sudo apt-get install python-dev

---

Termasuk:

• Pengaturan/Konfigurasi
  • Lihat settings.py untuk detailnya.
• Skrip Pengaturan (Baca Isi Script untuk informasi lebih lanjut)
  • Jalankan virtualenv-setup.sh untuk melakukan instalasi yang terisolasi.
• Skrip pengontrol utama
  • Jalankan main.py -h untuk informasi lebih lanjut.
• Antarmuka ujung ke ujung
  • Pengindeksan dan pencarian teks (kode sumber). Dukungan bawaan untuk whoosh (pencarian cepat) atau xapian (pencarian jauh lebih cepat).
    • Perluas pengindeksan atau pencarian dengan mudah melalui backend khusus.
  • Aplikasi Web ujung depan disajikan menggunakan Werkzeug atau Cheroot.
    • werkzeug adalah untuk pengembangan lalu lintas kecil.
    • cheroot adalah server HTTP yang berkinerja tinggi dan murni-python yang digunakan oleh Cherrypy.
  • Pengaturan dan Konfigurasi Menggunakan Python.

Antarmuka web

Fitur:

Tambahkan URL mendokumentasikan.

• Untuk menyorot baris, tambahkan url: &hl=3,7,12-14,21
• Untuk melompat ke garis, tambahkan ke akhir url: #line-3

Menggunakan backend lainnya

Di settings.py :

• Ubah nilai default_indexer dan default_searcher agar sesuai dengan nama yang diberikan ke backend.
  • Nilai yang mungkin:
    • whoosh default, tidak ada pekerjaan tambahan yang diperlukan.
    • xapian harus diinstal secara terpisah menggunakan skrip pengaturan setup/install-xapian.sh yang disertakan.

Menggunakan server web lainnya

Teks Sherlock memiliki dukungan bawaan untuk server Werkzeug dan Cheroot WSGI.

Di settings.py :

• Ubah nilai server_type ke salah satu jenis server yang tersedia.
  • Nilai yang mungkin:
    • default , Werkzeug Web Server (default).
    • cheroot , Server Web Siap Produksi.

Paket Inti

Membutuhkan Python 3.5+

• Suara mendesing
• Labu
• Jinja2
• Pygments
• katai
• Bootstrap v4.x
• Pyyaml

Referensi lainnya

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

Tujuan proyek

1. Berikan solusi mesin pencari teks yang mudah diatur, cepat, dan memadai.
2. Jadilah alternatif terhormat untuk OpenGrok.
3. Mempengaruhi kontributor OpenGrok untuk memberikan proses pengaturan yang lebih sederhana.
   • Saya berhasil mengatur dua instalasi OpenGrok di Centos dan Ubuntu 11.x. Setiap kali butuh lebih dari dua jam . Pengaturan Sherlock Teks membutuhkan waktu kurang dari 5 menit (tidak termasuk waktu pengunduhan paket).

Kontributor

• Christopher Bess
• Raphael Boidol
• Dan lainnya ...