Moogle 项目启动与配置教程

1. 项目的目录结构及介绍

Moogle 是一个基于微服务架构的简易搜索引擎，其目录结构如下：

.
├── migration/            # 数据迁移脚本目录
├── services/             # 项目主要服务目录
│   ├── spider/           # 爬虫服务
│   ├── indexer/          # 索引服务
│   ├── search-engine/    # 搜索引擎服务
│   ├── client/           # 客户端服务（前端）
│   └── ...               # 其他服务
└── README.md             # 项目说明文档

• migration/：包含数据迁移的脚本，用于在数据库之间迁移数据。
• services/：包含构成 Moogle 的各个微服务。
  • spider/：负责爬取网页的服务。
  • indexer/：负责建立索引的服务。
  • search-engine/：负责处理搜索请求的服务。
  • client/：提供用户界面的服务。

2. 项目的启动文件介绍

每个服务目录下都有一个 Dockerfile，用于构建服务的 Docker 容器。项目使用 Docker 来容器化服务，确保服务的可移植性和一致性。

启动服务的一般步骤如下：

1. 克隆项目到本地：

   git clone https://github.com/IonelPopJara/moogle.git
   

2. 进入项目目录，并安装 Docker 和 Docker Compose。

3. 阅读 services/ 目录下每个服务的 README 文件，了解特定服务的启动说明。

4. 使用 docker-compose 命令来启动所有服务：

   docker-compose up -d
   

3. 项目的配置文件介绍

项目的配置主要通过 services/ 目录下各服务的配置文件进行。这些配置文件通常为 .env 文件，其中包含了服务的环境变量设置。

以下是一些基本的配置步骤：

1. 在 services/spider/ 目录下，编辑 .env 文件来设置爬虫的配置，例如爬取的起始 URL 和爬取的深度等。

2. 在 services/indexer/ 目录下，编辑 .env 文件来设置索引器的工作参数，如索引数据库的连接信息。

3. 在 services/search-engine/ 目录下，编辑 .env 文件来设置搜索服务的参数，例如数据库连接和搜索算法的参数。

4. 在 services/client/ 目录下，编辑 .env 文件来配置前端服务的相关参数，如 API 端点和前端页面设置。

确保所有配置正确无误后，可以通过 Docker Compose 重新启动服务以应用新的配置。