folioorg/mod-search

FOLIO - mod-search 镜像文档

镜像概述

mod-search是FOLIO图书馆服务平台的核心搜索模块，负责处理资源搜索请求，通过Kafka消费inventory和authorities事件数据，与Elasticsearch交互构建索引，提供高效的资源检索与浏览能力，支持多语言处理、并发事件消费及索引优化。

代码仓库：https://github.com/folio-org/mod-search

核心功能与特性

• 事件处理：通过Kafka消费inventory（实例、馆藏记录、 item等）和authorities事件，支持并发处理与重试机制
• 索引管理：与Elasticsearch集成，管理索引创建、更新及优化，支持实例子项索引、批量处理和多语言配置
• 搜索与浏览：提供资源搜索功能，支持按字段搜索、CN浏览优化，可配置搜索超时和最大偏移量
• 性能优化：支持数据压缩、线程池配置、批处理大小调整，提升并发处理能力和搜索效率

使用场景与适用范围

适用于基于FOLIO图书馆服务平台的场景，作为核心搜索组件为图书馆用户提供图书、馆藏、权限等资源的检索与浏览服务，满足图书馆系统对资源发现的需求。

技术规格与配置参数

基础信息

• 模块端口：8081
• 容器内存限制：***字节（1GB）
• 数据库连接：需要
• JAVA_OPTIONS：-XX:MaxRAMPercentage=85.0（JVM最大内存占比85%）

环境变量配置

Kafka 相关配置

Elasticsearch 相关配置

索引管理配置

搜索与浏览配置

系统与流处理配置

使用方法

Docker Run 示例

bash
docker run -d \
  --name mod-search \
  -p 8081:8081 \
  -e ENV=folio \
  -e KAFKA_HOST=kafka \
  -e KAFKA_PORT=9092 \
  -e ELASTICSEARCH_URL=http://elasticsearch:9200 \
  -e ELASTICSEARCH_USERNAME=elastic \
  -e ELASTICSEARCH_PASSWORD=s3cret \
  -e OKAPI_URL=http://okapi:9130 \
  folioorg/mod-search:latest

Docker Compose 配置示例

yaml
version: '3.8'

services:
  mod-search:
    image: folioorg/mod-search:latest
    container_name: mod-search
    ports:
      - "8081:8081"
    environment:
      - ENV=folio
      - KAFKA_HOST=kafka
      - KAFKA_PORT=9092
      - KAFKA_SECURITY_PROTOCOL=PLAINTEXT
      - ELASTICSEARCH_URL=[***]
      - ELASTICSEARCH_USERNAME=elastic
      - ELASTICSEARCH_PASSWORD=s3cret
      - ELASTICSEARCH_COMPRESSION_ENABLED=true
      - INDEXING_DATA_FORMAT=smile
      - OKAPI_URL=[***]
      - SYSTEM_USER_USERNAME=mod-search
      - SYSTEM_USER_PASSWORD=secure_password
    depends_on:
      - kafka
      - elasticsearch
      - okapi