Hyphe技术文档

1. 安装指南

Hyphe 是一个基于网络的爬虫工具，用于构建网络语料库。以下是安装 Hyphe 的步骤：

使用 Docker 安装

1. 安装 Docker

首先，根据 Docker 官方文档安装 Docker。

2. 下载 Hyphe 源代码

从 Git 仓库下载 Hyphe 源代码：

git clone https://github.com/medialab/hyphe.git hyphe
cd hyphe

或者，如果不使用 Git，可以从 Hyphe 的发布页面下载并解压最新版本的源代码。

3. 配置

复制默认的配置文件并编辑以满足需求：

cp .env.example .env
cp config-backend.env.example config-backend.env
cp config-frontend.env.example config-frontend.env

在 .env 文件中可以配置以下选项：

• TAG：选择要使用的 Docker 镜像
• PUBLIC_PORT：Hyphe 服务的 Web 端口
• DATA_PATH：存储数据的路径
• RESTART_POLICY：容器自动重启策略

Hyphe 的内部设置可以在 config-backend.env 和 config-frontend.env 中调整。

4. 准备 Docker 容器

有两种选择：拉取预构建的 Docker 镜像或从源代码构建自己的镜像。

docker-compose pull  # 推荐使用，拉取预构建的镜像
# 或者
docker-compose build  # 从源代码构建镜像

5. 启动 Hyphe

启动 Hyphe 容器：

docker-compose up  # 前台运行
# 或者
docker-compose up -d  # 后台运行

当日志显示 "All tests passed. Ready!" 时，可以访问 Hyphe 服务。

6. 停止和监控 Hyphe

要停止后台运行的容器，使用以下命令：

docker-compose stop  # 或者 docker-compose down 清理数据

可以使用 docker-compose logs 查看容器日志。

7. 更新到未来版本

谨慎操作，升级到新版本可能会破坏现有语料库。

docker-compose down
git pull
docker-compose pull
# 可能需要编辑配置文件以使用新选项
docker-compose up -d

2. 项目的使用说明

Hyphe 的使用说明可以在项目的 Wiki 页面找到。

3. 项目 API 使用文档

Hyphe 的 API 使用文档在项目的 Wiki 页面中详细说明。

4. 项目安装方式

项目支持两种安装方式：使用 Docker 的快速安装和手动安装（仅限 Linux 系统）。Docker 安装方式已在上述安装指南中详细说明。手动安装方式较为复杂，适合需要深入开发或在不支持 Docker 的旧版 Linux 系统上使用。