text sherlock

Texte Sherlock (ou Sherlock)

Fournit un moteur de recherche rapide, facile à installer et simple à utiliser pour le texte, mais optimisé pour le code source. Une alternative, OpenGrok, nécessite trop de temps pour installer (bien que cela en vaille la peine pour certains), mais est plus riche en fonctionnalités. Texte Sherlock vous donnera une configuration beaucoup plus facile, un indexeur de texte et une interface d'application Web pour rechercher avec très peu d'effort.

Soli Deo Gloria

Configuration de base

Instructions:

1. Téléchargez Sherlock Source de GitHub.
2. Extraire / placer le code source Sherlock dans le répertoire souhaité (installer). Ce sera là que Sherlock vit.
3. Exécutez sh setup/virtualenv-setup.sh pour configurer un environnement isolé et télécharger les packages de base.
4. Configurer les paramètres. Les valeurs par défaut dans settings.py fournissent une documentation pour chaque paramètre.
   • Copier example.local_settings.yml à local_settings.yml .
   • Override / Copiez n'importe quel paramètre de settings.py vers local_settings.yml (modifiez les valeurs selon les besoins). Toutes les touches / options YAML doivent être minuscules.
5. Exécutez source sherlock_env/bin/activate pour entrer l'environnement virtuel.
6. Exécutez python main.py --index update ou --index rebuild pour indexer le chemin spécifié dans les paramètres. Surveiller la sortie d'indexation.
7. Exécutez python main.py --runserver pour démarrer le serveur Web.
8. Allez sur http://localhost:7777 pour accéder à l'interface Web. Utilise la boîte à outils bootstrap pour son interface utilisateur.

Vous devrez peut-être installer certains packages avant qu'une installation Ubuntu ne s'exécute sans erreur.

• Installer Curl: sudo apt-get install curl
• Installer UUID LIBS: sudo apt-get install uuid-dev
• Installer Python Dev: sudo apt-get install python-dev

---

Comprend:

• Paramètres / configuration
  • Voir settings.py pour plus de détails.
• Configuration du script (lire le contenu du script pour plus d'informations)
  • Exécutez virtualenv-setup.sh pour effectuer une installation isolée.
• Script de contrôleur principal
  • Exécutez main.py -h pour plus d'informations.
• Interface de bout en bout
  • Indexation et recherche de texte (code source). Prise en charge intégrée pour whoosh (recherche rapide) ou Xapian (recherche beaucoup plus rapide).
    • Étendre facilement l'indexation ou la recherche via des backends personnalisés.
  • L'application Web frontale desservie à l'aide de Werkzug ou Cheoot.
    • werkzeug est pour le développement à un petit trafic.
    • cheroot est le serveur HTTP pur-performant haute performance utilisé par Cherrypy.
  • Paramètres et configuration à l'aide de Python.

Interface Web

Caractéristiques:

Ajouter une URL de documentation.

• Pour mettre en évidence les lignes, ajoutez URL: &hl=3,7,12-14,21
• Pour passer à une ligne, ajoutez à la fin de l'URL: #line-3

En utilisant d'autres backends

Dans settings.py :

• Modifiez les valeurs default_indexer et default_searcher pour correspondre au nom donné au backend.
  • Valeurs possibles:
    • whoosh la valeur par défaut, aucun travail supplémentaire nécessaire.
    • xapian doit être installé séparément à l'aide du script de configuration de setup/install-xapian.sh inclus.

Utilisation d'autres serveurs Web

Text Sherlock a une prise en charge intégrée pour les serveurs conformes à WerkZEug et Cheoot WSGI.

Dans settings.py :

• Modifiez la valeur server_type en l'un des types de serveurs disponibles.
  • Valeurs possibles:
    • default , serveur Web WerkzEug (par défaut).
    • cheroot , serveur Web Ready Ready.

Packages de base

Nécessite Python 3.5+

• Whoosh
• Ballon
• Jinja2
• Pygments
• peewee
• Bootstrap v4.x
• Pyyaml

Autres références

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

Objectifs du projet

1. Fournissez une solution de moteur de recherche de texte facile à installer, rapide et adéquate.
2. Être une alternative respectable à OpenGrok.
3. Influencer les contributeurs OpenGrok pour fournir un processus de configuration plus simple.
   • J'ai réussi à configurer deux installations d'OpenGrok sur Centos et Ubuntu 11.x. Chaque fois, il a fallu plus de deux heures . La configuration de Sherlock de texte prend moins de 5 minutes (à l'exclusion du temps de téléchargement du package).

Contributeurs

• Christopher Bess
• Raphael Boidol
• Et d'autres ...