PeARS federated

PeARS フェデレーテッド

重要な情報

PeARS Federated は、フェデレーテッド使用のための PeARS のバージョンです。管理者は、ユーザーが参加してインデックスに貢献できる PeARS インスタンスを作成します。

PeARS Federated は現状のまま提供されます。使用する前に、Web コンテンツのクロールとスニペットの表示に関する各国の規則を確認してください。そして、良いネチズンになりましょう。インデックス作成中に他の人のサーバーに過負荷をかけないでください。

インストールとセットアップ

まずローカルでインストールを試してみることを想定しています。以下は、マシン上のローカルホスト上で 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 の検索ページが表示されるはずです。まだインデックス付けされたページがないため、FAQ ページ (ページ上部のリンク) にアクセスし、短い指示に従って作業を進めてください。

6. 管理者のみ: データベース移行のセットアップを行う

コマンドラインから PeARS ディレクトリに移動し、次を実行します。

 flask db init

移行ディレクトリをセットアップします。

その後、モデルが変更されるたびに、まず移行スクリプトを生成します。

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

そして、移行スクリプトをデータベースに適用します。

 flask db upgrade