onlyoffice/opensearch

Opensearch for Onlyoffice 镜像文档

1. 镜像概述

1.1 基本信息

该镜像基于 OpenSearch 构建，专为 OnlyOffice 办公套件提供集成化的搜索引擎支持，旨在通过 OpenSearch 的全文检索能力，实现 OnlyOffice 文档内容的高效检索、索引管理及搜索服务。

1.2 主要用途

• 为 OnlyOffice 文档（如文本文档、表格、演示文稿等）提供全文搜索功能；
• 自动/手动管理 OnlyOffice 文档的索引创建、更新与维护；
• 支持通过 API 与 OnlyOffice 服务无缝集成，实现搜索请求的处理与结果返回。

2. 核心功能与特性

2.1 核心功能

• 全文检索：支持对 OnlyOffice 文档内容（文本、标题、作者、创建时间等字段）进行全文搜索；
• 实时索引：自动监听 OnlyOffice 文档的创建、更新、删除事件，实时更新索引数据；
• 搜索过滤：支持按文档类型、创建时间、作者等条件进行搜索结果过滤；
• 高亮显示：返回搜索结果时高亮匹配的关键词，提升用户体验。

2.2 关键特性

• 与 OnlyOffice 深度集成：内置适配 OnlyOffice 文档格式的解析器与索引规则；
• 轻量化部署：基于 Docker 容器化设计，简化部署与运维流程；
• 可配置性：支持通过环境变量自定义索引名称、搜索字段、刷新频率等参数；
• 高性能：基于 OpenSearch 分布式架构优化，支持大规模文档索引与并发搜索请求。

3. 使用场景与适用范围

3.1 适用场景

• 企业办公环境：在企业内部 OnlyOffice 部署中，为员工提供快速文档检索能力；
• 文档管理平台：集成到基于 OnlyOffice 的文档管理系统，实现海量文档的高效搜索；
• 协作编辑场景：在多人协作编辑的 OnlyOffice 环境中，快速定位历史版本或相关文档。

3.2 适用范围

• 用户群体：使用 OnlyOffice 社区版/企业版的个人用户、企业 IT 团队、文档管理员；
• 环境要求：需与 OnlyOffice 服务（版本 7.0+ 推荐）部署在同一网络环境，支持 Docker 或 Kubernetes 容器化部署。

4. 使用方法与配置说明

4.1 前提条件

• 已部署 OnlyOffice 服务（确保服务可通过网络访问）；
• 安装 Docker 19.03+ 或 Docker Compose 2.0+；
• 服务器资源：建议至少 2 CPU 核心、4GB 内存（根据文档规模调整）。

4.2 Docker 快速部署

4.2.1 基本部署命令（docker run）

docker
docker run -d \
  --name opensearch-onlyoffice \
  -p 9200:9200 \
  -p 9600:9600 \
  -e OPENSEARCH_PORT=9200 \
  -e INDEX_NAME=onlyoffice_docs \
  -e ONLYOFFICE_URL=http://onlyoffice-service:80 \
  -e REFRESH_INTERVAL=30s \
  -v opensearch-data:/usr/share/opensearch/data \
  --restart unless-stopped \
  your-registry/opensearch-for-onlyoffice:latest

4.2.2 参数说明

• -p 9200:9200：映射 OpenSearch HTTP API 端口（默认 9200）；
• -p 9600:9600：映射 OpenSearch 监控端口（默认 9600）；
• -v opensearch-data:/usr/share/opensearch/data：挂载数据卷，持久化存储索引数据；
• 环境变量（见 4.4 节）：通过 -e 指定配置参数。

4.3 Docker Compose 部署

4.3.1 docker-compose.yml 配置示例

yaml
version: '3.8'

services:
  opensearch-onlyoffice:
    image: your-registry/opensearch-for-onlyoffice:latest
    container_name: opensearch-onlyoffice
    restart: unless-stopped
    ports:
      - "9200:9200"  # OpenSearch HTTP 端口
      - "9600:9600"  # OpenSearch 监控端口
    environment:
      - OPENSEARCH_PORT=9200
      - INDEX_NAME=onlyoffice_docs
      - ONLYOFFICE_URL=http://onlyoffice:80  # OnlyOffice 服务地址（需与当前网络互通）
      - REFRESH_INTERVAL=30s  # 索引刷新间隔
      - MEMORY_LOCK=true  # 锁定内存，提升性能（需宿主机支持）
    volumes:
      - opensearch-data:/usr/share/opensearch/data  # 持久化索引数据
    networks:
      - onlyoffice-network  # 与 OnlyOffice 服务共享网络（若 OnlyOffice 也通过 Compose 部署）

networks:
  onlyoffice-network:
    external: true  # 假设 OnlyOffice 服务已在该网络中

volumes:
  opensearch-data:  # 数据卷，持久化索引数据

4.4 环境变量配置说明

4.5 启动与验证步骤

4.5.1 启动服务

• 若使用 docker run：执行 4.2.1 节命令后，通过 docker logs -f opensearch-onlyoffice 查看启动日志，确认无报错。
• 若使用 docker-compose：在 docker-compose.yml 目录下执行 docker-compose up -d，通过 docker-compose logs -f 查看日志。

4.5.2 验证服务可用性

1. 访问 OpenSearch 健康检查接口：

   bash
   curl http://localhost:9200/_cluster/health
   

   预期返回 {"status":"green",...}（表示集群健康）。

2. 验证索引创建：

   bash
   curl http://localhost:9200/_cat/indices?v
   

   预期显示 INDEX_NAME 配置的索引（如 onlyoffice_docs）。

3. 验证与 OnlyOffice 集成：
   在 OnlyOffice 中创建一个测试文档，等待 REFRESH_INTERVAL 时间后，通过 OpenSearch 搜索接口检索文档内容：

   bash
   curl -X GET "http://localhost:9200/onlyoffice_docs/_search?q=测试文档内容"
   

   预期返回包含该文档的搜索结果。

5. 注意事项

• 数据持久化：务必通过数据卷（-v opensearch-data:/usr/share/opensearch/data）挂载索引数据，避免容器重启后数据丢失。
• 版本兼容性：建议使用与 OnlyOffice 版本匹配的镜像（如 OnlyOffice 7.4+ 对应镜像版本 1.2+），具体参考官方版本说明。
• 资源配置：根据文档数量调整服务器资源，建议文档量超过 10 万份时，增加 CPU/内存配置或部署 OpenSearch 集群（多节点）。
• 安全配置：生产环境中需开启 OpenSearch 认证（通过 OPENSEARCH_USER/OPENSEARCH_PASSWORD），并限制端口访问（如仅允许 OnlyOffice 服务访问 9200 端口）。