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