PeARS federated

PEARS Fédérés

Informations importantes

PeARS Federated est une version de PeARS pour une utilisation fédérée. Les administrateurs créent des instances PeARS que les utilisateurs peuvent rejoindre pour contribuer à l'index.

PeARS Federated est fourni tel quel. Avant de l'utiliser, veuillez vérifier les règles de votre pays en matière d'exploration du contenu Web et d'affichage d'extraits. Et soyez un bon internaute : ne surchargez pas les serveurs des gens lors de l'indexation !

Installation et configuration

Nous supposons que vous souhaiterez d’abord jouer avec votre installation localement. Ce qui suit est destiné à vous aider à tester PeARS sur localhost, sur votre machine. Au moment où vous êtes prêt à déployer, veuillez consulter notre wiki pour plus d'instructions.

1. Clonez ce dépôt sur votre machine :

    git clone https://github.com/PeARSearch/PeARS-federated.git

2. Étape facultative Configurez un virtualenv dans votre répertoire.

Si vous n'avez pas encore configuré virtualenv sur votre machine, veuillez l'installer via pip :

 sudo apt-get update

sudo apt-get install python3-setuptools

sudo apt-get install python3-pip

sudo apt install python3-virtualenv

Accédez ensuite au répertoire PeARS-orchard :

 cd PeARS-federated

Puis exécutez :

 virtualenv env && source env/bin/activate

3. Installez les dépendances de build :

Depuis le répertoire fédéré PeARS, exécutez :

 pip install -r requirements.txt

4. Étape facultative Installer d'autres langues

Si vous souhaitez rechercher et indexer dans plusieurs langues en même temps, vous pouvez ajouter la prise en charge multilingue à votre installation en anglais. Pour ce faire :

 flask pears install-language lc

où vous devez remplacer lc par un code de langue de votre choix. Pour l'instant, nous ne prenons en charge que l'anglais (en), l'allemand (de), le français (fr) et le malayalam (ml), mais d'autres langues sont à venir !

5. Configurez votre .env

Il existe un fichier modèle .env sous .env-template dans le répertoire racine du référentiel. Vous devez le copier dans .env et remplir les informations relatives à votre configuration.

6. Exécutez votre poire !

Sur votre ordinateur local, à la racine du dépôt, exécutez :

 python3 run.py

Maintenant, accédez à votre navigateur à localhost:8080 . Vous devriez voir la page de recherche pour PeARS. Vous n'avez pas encore de pages indexées, alors rendez-vous sur la page FAQ (lien en haut de la page) et suivez les courtes instructions pour vous lancer !

6. Administrateur uniquement : soyez configuré pour les migrations de bases de données

Depuis la ligne de commande, accédez à votre répertoire PeARS et exécutez :

 flask db init

pour configurer un répertoire de migration.

Ensuite, chaque fois que les modèles ont changé, générez d'abord un script de migration :

 flask db migrate -m "Your message describing the change."

Et appliquez le script de migration à votre base de données :

 flask db upgrade