PeARS federated

Federasi PeARS

Informasi penting

PeARS Federated adalah versi PeARS untuk penggunaan gabungan. Admin membuat instance PeARS di mana pengguna dapat bergabung untuk berkontribusi pada indeks.

PeARS Federated disediakan apa adanya. Sebelum Anda menggunakannya, harap periksa aturan negara Anda dalam merayapi konten Web dan menampilkan cuplikan. Dan jadilah netizen yang baik: jangan membebani server orang saat mengindeks!

Instalasi dan Pengaturan

Kami berasumsi bahwa Anda ingin bermain-main dengan instalasi Anda secara lokal terlebih dahulu. Berikut ini dimaksudkan untuk membantu Anda menguji PeARS di localhost, di mesin Anda. Saat Anda siap menerapkannya, silakan periksa wiki kami untuk instruksi lebih lanjut.

1. Kloning repo ini di mesin Anda:

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

2. Langkah opsional Siapkan virtualenv di direktori Anda.

Jika Anda belum menyiapkan virtualenv di mesin Anda, silakan instal melalui pip:

 sudo apt-get update

sudo apt-get install python3-setuptools

sudo apt-get install python3-pip

sudo apt install python3-virtualenv

Kemudian ubah ke direktori PeARS-orchard:

 cd PeARS-federated

Kemudian jalankan:

 virtualenv env && source env/bin/activate

3. Instal dependensi build:

Dari direktori federasi PeARS, jalankan:

 pip install -r requirements.txt

4. Langkah opsional Instal bahasa lebih lanjut

Jika Anda ingin mencari dan mengindeks dalam beberapa bahasa secara bersamaan, Anda dapat menambahkan dukungan multibahasa ke instalasi bahasa Inggris Anda. Untuk melakukan ini:

 flask pears install-language lc

di mana Anda harus mengganti lc dengan kode bahasa pilihan Anda. Untuk saat ini, kami hanya mendukung bahasa Inggris (en), Jerman (de), Prancis (fr), dan Malayalam (ml) tetapi lebih banyak bahasa akan segera hadir!

5. Siapkan .env Anda

Ada file templat .env di .env-template di direktori root repositori. Anda harus menyalinnya ke .env dan mengisi informasi untuk pengaturan Anda.

6. Jalankan buah pirmu!

Saat berada di mesin lokal Anda, di root repo, jalankan:

 python3 run.py

Sekarang, buka browser Anda di localhost:8080 . Anda akan melihat halaman pencarian untuk PeARS. Halaman Anda belum terindeks, jadi buka halaman FAQ (tautan di bagian atas halaman) dan ikuti petunjuk singkat untuk memulai!

6. Khusus Admin: Disiapkan untuk migrasi database

Dari baris perintah, buka direktori PeARS Anda dan jalankan:

 flask db init

untuk menyiapkan direktori migrasi.

Kemudian, setiap kali model berubah, buat skrip migrasi terlebih dahulu:

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

Dan terapkan skrip migrasi ke database Anda:

 flask db upgrade