PeARS federated

梨子聯盟

重要訊息

PeARS Federated是用於聯合使用的 PeARS 版本。管理員建立 PeARS 實例，使用者可以加入這些實例來為索引做出貢獻。

PeARS Federated按原樣提供。在使用之前，請檢查您所在國家/地區關於抓取網頁內容和顯示片段的規則。做個好網民：索引時不要使人們的伺服器超載！

安裝和設定

我們假設您首先想在本地運行您的安裝。以下內容旨在協助您在電腦上的本機上測試 PeARS。當您準備好部署時，請查看我們的 wiki 以取得更多說明。

1. 在您的電腦上克隆此儲存庫：

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

2.可選步驟在您的目錄中設定 virtualenv。

如果您尚未在電腦上設定 virtualenv，請透過 pip 安裝：

 sudo apt-get update

sudo apt-get install python3-setuptools

sudo apt-get install python3-pip

sudo apt install python3-virtualenv

然後切換到 PeARS-orchard 目錄：

 cd PeARS-federated

然後運行：

 virtualenv env && source env/bin/activate

3. 安裝建置依賴項：

從 PeARS 聯合目錄中，運行：

 pip install -r requirements.txt

4.可選步驟安裝更多語言

如果您想同時以多種語言進行搜尋和索引，您可以在英文安裝中新增多語言支援。為此：

 flask pears install-language lc

您應該將 lc 替換為您選擇的語言代碼。目前，我們僅支援英語 (en)、德語 (de)、法語 (fr) 和馬拉雅拉姆語 (ml)，但更多語言即將推出！

5. 設定你的.env

儲存庫根目錄中的.env-template有一個 .env 範本檔案。您應該將其複製到.env並填寫您的設定資訊。

6.運行你的梨！

在本機電腦上的儲存庫根目錄中，執行：

 python3 run.py

現在，前往瀏覽器localhost:8080 。您應該會看到 PeARS 的搜尋頁面。您還沒有為任何頁面建立索引，因此請前往常見問題頁面（頁面頂部的連結）並按照簡短的說明進行操作！

6. 僅限管理員：設定資料庫遷移

從命令列轉到 PeARS 目錄並運行：

 flask db init

設定遷移目錄。

然後，每當模型發生變更時，首先產生遷移腳本：

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

並將遷移腳本應用到您的資料庫：

 flask db upgrade