ripgrep-webui Docker镜像文档

镜像概述和主要用途

ripgrep-webui是基于BurntSushi/ripgrep实现的WebUI可视化操作工具，旨在通过图形界面提供高效的文本内容检索能力。该镜像简化了ripgrep命令行工具的使用门槛，允许用户通过浏览器界面轻松搜索指定目录下的文本内容，并支持查询历史记录的保存与管理。

核心功能和特性

• 高效搜索能力：基于ripgrep引擎，提供快速、准确的文本搜索功能
• WebUI界面：直观的浏览器操作界面，无需命令行知识
• 文件系统挂载：支持挂载本地文件目录作为搜索源（只读模式）
• 查询历史保存：自动保存搜索历史至指定目录，便于追溯
• 资源可控：支持CPU、内存等系统资源限制配置，确保服务稳定性

使用场景和适用范围

• 开发者日常项目代码文本搜索
• 系统管理员日志文件内容检索
• 文档管理中的关键词快速定位
• 需要可视化界面进行文本内容查找的场景

使用方法和配置说明

前置准备

创建必要的文件存储目录（用于存放待搜索文件和查询历史）：

bash
mkdir -p /data/kuzi  # 待搜索文件存放目录（需替换为实际路径）
mkdir -p ./exports   # 查询历史保存目录

部署方式

1. 使用Docker命令部署

bash
docker run -d \
  --name ripgrep-webui \
  -p 5757:5000 \  # 端口映射：主机5757端口映射容器5000端口
  -v /data/kuzi:/data:ro \  # 挂载待搜索文件目录（只读模式）
  -v $(pwd)/exports:/app/exports \  # 挂载查询历史保存目录
  --restart unless-stopped \  # 容器退出时自动重启（除非手动停止）
  --cpus=1.0 \  # CPU使用限制
  --cpuset-cpus="0" \  # 绑定到特定CPU核心
  --cpu-shares=1024 \  # CPU相对权重（默认1024）
  --memory="2g" \  # 内存硬限制
  --memory-reservation="512m" \  # 内存软限制（优先分配）
  --memory-swap="4g" \  # 内存+交换空间总限制
  stu2116edwardhu/ripgrep-webui

2. 使用docker-compose部署

创建docker-compose.yml配置文件：

yaml
services:
  ripgrep-webui:
    cpu_count: 1                  # CPU核心数
    cpuset: '0'                   # 绑定到特定CPU核心
    cpu_shares: 1024              # CPU相对权重（默认1024）
    cpus: 1.0                     # CPU使用限制（docker-compose v2.3+支持）
    mem_limit: 2g                 # 内存硬限制
    mem_reservation: 512m         # 内存软限制（优先分配）
    memswap_limit: 4g             # 内存+交换空间总限制
    image: stu2116edwardhu/ripgrep-webui  # 镜像名称
    container_name: ripgrep-webui  # 容器名称
    ports:
      - "5757:5000"  # 端口映射
    volumes:
      - /data/kuzi:/data:ro  # 待搜索文件目录（需替换为实际路径，只读模式）
      - ./exports:/app/exports  # 查询历史保存目录
    restart: unless-stopped  # 重启策略

启动服务：

bash
docker-compose up -d

配置参数说明

访问方式

部署完成后，通过浏览器访问 http://<主机IP>:5757 即可打开ripgrep-webui界面，开始文本内容检索操作。